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 tasks

GET
http://localhost:3000/operations-manager/tasks
GET
/operations-manager/tasks
$curl http://localhost:3000/operations-manager/tasks \
>     -u "<username>:<password>"
1{
2  "message": "Successfully created the requested item",
3  "data": [
4    {
5      "_id": "string",
6      "location": "Adapter",
7      "view": "/workflow_engine/task/ViewData",
8      "status": "incomplete",
9      "app": "WorkFlowEngine",
10      "name": "ViewData",
11      "variables": {
12        "incoming": {},
13        "outgoing": {},
14        "decorators": [
15          {
16            "type": null,
17            "pointer": "string"
18          }
19        ]
20      },
21      "last_updated": "2024-01-15T09:30:00Z",
22      "encodingVersion": 1,
23      "job": {
24        "_id": "string",
25        "task": "e28f",
26        "name": "Cisco IOS upgrade",
27        "description": "View Task Data",
28        "ancestors": [
29          "string"
30        ]
31      },
32      "incomingRefs": [
33        "string"
34      ],
35      "mockId": "string",
36      "groups": [
37        {
38          "_id": "string",
39          "provenance": "Local AAA",
40          "name": "admin",
41          "description": "string",
42          "memberOf": [
43            {
44              "groupId": "string",
45              "aaaManaged": true
46            }
47          ],
48          "assignedRoles": [
49            {
50              "roleId": "66ec91e12b18975149d9e0d9"
51            }
52          ],
53          "inactive": true,
54          "_meta": {
55            "created": "2024-01-15T09:30:00Z",
56            "updated": "2024-01-15T09:30:00Z",
57            "migrationVersion": 1
58          }
59        }
60      ],
61      "type": null,
62      "metrics": {
63        "start_time": [
64          "2025-03-11T19:03:31.515Z"
65        ],
66        "claim_time": "2024-01-15T09:30:00Z",
67        "end_time": 1740438512495,
68        "server_id": "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860",
69        "finish_state": null,
70        "run_time": 5,
71        "user": {
72          "_id": "string",
73          "provenance": "Local AAA",
74          "username": "admin@pronghorn",
75          "firstname": "admin",
76          "memberOf": [
77            {
78              "groupId": "string",
79              "aaaManaged": true
80            }
81          ],
82          "assignedRoles": [
83            {
84              "roleId": "66ec91e12b18975149d9e0d9"
85            }
86          ],
87          "inactive": true,
88          "lastLogin": "2024-01-15T09:30:00Z",
89          "_meta": {
90            "created": "2024-01-15T09:30:00Z",
91            "updated": "2024-01-15T09:30:00Z",
92            "migrationVersion": 1
93          },
94          "email": "admin@itential.com"
95        },
96        "owner": {
97          "_id": "string",
98          "provenance": "Local AAA",
99          "username": "admin@pronghorn",
100          "firstname": "admin",
101          "memberOf": [
102            {
103              "groupId": "string",
104              "aaaManaged": true
105            }
106          ],
107          "assignedRoles": [
108            {
109              "roleId": "66ec91e12b18975149d9e0d9"
110            }
111          ],
112          "inactive": true,
113          "lastLogin": "2024-01-15T09:30:00Z",
114          "_meta": {
115            "created": "2024-01-15T09:30:00Z",
116            "updated": "2024-01-15T09:30:00Z",
117            "migrationVersion": 1
118          },
119          "email": "admin@itential.com"
120        }
121      }
122    }
123  ],
124  "metadata": {
125    "skip": 1,
126    "limit": 1,
127    "total": 1,
128    "nextPageSkip": null,
129    "previousPageSkip": null,
130    "currentPageSize": 1
131  }
132}
Searches the Task collection.
Was this page helpful?
Previous

Get trigger

Next
Built with

Authentication

AuthorizationBasic

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

Query parameters

limitintegerOptional>=0Defaults to 25
Number of results to return. Used for pagination.
skipintegerOptional>=0Defaults to 0
Number of results to skip. Used for pagination.
orderenumOptionalDefaults to 1

Sort direction, 1 for ascending and -1 for descending.

Allowed values:
sortenumOptionalDefaults to name
Field to sort by
Allowed values:
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’.

instringOptional
Search for fields exactly matching one of the given list options
not-instringOptional
Search for fields not exactly matching one of the given list options
equalsstringOptional

Returns results where the specified fields exactly match the given match string(s).

containsstringOptional

Returns results where the specified fields contain the given match string(s).

starts-withstringOptional

Returns results where the specified fields start with the given match string(s).

ends-withstringOptional

Returns results where the specified fields end in the given match string(s).

dereferencestringOptional
Designates foreign key fields to dereference in the API output.
gtstringOptional
Returns results where the specified fields have values greater than the specified values.
gtestringOptional
Returns results where the specified fields have values greater than or equal to the specified values.
ltstringOptional
Returns results where the specified fields have values less than the specified values.
ltestringOptional
Returns results where the specified fields have values less than or equal to the specified values.
qstringOptional

Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with ‘and’, disjunction with ‘or’, and negation with ‘not’. May be combined with other top-level operators.

actionableTasksbooleanOptionalDefaults to false
If true, only returns actionable tasks that the current user has write access to.

Response

The Tasks 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