operationsManager

Delete a root job and all related items

Only succeeds on completed or cancelled root jobs. Recursively deletes children, tasks, job data, job history, and large files.

delete/operations-manager/jobs/{jobId}

Request

  • Base URL: https://example.itential.io
  • URL: https://example.itential.io/operations-manager/jobs/{jobId}
  • Auth: none declared

Path parameters

jobIdstring required

A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

The id of the Job to delete.

Response

The result of the delete job operation.

messagestring required

A human-readable message summarizing the result of the operation

dataOperationsManagerJobsJobIdDeleteResponsesContentApplicationJsonSchemaDataItems[] required

Any successfully retrieved information related to the request.

metadataobject required

Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.

Changes

No recorded changes to this operation across all 1 revision of this API.