manageJobs

1
/{orgId}/{itemId}/jobs/manage

Manage one or more jobs with specified jobIds. Valid enum values for manage are Upgrade, Close, Reopen, and Delete.

Upgrade
Upgrade will upgrade the existing job(s) to the latest active diagram version. The jobUpgrade privilege is required to upgrade a job. A job will not be upgraded if:

• You have insufficient privileges
• The job is closed
• The job is currently running
• The current step on the job does not exist on the diagram

Close
Close will close open job(s). The jobClose privilege is required to close a job. A job will not be closed if:

• You have insufficient privileges
• The job is currently running

Reopen
Reopen will reopen one or more jobs. The jobReopenClosed privilege is required to reopen a job. A job will not be reopened if:

• You have insufficient privileges
• The job is currently open

Delete
Delete one or more jobs. The attachments, extended properties and locations associated with the job are also deleted. The jobDelete privilege is required to delete a job. A job will not be deleted if:

• You have insufficient privileges
• The job is currently running

Query parameters

Body parameters

Supported content types: application/json

Type: JobManageBody

Manage action to be taken on jobs(s)

Path parameters

Response status

Examples

Request

1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/manage \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"type":"Close","jobIds":["string"]}'

Response

1
2
3
{
  "success": true
}