Get the status of an asynchronous tenant creation operation

GET 
/api/web/v4/async/tenants/:id/createstatus

Get the status of a tenant creation operation for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.

Request

Path Parameters

id stringrequired

The UUID of the create tenant operation whose status is be fetched.

Responses

200

Successful

application/json

Schema

Schema

errorMessage string

The error message describing the first error encountered processing the operation.

id stringrequired

The unique UUID of the operation. Used to get status and results of operation

initTime date-time

The time this operation was initialized.

processingEndTime date-time

The time at which the operation completed processing.

processingStartTime date-time

The time at which the operation began processing.

processingTime int64

How long the operation took to complete processing in milliseconds.

state stringrequired

Possible values: [FAILED, CANCELLED, COMPLETED, AWAITING_DATA, PROCESSING, SCHEDULED]

The state of the operation.

subject string

The subject of this operation.

Example (from schema)

{
  "errorMessage": "string",
  "id": "string",
  "initTime": "2019-02-19T13:15:27Z",
  "processingEndTime": "2019-02-19T13:15:27Z",
  "processingStartTime": "2019-02-19T13:15:27Z",
  "processingTime": 0,
  "state": "FAILED",
  "subject": "string"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...