--- title: "Get a job" method: GET path: "/operations-manager/jobs/{id}" tags: ["Operations Manager"] --- # Get 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 Returns a Job. ## Path parameters - `id` string, required: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. ## Query parameters - `include` string - `exclude` string - `dereference` string ## Response `200` The requested Job. - OperationsManagerGetJobResponse200: A success response from an API method - `message` string, required: A human-readable message summarizing the result of the operation - `data` OperationsManagerJobApi, required: A Job document in API response format. - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `uuid` string - `font_size` integer - `type` 'automation' | 'resource:action' | 'resource:compliance' - `created` string, date-time: An ISO 8601 date string - `last_updated` string, date-time: An ISO 8601 date string - `createdVersion` string - `lastUpdatedVersion` string - `canvasVersion` '1' | '1.5' | '2' | '3' - `encodingVersion` '1' - `migrationVersion` integer: The current document version of this document. - `name` string: The name of the document - `description` string, nullable - `preAutomationTime` number, double - `sla` number, double - `decorators` OperationsManagerJobApiDecoratorsItems[] - `type` unknown - `pointer` string, json-pointer - `transitions` OperationsManagerJobApiTransitions - `status` 'error' | 'complete' | 'running' | 'canceled' | 'incomplete' | 'paused' - `variables` OperationsManagerJobApiVariables - `tags` unknown[] - unknown - `error` OperationsManagerJobApiErrorItems[] - `task` union - unknown - union - 'workflow_start' | 'workflow_end' | 'error_handler' - string - `message` union - object - string - `timestamp` number, double: The time at which this error occurred, designated by a unix timestamp - `warnings` OperationsManagerJobApiWarningsItems[] - `task` union - 'workflow_start' | 'workflow_end' | 'error_handler' - string - `name` string: The name of the document - `message` union - object - string - `ancestors` string[], nullable - `validationErrors` OperationsManagerJobApiValidationErrorsItems[] - `keyword` string - `instancePath` string - `schemaPath` string - `params` OperationsManagerJobApiValidationErrorsItemsParams - `message` string - `namespace` OperationsManagerJobApiNamespace - `mocked` boolean - `created_by` union - unknown - string - OperationsManagerJobApiCreatedBy2 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `username` string - `firstname` string - `memberOf` OperationsManagerJobApiCreatedByOneOf2MemberOfItems[] - `groupId` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `aaaManaged` boolean - `assignedRoles` OperationsManagerJobApiCreatedByOneOf2AssignedRolesItems[] - `roleId` string - `inactive` boolean - `lastLogin` string, date-time: An ISO 8601 date string - `_meta` OperationsManagerJobApiCreatedByOneOf2Meta - `created` string, date-time: An ISO 8601 date string - `updated` string, date-time: An ISO 8601 date string - `migrationVersion` integer: The current document version of this document. - `email` string - `last_updated_by` union - unknown - string - OperationsManagerJobApiLastUpdatedBy2 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `username` string - `firstname` string - `memberOf` OperationsManagerJobApiLastUpdatedByOneOf2MemberOfItems[] - `groupId` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `aaaManaged` boolean - `assignedRoles` OperationsManagerJobApiLastUpdatedByOneOf2AssignedRolesItems[] - `roleId` string - `inactive` boolean - `lastLogin` string, date-time: An ISO 8601 date string - `_meta` OperationsManagerJobApiLastUpdatedByOneOf2Meta - `created` string, date-time: An ISO 8601 date string - `updated` string, date-time: An ISO 8601 date string - `migrationVersion` integer: The current document version of this document. - `email` string - `tasks` OperationsManagerJobApiTasks - `workflow_start` OperationsManagerJobApiTasksWorkflowStart - `x` number, double: Stores the x coordinate used by canvasType = 1 workflows - `y` number, double: Stores the y coordinate used by canvasType = 1 workflows - `gridCoordinate` OperationsManagerJobApiTasksWorkflowStartGridCoordinate: Stores the coordinates used by canvasType = 2 workflows - `x` number, double - `y` number, double - `name` unknown - `summary` unknown - `taskId` unknown - `metrics` OperationsManagerJobApiTasksWorkflowStartMetrics - `start_time` number, double - `finish_state` 'success' | 'failure' | 'error' - `user` union - unknown - string - OperationsManagerJobApiTasksWorkflowStartMetricsUser2 - … - `groups` OperationsManagerJobApiTasksWorkflowStartGroupsItems[] - union - string - OperationsManagerJobApiTasksWorkflowStartGroupsItems1 - … - unknown - `iterations` OperationsManagerJobApiTasksWorkflowStartIterationsItems[] - union - string - object - `workflow_end` OperationsManagerJobApiTasksWorkflowEnd - `x` number, double: Stores the x coordinate used by canvasType = 1 workflows - `y` number, double: Stores the y coordinate used by canvasType = 1 workflows - `gridCoordinate` OperationsManagerJobApiTasksWorkflowEndGridCoordinate: Stores the coordinates used by canvasType = 2 workflows - `x` number, double - `y` number, double - `name` unknown - `summary` unknown - `taskId` unknown - `endTasks` OperationsManagerJobApiTasksWorkflowEndEndTasks - `incomplete` OperationsManagerJobApiTasksWorkflowEndEndTasksIncompleteItems[] - union - … - `complete` OperationsManagerJobApiTasksWorkflowEndEndTasksCompleteItems[] - union - … - `error` OperationsManagerJobApiTasksWorkflowEndEndTasksErrorItems[] - union - … - `metrics` OperationsManagerJobApiTasksWorkflowEndMetrics - `end_time` number, double - `run_time` number, double - `groups` OperationsManagerJobApiTasksWorkflowEndGroupsItems[] - union - string - OperationsManagerJobApiTasksWorkflowEndGroupsItems1 - … - unknown - `iterations` OperationsManagerJobApiTasksWorkflowEndIterationsItems[] - union - string - object - `error_handler` OperationsManagerJobApiTasksErrorHandler - `x` number, double: Stores the x coordinate used by canvasType = 1 workflows - `y` number, double: Stores the y coordinate used by canvasType = 1 workflows - `gridCoordinate` OperationsManagerJobApiTasksErrorHandlerGridCoordinate: Stores the coordinates used by canvasType = 2 workflows - `x` number, double - `y` number, double - `name` 'childJob' - `location` 'Adapter' | 'Application' | 'Broker' - `locationType` string, nullable - `app` string - `canvasName` string - `displayName` string - `summary` string - `description` string - `variables` OperationsManagerJobApiTasksErrorHandlerVariables - `incoming` OperationsManagerJobApiTasksErrorHandlerVariablesIncoming - `outgoing` OperationsManagerJobApiTasksErrorHandlerVariablesOutgoing - `error` string - `decorators` OperationsManagerJobApiTasksErrorHandlerVariablesDecoratorsItems[] - `type` unknown - `pointer` string, json-pointer - `deprecated` boolean - `scheduled` boolean - `matched` OperationsManagerJobApiTasksErrorHandlerMatchedItems[] - `key` string - `highlightString` string - `status` 'incomplete' | 'scheduled' | 'running' | 'complete' | 'canceled' | 'error' | 'failure' | 'paused' - `previous` OperationsManagerJobApiTasksErrorHandlerPrevious - `incomplete` OperationsManagerJobApiTasksErrorHandlerPreviousIncompleteItems[] - union - … - `complete` OperationsManagerJobApiTasksErrorHandlerPreviousCompleteItems[] - union - … - `error` OperationsManagerJobApiTasksErrorHandlerPreviousErrorItems[] - union - … - `taskId` union - 'workflow_start' | 'workflow_end' | 'error_handler' - string - `transitions` OperationsManagerJobApiTasksErrorHandlerTransitions - `success` OperationsManagerJobApiTasksErrorHandlerTransitionsSuccessItems[] - `task` union - … - `type` 'standard' | 'revert' | 'loop' - `failure` OperationsManagerJobApiTasksErrorHandlerTransitionsFailureItems[] - `task` union - … - `type` 'standard' | 'revert' | 'loop' - `error` OperationsManagerJobApiTasksErrorHandlerTransitionsErrorItems[] - `task` union - … - `type` 'standard' | 'revert' | 'loop' - `serverId` string - `start_time` string, date-time: An ISO 8601 date string - `end_time` number, double - `finish_state` 'success' | 'failure' | 'error' - `retrySettings` OperationsManagerJobApiTasksErrorHandlerRetrySettings - `state` OperationsManagerJobApiTasksErrorHandlerRetrySettingsStateItems[] - `autoRetry` boolean - `limit` integer - `delay` integer - `count` integer - `finishedRetrying` boolean - `mockId` string: A UUIDv4 identifier. - `type` unknown - `actor` union - union - unknown - string - OperationsManagerJobApiTasksErrorHandlerActorOneOf02 - … - unknown - `groups` OperationsManagerJobApiTasksErrorHandlerGroupsItems[] - union - string - OperationsManagerJobApiTasksErrorHandlerGroupsItems1 - … - unknown - `iterations` OperationsManagerJobApiTasksErrorHandlerIterationsItems[] - union - string - object - `parent` OperationsManagerJobApiParent - `job` union - string - object - `task` string - `iteration` number, double - `element` number, double - `errorHandler` OperationsManagerJobApiErrorHandler - `actor` union - union - unknown - string - OperationsManagerJobApiErrorHandlerActorOneOf02 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `username` string - `firstname` string - `memberOf` OperationsManagerJobApiErrorHandlerActorOneOf0OneOf2MemberOfItems[] - … - `assignedRoles` OperationsManagerJobApiErrorHandlerActorOneOf0OneOf2AssignedRolesItems[] - … - `inactive` boolean - `lastLogin` string, date-time: An ISO 8601 date string - `_meta` OperationsManagerJobApiErrorHandlerActorOneOf0OneOf2Meta - … - `email` string - unknown - `groups` OperationsManagerJobApiErrorHandlerGroupsItems[] - union - string - OperationsManagerJobApiErrorHandlerGroupsItems1 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `name` string - `description` string - `memberOf` OperationsManagerJobApiErrorHandlerGroupsItemsOneOf1MemberOfItems[] - … - `assignedRoles` OperationsManagerJobApiErrorHandlerGroupsItemsOneOf1AssignedRolesItems[] - … - `inactive` boolean - `_meta` OperationsManagerJobApiErrorHandlerGroupsItemsOneOf1Meta - … - unknown - `iterations` OperationsManagerJobApiErrorHandlerIterationsItems[] - union - string - object - `groups` OperationsManagerJobApiGroupsItems[] - union - string - OperationsManagerJobApiGroupsItems1 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `name` string - `description` string - `memberOf` OperationsManagerJobApiGroupsItemsOneOf1MemberOfItems[] - `groupId` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `aaaManaged` boolean - `assignedRoles` OperationsManagerJobApiGroupsItemsOneOf1AssignedRolesItems[] - `roleId` string - `inactive` boolean - `_meta` OperationsManagerJobApiGroupsItemsOneOf1Meta - `created` string, date-time: An ISO 8601 date string - `updated` string, date-time: An ISO 8601 date string - `migrationVersion` integer: The current document version of this document. - unknown - `watchers` OperationsManagerJobApiWatchersItems[] - union - unknown - string - OperationsManagerJobApiWatchersItems2 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `username` string - `firstname` string - `memberOf` OperationsManagerJobApiWatchersItemsOneOf2MemberOfItems[] - `groupId` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `aaaManaged` boolean - `assignedRoles` OperationsManagerJobApiWatchersItemsOneOf2AssignedRolesItems[] - `roleId` string - `inactive` boolean - `lastLogin` string, date-time: An ISO 8601 date string - `_meta` OperationsManagerJobApiWatchersItemsOneOf2Meta - `created` string, date-time: An ISO 8601 date string - `updated` string, date-time: An ISO 8601 date string - `migrationVersion` integer: The current document version of this document. - `email` string - `metrics` OperationsManagerJobApiMetrics - `start_time` number, double - `progress` number, double - `end_time` number, double - `user` union - unknown - string - OperationsManagerJobApiMetricsUser2 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `username` string - `firstname` string - `memberOf` OperationsManagerJobApiMetricsUserOneOf2MemberOfItems[] - `groupId` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `aaaManaged` boolean - `assignedRoles` OperationsManagerJobApiMetricsUserOneOf2AssignedRolesItems[] - `roleId` string - `inactive` boolean - `lastLogin` string, date-time: An ISO 8601 date string - `_meta` OperationsManagerJobApiMetricsUserOneOf2Meta - `created` string, date-time: An ISO 8601 date string - `updated` string, date-time: An ISO 8601 date string - `migrationVersion` integer: The current document version of this document. - `email` string - `owner` union - unknown - string - OperationsManagerJobApiMetricsOwner2 - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `provenance` string - `username` string - `firstname` string - `memberOf` OperationsManagerJobApiMetricsOwnerOneOf2MemberOfItems[] - `groupId` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId. - `aaaManaged` boolean - `assignedRoles` OperationsManagerJobApiMetricsOwnerOneOf2AssignedRolesItems[] - `roleId` string - `inactive` boolean - `lastLogin` string, date-time: An ISO 8601 date string - `_meta` OperationsManagerJobApiMetricsOwnerOneOf2Meta - `created` string, date-time: An ISO 8601 date string - `updated` string, date-time: An ISO 8601 date string - `migrationVersion` integer: The current document version of this document. - `email` string - `output` OperationsManagerJobApiOutput - `outputData` OperationsManagerJobApiOutputData - `metadata` object, 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. ## Other responses - `500`: Error response from API ## Changes - **2026-10-31** `2095cc90e583`: 2 info - api tag `Operations Manager` added - api tag `operationsManager` removed [Operation history](https://skmtc.dev/itential/apis/itential-2/changes/operations-manager/jobs/:id/get.md) --- [API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)