Onboard Item to Tenant

1min

GET
/developer/tenants/onboarding/{statusId}

  Get the status of a request to onboard an application or solution.
Path Parameters
statusId
string
*
Header Parameters
x-developerplatform-access
string
*
Responses
200
OnboardingStatusDTO
tenantId
string
*
startedAt
string
failedAt
string
completedAt
string
status
string<STARTED | FAILED | COMPLETED | NOT FOUND | NOT STARTED>
*
logs
string[]
error
string
statusId
string
*
404
Onboarding status not found based on provided id.
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
curl --location --globoff '/developer/tenants/onboarding/{statusId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff '/developer/tenants/onboarding/{statusId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
404
{
  "tenantId": "os1devs",
  "startedAt": "2020-10-10T10:10:10.000Z",
  "failedAt": "2020-10-10T10:10:10.000Z",
  "completedAt": "2020-10-10T10:10:10.000Z",
  "status": "STARTED",
  "logs": [
    ""
  ],
  "error": "Error message: AAA app creation failed",
  "statusId": "5f9b9b9b-9b9b-9b9b-9b9b-9b9b9b9b9b9b"
}
{
  "tenantId": "os1devs",
  "startedAt": "2020-10-10T10:10:10.000Z",
  "failedAt": "2020-10-10T10:10:10.000Z",
  "completedAt": "2020-10-10T10:10:10.000Z",
  "status": "STARTED",
  "logs": [
    ""
  ],
  "error": "Error message: AAA app creation failed",
  "statusId": "5f9b9b9b-9b9b-9b9b-9b9b-9b9b9b9b9b9b"
}
﻿
﻿

Updated 10 Oct 2024

Did this page help you?

Get Organization and Team List for User.

Get Onboarding activity based on either tenantId, itemId or the versionId