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": [
      {
        "type": null,
        "pointer": "string"
      }
    ],
    "transitions": {},
    "status": "error",
    "variables": {
      "initiator": {
        "location": "job_data",
        "_id": "67be20c2dda0df69ebe60826"
      },
      "_id": {
        "location": "job_data",
        "_id": "67be20c2dda0df69ebe60825"
      }
    },
    "tags": [
      "string"
    ],
    "error": [
      {
        "task": null,
        "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,
    "created_by": null,
    "last_updated_by": null,
    "tasks": {
      "workflow_start": {
        "metrics": {
          "user": null
        },
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      },
      "workflow_end": {
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      },
      "error_handler": {
        "actor": null,
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      }
    },
    "parent": {
      "job": "fe7043ac41d24206aa556c49",
      "task": "defc",
      "iteration": 1,
      "element": 0
    },
    "errorHandler": null,
    "groups": [
      "string"
    ],
    "watchers": [
      null
    ],
    "metrics": {
      "start_time": 1.1,
      "progress": 0.5,
      "end_time": 1.1,
      "user": null,
      "owner": null
    },
    "output": {},
    "outputData": {}
  },
  "metadata": {}
}

Returns a Job.

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": [
      {
        "type": null,
        "pointer": "string"
      }
    ],
    "transitions": {},
    "status": "error",
    "variables": {
      "initiator": {
        "location": "job_data",
        "_id": "67be20c2dda0df69ebe60826"
      },
      "_id": {
        "location": "job_data",
        "_id": "67be20c2dda0df69ebe60825"
      }
    },
    "tags": [
      "string"
    ],
    "error": [
      {
        "task": null,
        "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,
    "created_by": null,
    "last_updated_by": null,
    "tasks": {
      "workflow_start": {
        "metrics": {
          "user": null
        },
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      },
      "workflow_end": {
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      },
      "error_handler": {
        "actor": null,
        "groups": [
          "string"
        ],
        "iterations": [
          {}
        ]
      }
    },
    "parent": {
      "job": "fe7043ac41d24206aa556c49",
      "task": "defc",
      "iteration": 1,
      "element": 0
    },
    "errorHandler": null,
    "groups": [
      "string"
    ],
    "watchers": [
      null
    ],
    "metrics": {
      "start_time": 1.1,
      "progress": 0.5,
      "end_time": 1.1,
      "user": null,
      "owner": null
    },
    "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

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

1	{
2	"message": "Successfully created the requested item",
3	"data": {
4	"_id": "string",
5	"uuid": "string",
6	"font_size": 12,
7	"type": "automation",
8	"created": "2024-01-15T09:30:00Z",
9	"last_updated": "2024-01-15T09:30:00Z",
10	"createdVersion": "5.55.5",
11	"lastUpdatedVersion": "5.55.6",
12	"canvasVersion": 1,
13	"encodingVersion": 1,
14	"migrationVersion": 1,
15	"name": "Cisco IOS upgrade",
16	"description": "Turn up the port",
17	"preAutomationTime": 0,
18	"sla": 0,
19	"decorators": [
20	{
21	"type": null,
22	"pointer": "string"
23	}
24	],
25	"transitions": {},
26	"status": "error",
27	"variables": {
28	"initiator": {
29	"location": "job_data",
30	"_id": "67be20c2dda0df69ebe60826"
31	},
32	"_id": {
33	"location": "job_data",
34	"_id": "67be20c2dda0df69ebe60825"
35	}
36	},
37	"tags": [
38	"string"
39	],
40	"error": [
41	{
42	"task": null,
43	"message": {},
44	"timestamp": 1.1
45	}
46	],
47	"warnings": [
48	{
49	"task": "workflow_start",
50	"name": "Cisco IOS upgrade",
51	"message": {}
52	}
53	],
54	"ancestors": [
55	"string"
56	],
57	"validationErrors": [
58	{
59	"keyword": "string",
60	"instancePath": "string",
61	"schemaPath": "string",
62	"params": {},
63	"message": "string"
64	}
65	],
66	"namespace": {},
67	"mocked": true,
68	"created_by": null,
69	"last_updated_by": null,
70	"tasks": {
71	"workflow_start": {
72	"metrics": {
73	"user": null
74	},
75	"groups": [
76	"string"
77	],
78	"iterations": [
79	{}
80	]
81	},
82	"workflow_end": {
83	"groups": [
84	"string"
85	],
86	"iterations": [
87	{}
88	]
89	},
90	"error_handler": {
91	"actor": null,
92	"groups": [
93	"string"
94	],
95	"iterations": [
96	{}
97	]
98	}
99	},
100	"parent": {
101	"job": "fe7043ac41d24206aa556c49",
102	"task": "defc",
103	"iteration": 1,
104	"element": 0
105	},
106	"errorHandler": null,
107	"groups": [
108	"string"
109	],
110	"watchers": [
111	null
112	],
113	"metrics": {
114	"start_time": 1.1,
115	"progress": 0.5,
116	"end_time": 1.1,
117	"user": null,
118	"owner": null
119	},
120	"output": {},
121	"outputData": {}
122	},
123	"metadata": {}
124	}