operationsManager

Get a job

Returns a Job.

get/operations-manager/jobs/{id}

Request

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

Path parameters

idstring required

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

The id of the Job to get.

Query parameters

includestring

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

excludestring

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

dereferencestring

Designates foreign key fields to dereference in the API output.

Response

The requested Job.

messagestring required

A human-readable message summarizing the result of the operation

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.