Develop > Application Programming Interface > Legacy APIs > Artifact API > Retrieve artifact state and status

Retrieve artifact state and status

Details

URI /artifact/state/<artifact_id>
Method GET
Parameters

userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

Request Body None
Return Body ArtifactStateInfo
Returns 200 - Ok
401 - Not authorized
404 - Object not found
500 - Server exception

For all artifacts, possible values for the returned artifactState are:

  • ACTIVE
  • RETIRED

The following state and status information will be returned for specific artifact types.

For service instance artifacts, state will be returned and will contain one of the following values:

  • ACTIVE
  • CANCELLED
  • CANCELLING
  • CANCEL_FAILED
  • DEPLOYING
  • EXPIRE_FAILED
  • EXPIRING
  • FAILED
  • MODIFYING
  • MODIFY_FAILED
  • IN_PROGRESS
  • PUBLIC_ACTION_FAILED
  • RESERVED
  • UPGRADING
  • UPGRADE_FAILED

For service request artifacts:

  • State will be returned and will contain one of the following values:
    • APPROVED
    • CANCELLED
    • COMPLETED
    • IN_PROGRESS
    • PENDING_APPROVAL
    • REJECTED
    • SUBMITTED
  • Status will be returned. If no value was set a null value will be returned. Otherwise it will contain one of the following values:
    • FAILURE
    • SUCCESS

For service subscription artifacts, status will be returned and will contain one of the following values:

  • ACTIVE
  • CANCELLED
  • EXPIRED
  • PAUSED
  • PENDING
  • TERMINATED

Example

The following URL was sent:

https://<host>:<port>/csa/rest/artifact/state/90e72e323ad23bd6013ad23f63da0016?userIdentifier=90d96588360da0c701360da0f1d5f483

The following JSON was returned in the response body:


{
  "id": "90e72e323fe4c9ae013fe4def98a0125",
  "artifactType": "SERVICE_INSTANCE",
  "artifactState": "ACTIVE",
  "state": "FAILED",
  "status":null
}

Send Help Center feedback