Errors that occurred during the processing of the onboarding request
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DER Connect API by Elia Group","colors":{"primary":"#FF7300","light":"#FF7446","dark":"#FF7300"},"logo":{"light":"https://mintcdn.com/realto/EG-Ok6q3nUjGJxIo/logo/DER-Connect-Color.svg?fit=max\u0026auto=format\u0026n=EG-Ok6q3nUjGJxIo\u0026q=85\u0026s=3028ab2689f8c3465db02a3e0ec9622a","dark":"https://mintcdn.com/realto/EG-Ok6q3nUjGJxIo/logo/DER-Connect-Color.svg?fit=max\u0026auto=format\u0026n=EG-Ok6q3nUjGJxIo\u0026q=85\u0026s=3028ab2689f8c3465db02a3e0ec9622a"},"favicon":"/favicon.png","api":{"openapi":["https://prd.der-connect.eliagroup.eu/swagger/commands/v1/swagger.json","https://prd.der-connect.eliagroup.eu/swagger/entities/v1/swagger.json","https://prd.der-connect.eliagroup.eu/swagger/onboarding/v1/swagger.json","https://prd.der-connect.eliagroup.eu/swagger/readings/v1/swagger.json","https://prd.der-connect.eliagroup.eu/swagger/records/v1/swagger.json","https://prd.der-connect.eliagroup.eu/swagger/principals/v1/swagger.json"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"realto","hasAudioNarration":false,"actualSubdomain":"realto","customDomains":["docs.der-connect.dev"],"gitSource":{"type":"github","owner":"realto-energy","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":true},"entitlements":{},"buildId":"6ae92391f214fd30efb947db:success","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":59},{"language":"default","tag":"Entity Settings","count":20},{"language":"default","tag":"Core Resources","count":17},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Collectives","count":10},{"language":"default","tag":"Entities","count":10},{"language":"default","tag":"Commands API","count":7},{"language":"default","tag":"Locations","count":5},{"language":"default","tag":"Onboarding API","count":5},{"language":"default","tag":"Readings API","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[id^=user-content-fn-]{display:list-item;font-size:.85rem}[id^=user-content-fn-] .data-footnote-backref{display:none}"}],"page":{"pagePath":"api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request","slug":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request","pageMetadata":{"openapi":"get /v1/onboarding/entities/{onboardingRequestId}","sidebarTitle":"Retrieve a single request","title":"Retrieve an Entity Onboarding Request","description":"Returns the Entity Onboarding Request with specified id.","href":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the Entity Onboarding Request with specified id.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/onboarding/entities/{onboardingRequestId}","sidebarTitle":"Retrieve a single request","title":"Retrieve an Entity Onboarding Request","description":"Returns the Entity Onboarding Request with specified id.","href":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Entity onboarding"],"summary":"Retrieve an Entity Onboarding Request","description":"Returns the Entity Onboarding Request with specified id.","operationId":"get-getentityonboardingasync","parameters":["70a66376-efa7-437d-aec8-698c375bdaac"],"responses":{"200":"cca64818-4872-4c5b-93fc-5b24051b2a09","400":"7c3b56b0-4d74-4884-b1e2-754c5938a080"},"method":"get","type":"path","servers":["1d40f707-7b9c-4048-8049-f9f9c6e28d45"],"security":["2ad340c2-abe4-4362-8272-a229e66e1b0e"],"path":"/v1/onboarding/entities/{onboardingRequestId}","baseUrlOptions":["https://api.traxes.io/connect"],"title":"Retrieve an Entity Onboarding Request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"70a66376-efa7-437d-aec8-698c375bdaac":{"name":"onboardingRequestId","in":"path","description":"The id of the Entity Onboarding Request","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The id of the Entity Onboarding Request","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"8667fb97-68f2-485a-87c7-f3bdfa9482e1"}},"responses":{"cca64818-4872-4c5b-93fc-5b24051b2a09":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"object","properties":{"documentationLink":{"oneOf":[{"type":"string","description":"A link to documentation explaining the user how to proceed","format":"uri","uniqueKey":"action.documentationLink.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"A link to documentation explaining the user how to proceed","format":"uri","uniqueKey":"action.documentationLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"action.documentationLink","typeLabel":"string\u003curi> | null"},"redirectLink":{"oneOf":[{"type":"string","description":"A link to redirect the user to","format":"uri","uniqueKey":"action.redirectLink.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"A link to redirect the user to","format":"uri","uniqueKey":"action.redirectLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"action.redirectLink","typeLabel":"string\u003curi> | null"},"type":{"enum":["Consent","Redirect"],"type":"string","uniqueKey":"action.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"description":"Represents an action for an onboarding request","uniqueKey":"action","typeLabel":"object"},"created":{"type":"string","description":"The date and time the onboarding request was created.","format":"date-time","uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"data":{"type":"object","properties":{"collective":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Collective","format":"uuid","uniqueKey":"data.collective.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","description":"The name of the Collective","uniqueKey":"data.collective.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the Collective","uniqueKey":"data.collective.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.collective.name","typeLabel":"string | null"},"owner":{"type":"string","description":"The owner of the Collective","format":"uuid","uniqueKey":"data.collective.owner","typeLabel":"string\u003cuuid>"},"properties":{"oneOf":[{"description":"The custom properties of the Collective","uniqueKey":"data.collective.properties.oneOf.0","typeLabel":"any"},{"description":"The custom properties of the Collective","type":"null","uniqueKey":"data.collective.properties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.collective.properties","typeLabel":"any | null"},"type":{"enum":["Household","Fleet","SolarFarm","VirtualPowerPlant"],"type":"string","uniqueKey":"data.collective.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"description":"Represents data required to onboard a Collective","uniqueKey":"data.collective","typeLabel":"object"},"entity":{"type":"object","properties":{"collectiveId":{"oneOf":[{"type":"string","description":"The id of the Collective the Entity belongs to.","format":"uuid","uniqueKey":"data.entity.collectiveId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the Collective the Entity belongs to.","format":"uuid","uniqueKey":"data.entity.collectiveId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.collectiveId","typeLabel":"string\u003cuuid> | null"},"id":{"type":"string","description":"The id of the Entity","format":"uuid","uniqueKey":"data.entity.id","typeLabel":"string\u003cuuid>"},"information":{"type":"object","properties":{"type":{"enum":["Battery","ChargePoint","EV","HeatPump","SolarPlant","RetrofitMeter","Meter","Inverter"],"type":"string","uniqueKey":"data.entity.information.type","typeLabel":"enum\u003cstring>"},"brand":{"oneOf":[{"type":"string","description":"The brand of an Entity","uniqueKey":"data.entity.information.brand.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand of an Entity","uniqueKey":"data.entity.information.brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.information.brand","typeLabel":"string | null"},"identifier":{"oneOf":[{"type":"string","description":"The identifier of an Entity","uniqueKey":"data.entity.information.identifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier of an Entity","uniqueKey":"data.entity.information.identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.information.identifier","typeLabel":"string | null"},"pairingCode":{"oneOf":[{"type":"string","description":"The pairing code of an Entity","uniqueKey":"data.entity.information.pairingCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The pairing code of an Entity","uniqueKey":"data.entity.information.pairingCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.information.pairingCode","typeLabel":"string | null"},"associatedEmail":{"oneOf":[{"type":"string","description":"The associated email address used for onboarding an Entity","uniqueKey":"data.entity.information.associatedEmail.oneOf.0","typeLabel":"string"},{"type":"null","description":"The associated email address used for onboarding an Entity","uniqueKey":"data.entity.information.associatedEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.information.associatedEmail","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The name of an Entity","uniqueKey":"data.entity.information.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of an Entity","uniqueKey":"data.entity.information.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.information.name","typeLabel":"string | null"},"track":{"oneOf":[{"type":"string","description":"The track for an Entity","uniqueKey":"data.entity.information.track.oneOf.0","typeLabel":"string"},{"type":"null","description":"The track for an Entity","uniqueKey":"data.entity.information.track.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.information.track","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents information about an Entity","uniqueKey":"data.entity.information","typeLabel":"object"},"owner":{"type":"string","description":"The id of the owner of the Entity","format":"uuid","uniqueKey":"data.entity.owner","typeLabel":"string\u003cuuid>"},"properties":{"oneOf":[{"description":"The custom properties of the Entity","uniqueKey":"data.entity.properties.oneOf.0","typeLabel":"any"},{"description":"The custom properties of the Entity","type":"null","uniqueKey":"data.entity.properties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.properties","typeLabel":"any | null"},"reference":{"type":"object","properties":{"brand":{"oneOf":[{"type":"string","description":"The brand of the Entity","uniqueKey":"data.entity.reference.brand.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand of the Entity","uniqueKey":"data.entity.reference.brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.reference.brand","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"The model of the Entity","uniqueKey":"data.entity.reference.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"The model of the Entity","uniqueKey":"data.entity.reference.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.reference.type","typeLabel":"string | null"},"identifier":{"oneOf":[{"type":"string","description":"The reference of the Entity","uniqueKey":"data.entity.reference.identifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reference of the Entity","uniqueKey":"data.entity.reference.identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.reference.identifier","typeLabel":"string | null"}},"additionalProperties":false,"description":"A reference to an Entity","uniqueKey":"data.entity.reference","typeLabel":"object"},"systemProperties":{"oneOf":[{"description":"The system properties of the Entity","uniqueKey":"data.entity.systemProperties.oneOf.0","typeLabel":"any"},{"description":"The system properties of the Entity","type":"null","uniqueKey":"data.entity.systemProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entity.systemProperties","typeLabel":"any | null"},"type":{"enum":["Battery","ChargePoint","EV","HeatPump","SolarPlant","RetrofitMeter","Meter","Inverter"],"type":"string","uniqueKey":"data.entity.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"description":"Represents data required to onboard an Entity","uniqueKey":"data.entity","typeLabel":"object"}},"additionalProperties":false,"description":"Represents the data of an onboarding request","uniqueKey":"data","typeLabel":"object"},"id":{"type":"string","description":"The id of the onboarding request","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"principalId":{"type":"string","description":"The id of the principal that initiated the onboarding request","format":"uuid","uniqueKey":"principalId","typeLabel":"string\u003cuuid>"},"requestType":{"enum":["Collective","Entity"],"type":"string","uniqueKey":"requestType","typeLabel":"enum\u003cstring>"},"returnUrl":{"oneOf":[{"type":"string","description":"The url where the User will be redirected to after completing the consent flow on the OEM page.","uniqueKey":"returnUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The url where the User will be redirected to after completing the consent flow on the OEM page.","uniqueKey":"returnUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"returnUrl","typeLabel":"string | null"},"status":{"enum":["Canceled","Failed","InProgress","Pending","Succeeded"],"type":"string","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"errors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string","description":"The code of the error","uniqueKey":"errors.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code of the error","uniqueKey":"errors.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","description":"The message of the error","uniqueKey":"errors.oneOf.0.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The message of the error","uniqueKey":"errors.oneOf.0.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string | null"}},"additionalProperties":false,"description":"An error that occurred during the onboarding request","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Errors that occurred during the processing of the onboarding request","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string","description":"The code of the error"},{"type":"null","description":"The code of the error"}]},"message":{"oneOf":[{"type":"string","description":"The message of the error"},{"type":"null","description":"The message of the error"}]}},"additionalProperties":false,"description":"An error that occurred during the onboarding request"},"description":"Errors that occurred during the processing of the onboarding request","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"}},"additionalProperties":false,"description":"Represents an onboarding request","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"action":{"documentationLink":"\u003cstring>","redirectLink":"\u003cstring>","type":"Consent"},"created":"2023-11-07T05:31:56Z","data":{"collective":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","owner":"3c90c3cc-0d44-4b50-8888-8dd25736052a","properties":"\u003cunknown>","type":"Household"},"entity":{"collectiveId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","information":{"type":"Battery","brand":"\u003cstring>","identifier":"\u003cstring>","pairingCode":"\u003cstring>","associatedEmail":"\u003cstring>","name":"\u003cstring>","track":"\u003cstring>"},"owner":"3c90c3cc-0d44-4b50-8888-8dd25736052a","properties":"\u003cunknown>","reference":{"brand":"\u003cstring>","type":"\u003cstring>","identifier":"\u003cstring>"},"systemProperties":"\u003cunknown>","type":"Battery"}},"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","principalId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","requestType":"Collective","returnUrl":"\u003cstring>","status":"Canceled","errors":[{"code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"7c3b56b0-4d74-4884-b1e2-754c5938a080":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errors.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errors.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errors.oneOf.0.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"message":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","description":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2ad340c2-abe4-4362-8272-a229e66e1b0e":{"bearerAuth":{"type":"http","description":"Access Token Authentication","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"1d40f707-7b9c-4048-8049-f9f9c6e28d45":{"url":"https://api.traxes.io/connect"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Access Token Authentication","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access Token Authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://prd.der-connect.eliagroup.eu/swagger/onboarding/v1/swagger.json"},"subdomain":"realto","siteName":"DER Connect API by Elia Group","title":"Retrieve an Entity Onboarding Request - DER Connect API by Elia Group","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-16T11:45:16.471Z","originalFileLocation":"api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the Entity Onboarding Request with specified id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DER Connect API by Elia Group\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve an Entity Onboarding Request - DER Connect API by Elia Group\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the Entity Onboarding Request with specified id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DER Connect API by Elia Group\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://realto.mintlify.site/_mintlify/api/og/v2?division=Onboarding+API\u0026amp;title=Retrieve+an+Entity+Onboarding+Request\u0026amp;description=Returns+the+Entity+Onboarding+Request+with+specified+id.\u0026amp;theme=cc67fc01850f5fb78b380b61\u0026amp;signature=0b97a963e345b84c80b2ee9ce661e03011b5b68c73f499dd4deda36c7a85c79a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve an Entity Onboarding Request - DER Connect API by Elia Group\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the Entity Onboarding Request with specified id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://realto.mintlify.site/_mintlify/api/og/v2?division=Onboarding+API\u0026amp;title=Retrieve+an+Entity+Onboarding+Request\u0026amp;description=Returns+the+Entity+Onboarding+Request+with+specified+id.\u0026amp;theme=cc67fc01850f5fb78b380b61\u0026amp;signature=0b97a963e345b84c80b2ee9ce661e03011b5b68c73f499dd4deda36c7a85c79a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/realto/KWoKhhEqXWAaqvqH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DER Connect API by Elia Group\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF7300\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.der-connect.dev/#organization\",\"name\":\"DER Connect API by Elia Group\",\"url\":\"https://docs.der-connect.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/realto/EG-Ok6q3nUjGJxIo/logo/DER-Connect-Color.svg?fit=max\u0026auto=format\u0026n=EG-Ok6q3nUjGJxIo\u0026q=85\u0026s=3028ab2689f8c3465db02a3e0ec9622a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.der-connect.dev#website\",\"name\":\"DER Connect API by Elia Group\",\"url\":\"https://docs.der-connect.dev\",\"publisher\":{\"@id\":\"https://docs.der-connect.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request#webpage\",\"url\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request\",\"name\":\"Retrieve an Entity Onboarding Request\",\"description\":\"Returns the Entity Onboarding Request with specified id.\",\"dateModified\":\"2025-10-16T11:45:16.471Z\",\"isPartOf\":{\"@id\":\"https://docs.der-connect.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboarding API\",\"item\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-available-entity-brands-and-types\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve an Entity Onboarding Request\",\"item\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request#apireference\",\"headline\":\"Retrieve an Entity Onboarding Request\",\"name\":\"Retrieve an Entity Onboarding Request\",\"description\":\"Returns the Entity Onboarding Request with specified id.\",\"url\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.der-connect.dev/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request#webpage\"},\"dateModified\":\"2025-10-16T11:45:16.471Z\",\"publisher\":{\"@id\":\"https://docs.der-connect.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.der-connect.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DER Connect API by Elia Group\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"DER Connect API by Elia Group\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request.md","siteName":"DER Connect API by Elia Group","nav":{"global":null,"anchors":[{"anchor":"Guides","icon":"book-open-cover","pages":[{"title":"Guides","href":"/quickstart"}]},{"anchor":"API Reference","icon":"rectangle-terminal","groups":[{"group":"Core Resources","pages":[{"group":"Entities","pages":[{"title":"The Entity object","href":"/api-reference/endpoint/core-resources/entities/entity-object"},{"openapi":"get /v1/entities/{entityId}","title":"Retrieve an Entity","href":"/api-reference/endpoint/core-resources/entities/retrieve-an-entity"},{"title":"List all Entities","openapi":"get /v1/entities","href":"/api-reference/endpoint/core-resources/entities/list-entities"},{"group":"Sharing access","pages":[{"title":"Managing permissions","sidebarTitle":"Permissions","href":"/api-reference/endpoint/core-resources/entity-permissions/managing-permissions"},{"title":"List permissions for an Entity","openapi":"get /v1/entities/{entityId}/permissions","sidebarTitle":"List permissions","href":"/api-reference/endpoint/core-resources/entity-permissions/list-permissions-by-entity"},{"title":"Add permissions for an Entity","openapi":"post /v1/entities/{entityId}/permissions","sidebarTitle":"Add permissions","href":"/api-reference/endpoint/core-resources/entity-permissions/add-permissions-to-an-entity"},{"title":"Remove permissions for an Entity","openapi":"delete /v1/entities/{entityId}/permissions/principals/{principalId}","sidebarTitle":"Remove permissions","href":"/api-reference/endpoint/core-resources/entity-permissions/remove-permissions-from-an-entity"}]}]},{"group":"Collectives","pages":[{"title":"The Collective object","href":"/api-reference/endpoint/core-resources/collectives/collective-object"},{"openapi":"get /v1/collectives/{collectiveId}","title":"Retrieve a Collective","href":"/api-reference/endpoint/core-resources/collectives/retrieve-a-collective"},{"title":"List all Collectives","openapi":"get /v1/collectives","href":"/api-reference/endpoint/core-resources/collectives/list-collectives"},{"openapi":"patch /v1/collectives/{collectiveId}","title":"Update a Collective","href":"/api-reference/endpoint/core-resources/collectives/update-a-collective"},{"group":"Entities","pages":[{"title":"List all Entities by Collective","openapi":"get /v1/collectives/{collectiveId}/entities","href":"/api-reference/endpoint/core-resources/collectives/list-entities-by-collective"},{"openapi":"post /v1/collectives/{collectiveId}/entities","title":"Add an Entity to a Collective","href":"/api-reference/endpoint/core-resources/collectives/add-an-entity-to-a-collective"},{"openapi":"delete /v1/collectives/{collectiveId}/entities/{entityId}","title":"Remove an Entity from a Collective","href":"/api-reference/endpoint/core-resources/collectives/remove-an-entity-from-a-collective"}]},{"group":"Members","pages":[{"title":"List all members of a Collective","openapi":"get /v1/collectives/{collectiveId}/members","href":"/api-reference/endpoint/core-resources/collective-members/list-members-by-collective"},{"title":"Add a member to a Collective","openapi":"post /v1/collectives/{collectiveId}/members","href":"/api-reference/endpoint/core-resources/collective-members/add-a-member-to-a-collective"},{"title":"Remove a member from a Collective","openapi":"delete /v1/collectives/{collectiveId}/members/{memberId}","href":"/api-reference/endpoint/core-resources/collective-members/remove-a-member-from-a-collective"}]}]}]},{"group":"Onboarding API","pages":[{"title":"List all available brands and Entity types","sidebarTitle":"List brands and types","openapi":"get /v1/onboarding/types/entities","description":"Returns a list with the available Entity types and the possible brand for each type.","href":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-available-entity-brands-and-types"},{"openapi":"get /v1/onboarding/entities/{onboardingRequestId}","sidebarTitle":"Retrieve a single request","title":"Retrieve an Entity Onboarding Request","href":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-an-entity-onboarding-request"},{"title":"List all Entity Onboarding Requests","sidebarTitle":"List all requests","openapi":"get /v1/onboarding/entities","description":"Returns a page of Entity Onboarding Requests for a specific brand and type, optionally with additional filters.","href":"/api-reference/endpoint/onboarding-api/onboard-entities/retrieve-entity-onboarding-requests"},{"openapi":"post /v1/onboarding/entities","sidebarTitle":"Create a request","title":"Create an Entity Onboarding Request","href":"/api-reference/endpoint/onboarding-api/onboard-entities/create-an-entity-onboarding-request"},{"openapi":"patch /v1/onboarding/entities/{onboardingRequestId}/cancel","sidebarTitle":"Cancel a request","title":"Cancel an Entity Onboarding Request","href":"/api-reference/endpoint/onboarding-api/onboard-entities/cancel-an-entity-onboarding-request"}]},{"group":"Readings API","pages":[{"group":"Readings","pages":[{"title":"The Reading object","href":"/api-reference/endpoint/readings-api/readings/reading-object"},{"title":"List all Readings for an Entity","openapi":"get /v1/entities/{entityId}/readings","sidebarTitle":"List all Readings","href":"/api-reference/endpoint/readings-api/readings/retrieves-readings"},{"title":"Retrieve the last Reading for an Entity","openapi":"get /v1/entities/{entityId}/readings/last","sidebarTitle":"Retrieve the last Reading","href":"/api-reference/endpoint/readings-api/readings/retrieve-the-last-reading"}]},{"group":"Aggregations","pages":[{"title":"Generate aggregations for an Entity","openapi":"get /v1/entities/{entityId}/aggregations","sidebarTitle":"Generate aggregations","href":"/api-reference/endpoint/readings-api/aggregations/retrieve-aggregations"},{"title":"Generate a total aggregation for an Entity","openapi":"get /v1/entities/{entityId}/aggregations/total","sidebarTitle":"Generate a total aggregation","href":"/api-reference/endpoint/readings-api/aggregations/retrieve-the-total-aggregation"}]}]},{"group":"Commands API","pages":[{"group":"Trigger or Schedule","pages":[{"title":"Trigger a Command for Entity","openapi":"post /v1/entities/{entityId}/commands","sidebarTitle":"Trigger for Entity","href":"/api-reference/endpoint/commands-api/trigger-schedule/trigger-for-entity"},{"title":"Schedule Commands for Entity","openapi":"post /v1/entities/{entityId}/commands/schedule","sidebarTitle":"Schedule for Entity","href":"/api-reference/endpoint/commands-api/trigger-schedule/schedule-for-entity"},{"title":"Trigger a Command for VPP","openapi":"post /v1/collectives/{collectiveId}/commands","sidebarTitle":"Trigger for VPP","href":"/api-reference/endpoint/commands-api/trigger-schedule/trigger-for-VPP"},{"title":"Schedule Commands for VPP","openapi":"post /v1/collectives/{collectiveId}/commands/schedule","sidebarTitle":"Schedule for VPP","href":"/api-reference/endpoint/commands-api/trigger-schedule/schedule-for-VPP"}]},{"title":"Retrieve a Command","openapi":"get /v1/entities/{entityId}/commands/{commandId}","href":"/api-reference/endpoint/commands-api/retrieve-a-specific-command-by-its-id"},{"title":"List all Commands for an Entity","openapi":"get /v1/entities/{entityId}/commands","sidebarTitle":"List all Commands","href":"/api-reference/endpoint/commands-api/list-commands"},{"title":"Cancel a Command","openapi":"patch /v1/entities/{entityId}/commands/{commandId}","href":"/api-reference/endpoint/commands-api/cancel-a-command"}]},{"group":"Charge Sessions API","pages":[{"title":"List all Charge Sessions for an Entity","openapi":"get /v1/entities/{entityId}/charge-sessions","sidebarTitle":"List all Charge Sessions","href":"/api-reference/endpoint/charge-sessions-api/list-charging-records-1"}]},{"group":"Entity Settings","pages":[{"group":"Features","pages":[{"title":"Activate or deactivate a feature for an Entity","openapi":"patch /v1/entities/{entityId}/features","href":"/api-reference/endpoint/entity-settings/features/activate-or-deactivate-an-entity-feature"},{"title":"List all features for an Entity","openapi":"get /v1/entities/{entityId}/features","href":"/api-reference/endpoint/entity-settings/features/list-entity-features"}]},{"group":"Locations","pages":[{"openapi":"get /v1/entities/{entityId}/locations/{locationId}","title":"Retrieve a Location for an Entity","href":"/api-reference/endpoint/entity-settings/locations/retrieve-a-location-for-an-entity"},{"openapi":"get /v1/entities/{entityId}/locations","title":"List all Locations of an Entity","href":"/api-reference/endpoint/entity-settings/locations/list-all-locations-of-an-entity"},{"openapi":"post /v1/entities/{entityId}/locations","title":"Create a Location for an Entity","href":"/api-reference/endpoint/entity-settings/locations/create-a-location-for-an-entity"},{"openapi":"patch /v1/entities/{entityId}/locations/{locationId}","title":"Update a Location for an Entity","href":"/api-reference/endpoint/entity-settings/locations/update-a-location-for-an-entity"},{"openapi":"delete /v1/entities/{entityId}/locations/{locationId}","title":"Delete a Location for an Entity","href":"/api-reference/endpoint/entity-settings/locations/delete-a-location-for-an-entity"}]},{"group":"Battery Capacity","pages":[{"openapi":"get /v1/entities/{entityId}/battery-capacity","title":"Retrieve the battery capacity of an Entity","href":"/api-reference/endpoint/entity-settings/battery-capacity/retrieve-the-battery-capacity-of-an-entity"},{"openapi":"put /v1/entities/{entityId}/battery-capacity","title":"Update the battery capacity of an Entity","href":"/api-reference/endpoint/entity-settings/battery-capacity/update-the-battery-capacity-of-an-entity"},{"openapi":"delete /v1/entities/{entityId}/battery-capacity","title":"Delete the battery capacity of an Entity","href":"/api-reference/endpoint/entity-settings/battery-capacity/delete-the-battery-capacity-of-an-entity"}]},{"group":"Nominal Power","pages":[{"openapi":"get /v1/entities/{entityId}/nominal-power","title":"Retrieve the nominal power of an Entity","href":"/api-reference/endpoint/entity-settings/nominal-power/retrieve-the-nominal-power-of-an-entity"},{"openapi":"put /v1/entities/{entityId}/nominal-power","title":"Update the nominal power of an Entity","href":"/api-reference/endpoint/entity-settings/nominal-power/update-the-nominal-power-of-an-entity"},{"openapi":"delete /v1/entities/{entityId}/nominal-power","title":"Delete the nominal power of an Entity","href":"/api-reference/endpoint/entity-settings/nominal-power/delete-the-nominal-power-of-an-entity"}]},{"group":"Heated Area","pages":[{"openapi":"get /v1/entities/{entityId}/heated-area","title":"Retrieve the heated area of an Entity","href":"/api-reference/endpoint/entity-settings/heated-area/retrieve-the-heated-area-of-an-entity"},{"openapi":"put /v1/entities/{entityId}/heated-area","title":"Update the heated area of an Entity","href":"/api-reference/endpoint/entity-settings/heated-area/update-the-heated-area-of-an-entity"},{"openapi":"delete /v1/entities/{entityId}/heated-area","title":"Delete the heated area of an Entity","href":"/api-reference/endpoint/entity-settings/heated-area/delete-the-heated-area-of-an-entity"}]},{"group":"Disaggregators","pages":[{"title":"List all disaggregators for an Entity","openapi":"get /v1/entities/{entityId}/disaggregators","href":"/api-reference/endpoint/entity-settings/disaggregators/list-the-disaggregators-of-an-entity"},{"title":"Add a disaggregator for an Entity","openapi":"patch /v1/entities/{entityId}/disaggregators","href":"/api-reference/endpoint/entity-settings/disaggregators/add-a-disaggregator-to-an-entity"},{"title":"Remove a disaggregator for an Entity","openapi":"delete /v1/entities/{entityId}/disaggregators","href":"/api-reference/endpoint/entity-settings/disaggregators/delete-a-disaggregator-of-an-entity"}]},{"group":"Custom Properties","pages":[{"title":"Update the custom properties of an Entity","openapi":"put /v1/entities/{entityId}/properties","href":"/api-reference/endpoint/entity-settings/custom-properties/update-the-custom-properties-of-an-entity"}]}]},{"group":"Offboarding API","pages":[{"group":"Offboard Entities","pages":[{"title":"Retrieve an Entity Offboarding Request","openapi":"get /v1/offboarding/entities/{offboardingRequestId}","href":"/api-reference/endpoint/offboarding-api/offboard-entities/retrieve-an-offboarding-request"},{"title":"List all Entity Offboarding Requests","openapi":"get /v1/offboarding/entities","href":"/api-reference/endpoint/offboarding-api/offboard-entities/list-offboarding-requests"},{"title":"Create an Entity Offboarding Request","openapi":"post /v1/offboarding/entities","href":"/api-reference/endpoint/offboarding-api/offboard-entities/create-an-offboarding-request"},{"title":"Cancel an Entity Offboarding Request","openapi":"patch /v1/offboarding/entities/{offboardingRequestId}/cancel","href":"/api-reference/endpoint/offboarding-api/offboard-entities/cancel-an-offboarding-request"}]}]}]}]},"basePath":"","title":"Retrieve an Entity Onboarding Request - DER Connect API by Elia Group","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}