Operations

Use these endpoints to manage operations, such as to check their status.

Operation

Details about the operation, including its ID, status, milestone dates, and the url of the resource upon successful completion of the operation.

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
details	[OperationDetail]¦null	A list of additional details about the operation	read-only
id	string	The unique identifier of the operation	read-only
originalRequest	string(uuid)	This is the Request ID that initiated this async operation. Giving this ID to support can help track issues with your operations.	read-only
resourceUrl	string¦null	The link to the resulting resource(s)	read-only
status	string	The current status of the operation	read-only
updated	Action	When the action was performed, and details about the user who did it	read-only

Enumerated Values

Property	Value
status	acknowledged
status	queued
status	started
status	completed
status	cancelled
status	failed

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "details": [
    {
      "code": "InvalidOrder",
      "message": "Attempted to modify locked cells",
      "target": "name"
    }
  ],
  "id": "128f274395254cf17eda6b3eb3d021b9",
  "originalRequest": "7bee78f7-417b-42bc-ace9-e588c65d19bf",
  "resourceUrl": "string",
  "status": "completed",
  "updated": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  }
}