Get a job | Itential

curl http://localhost:3000/operations-manager/jobs/id \
     -u "<username>:<password>"

{
  "message": "Successfully created the requested item",
  "data": {
    "_id": "string",
    "uuid": "string",
    "font_size": 12,
    "type": "automation",
    "created": "2024-01-15T09:30:00Z",
    "last_updated": "2024-01-15T09:30:00Z",
    "createdVersion": "5.55.5",
    "lastUpdatedVersion": "5.55.6",
    "canvasVersion": 1,
    "encodingVersion": 1,
    "migrationVersion": 1,
    "name": "Cisco IOS upgrade",
    "description": "Turn up the port",
    "preAutomationTime": 0,
    "sla": 0,
    "decorators": [
      {
        "pointer": "string"
      }
    ],
    "transitions": {},
    "status": "error",
    "variables": {
      "initiator": {
        "location": "job_data",
        "_id": "67be20c2dda0df69ebe60826"
      },
      "_id": {
        "location": "job_data",
        "_id": "67be20c2dda0df69ebe60825"
      }
    },
    "tags": [
      "string"
    ],
    "error": [
      {
        "message": {},
        "timestamp": 1.1
      }
    ],
    "warnings": [
      {
        "task": "workflow_start",
        "name": "Cisco IOS upgrade",
        "message": {}
      }
    ],
    "ancestors": [
      "string"
    ],
    "validationErrors": [
      {
        "keyword": "string",
        "instancePath": "string",
        "schemaPath": "string",
        "params": {},
        "message": "string"
      }
    ],
    "namespace": {},
    "mocked": true,
    "tasks": {
      "workflow_start": {
        "metrics": {},
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      },
      "workflow_end": {
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      },
      "error_handler": {
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      }
    },
    "parent": {
      "job": "fe7043ac41d24206aa556c49",
      "task": "defc",
      "iteration": 1,
      "element": 0
    },
    "groups": [
      "string"
    ],
    "watchers": [
      null
    ],
    "metrics": {
      "start_time": 1.1,
      "progress": 0.5,
      "end_time": 1.1
    },
    "output": {},
    "outputData": {}
  },
  "metadata": {}
}

Returns a Job.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idstringRequiredformat: "^[0-9a-f]{24}$"

The id of the Job to get.

Query parameters

includestringOptional

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’.

excludestringOptional

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

dereferencestringOptional

Designates foreign key fields to dereference in the API output.

Response

The requested Job.

messagestring

A human-readable message summarizing the result of the operation

dataobject

Any successfully retrieved information related to the request.

metadatamap from strings to any

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.

Errors

500

Internal Server Error