get-operation-status-3b330bb.md

Get Operation Status

Check the status of the asynchronous operation.

Check the status of the asynchronous operation you created after the POST, DELETE, or PATCH calls of the Service Instances and Service Bindings API groups.

In the Location response headers of those APIs, you get the path parameters that are required for this API.

Prerequisites

You have obtained an access token with the scope required for the operation for which you wish to get status.

For more information, see Accessing the APIs.

Request

URI: https://service-manager.cfapps.<landscape domain>/v1/{resourceType}/{resourceID}/operations/{operationID}

HTTP Method: GET

Path Parameters

Parameter Name	Required	Parameter Type	Description
resourceType	Yes	String	The type of the SAP Service Manager resource associated with the asynchronous operation. Values: platforms service_brokers service_bindings service_instances
resourceID	Yes	String	The ID of the resource entity for which to get asynchronous operation status.
operationID	Yes	String	The ID of the asynchronous operation for which to get status.

Response

Returns details about the requested asynchronous operation, and its associated objects.

**Content Type:**JSON

Response Headers

Header	Values
content-type	application/json; charset=UTF-8

Response Status and Error Codes

Code	Description
200	Found asynchronous operation (OK)
400	Bad Request
403	Forbidden
404	Asynchronous operation not found

Response Objects and Their Parameters

OperationResponseObject

Contains details about the last operation, and transitive resources.

Parameter Name	Parameter Type	Description
id	String	The ID of the last operation.
ready	Boolean	Whether the resource is ready.
type	String	The type of the operation. Possible values: CREATE UPDATE DELETE
state	String	Possible values: in progress succeeded failed While "state": "in progress", the platform continues polling. When: "state": "succeeded" or "state": "failed" the platform stops polling.
description	String	Details about the operation for customer-facing UI.
resource_id	String	The ID of the resource. Present when "state": "succeeded", and after PATCH or DELETE requests.
errors	Array of JSON objects: Error	The list of errors if the operation has failed. Each Error object in the list contains two parameters: error, which indicates the name of the error, and its description.
labels	JSON object: LabelsResponseObject	Additional data associated with the last operation. Can be an empty object.
transitive_resources	JSON object: TransitiveResourceObject	Additional information about the transitive resource. See the next table TransitiveResourceObject for its properties.

TransitiveResourceObject

Parameter Name	Parameter Type	Description
id	String	The ID of the resource.
type	String	The type of the resource.
operation_type	String	The type of the operation associated with the resource.
criteria	String	The minimum criteria required to use the resource in the context of the platform.
resource_type	String	The type of the resource associated with the last operation.
platform_id	String	The ID of the platform associated with the operation.
correlation_id	String	The correlation ID received from the request related to this operation.
reschedule	Boolean	Whether the operation has reached a checkpoint and can be tried again.
deletion_scheduled	String	The time the resource is scheduled for deletion. In ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD
created_at	String	The time the operation started. In ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD
updated_at	String	The last time the resource was updated. In ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD This field is mandatory if "state": "succeeded" or "state": "failed".

Response Example

{
  "id": "dsdssd498da96-e5f3-4402-8",
  "ready": true,
  "type": "CREATE",
  "state": "in progress",
  "description": "string",
  "resource_id": "string",
  "transitive_resources": [
    {
      "id": "0aba8e41-5e69-44b1-974f-83100",
      "type": "string",
      "operation_type": "string",
      "criteria": "string"
    }
  ],
  "resource_type": "string",
  "platform_id": "string",
  "correlation_id": "string",
  "reschedule": true,
  "deletion_scheduled": "2020-04-10T22:28:05.215Z",
  "created_at": "2020-04-10T22:28:05.215Z",
  "updated_at": "2020-04-10T22:28:05.215Z",
  "errors": [
    {
      "error": "string",
      "description": "string"
    }
  ],
  "labels": {
    "label1": [
      "value1",
      "value2",
      "value3"
    ],
    "label2": [
      "value1",
      "value2",
      "value3"
    ]
  }
}

Related Information

Operations