For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd GBAC to a job
        • POSTAdd watchers to a job
        • POSTAssign a task to a user
        • POSTBulk delete root jobs
        • POSTCancel jobs
        • POSTClaim a task
        • POSTClone automation
        • POSTContinue a job from a specified task
        • POSTCreate automation
        • POSTCreate trigger
        • DELDelete a root job and all related items
        • DELDelete automation
        • POSTDelete root jobs and related items
        • DELDelete trigger
        • DELDelete triggers by action ID
        • GETExport automation
        • GETExport large data for a job or task variable
        • GETExport trigger
        • POSTFinish a manual task
        • GETGet a job
        • GETGet a task by ID
        • GETGet automation
        • GETGet automations
        • GETGet event definition
        • GETGet jobs
        • GETGet manual task controller
        • GETGet tasks
        • GETGet trigger
        • GETGet triggers
        • PUTImport automations
        • PUTImport triggers
        • POSTPauses jobs
        • POSTRelease a currently assigned task
        • DELRemove all GBAC from a job
        • DELRemove GBAC from a job
        • PUTReplace all GBAC from a job with the provided list
        • POSTResume jobs
        • POSTRetry a task
        • POSTRevert a job
        • POSTRun endpoint trigger with POST
        • POSTRun manual trigger
        • GETSearch system events
        • POSTStart a job
        • POSTUnwatch job
        • POSTUnwatch jobs
        • PATCHUpdate automation
        • PATCHUpdate trigger
        • POSTValidate automation
        • POSTValidate trigger
        • POSTWatch a job
        • POSTWatch jobs
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceOperations Manager

Get jobs

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

Get manual task controller

Next
Built with

Authentication

AuthorizationBasic

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

Response

The Jobs that matched the search query.
messagestring

A human-readable message summarizing the result of the operation

datalist of objects
Any successfully retrieved information related to the request.
metadataobject

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