Operations

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

Action

When the action was performed, and details about the user who did it

Properties

Name	Type	Description	Restrictions
dateTime	string(date-time)	When the action was performed	read-only
user	User¦null	A user referenced by their unique identifier. Resolve the user’s profile details through the appropriate Workiva identity API.

Example

{
  "dateTime": "2019-10-30T15:03:27Z",
  "user": {
    "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
  }
}

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-28T15:03:27Z",
    "user": {
      "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
    }
  },
  "details": [
    {
      "code": "exportFailed",
      "message": "The export could not be completed.",
      "target": "/filter"
    }
  ],
  "id": "128f274395254cf17eda6b3eb3d021b9",
  "originalRequest": "7bee78f7-417b-42bc-ace9-e588c65d19bf",
  "resourceUrl": "https://blob.example.com/exports/issues-128f274395254cf17eda6b3eb3d021b9.jsonl?signature=abc123",
  "status": "completed",
  "updated": {
    "dateTime": "2019-10-28T15:04:20Z",
    "user": {
      "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
    }
  }
}

OperationDetail

An OperationDetail contains extra information about an Operation

Properties

Name	Type	Description	Restrictions
code	string¦null	The error code for specified error details	read-only
message	string¦null	A message describing the detail	read-only
target	string¦null	For failures, this will be the target of the error	read-only

Example

{
  "code": "exportFailed",
  "message": "The export could not be completed.",
  "target": "/filter"
}