Get tasks | Itential

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

{
  "message": "Successfully created the requested item",
  "data": [
    {
      "_id": "string",
      "location": "Adapter",
      "view": "/workflow_engine/task/ViewData",
      "status": "incomplete",
      "app": "WorkFlowEngine",
      "name": "ViewData",
      "variables": {
        "incoming": {},
        "outgoing": {},
        "decorators": [
          {
            "pointer": "string"
          }
        ]
      },
      "last_updated": "2024-01-15T09:30:00Z",
      "encodingVersion": 1,
      "job": {
        "_id": "string",
        "task": "e28f",
        "name": "Cisco IOS upgrade",
        "description": "View Task Data",
        "ancestors": [
          "string"
        ]
      },
      "incomingRefs": [
        "string"
      ],
      "mockId": "string",
      "groups": [
        {
          "_id": "string",
          "provenance": "Local AAA",
          "name": "admin",
          "description": "string",
          "memberOf": [
            {
              "groupId": "string",
              "aaaManaged": true
            }
          ],
          "assignedRoles": [
            {
              "roleId": "66ec91e12b18975149d9e0d9"
            }
          ],
          "inactive": true,
          "_meta": {
            "created": "2024-01-15T09:30:00Z",
            "updated": "2024-01-15T09:30:00Z",
            "migrationVersion": 1
          }
        }
      ],
      "metrics": {
        "start_time": [
          "2025-03-11T19:03:31.515Z"
        ],
        "claim_time": "2024-01-15T09:30:00Z",
        "end_time": 1740438512495,
        "server_id": "9349c650f70d50e4fe89c95327b7d4d9e6b5228ac83fe4fae120045b37b67860",
        "run_time": 5,
        "user": {
          "_id": "string",
          "provenance": "Local AAA",
          "username": "admin@pronghorn",
          "firstname": "admin",
          "memberOf": [
            {
              "groupId": "string",
              "aaaManaged": true
            }
          ],
          "assignedRoles": [
            {
              "roleId": "66ec91e12b18975149d9e0d9"
            }
          ],
          "inactive": true,
          "lastLogin": "2024-01-15T09:30:00Z",
          "_meta": {
            "created": "2024-01-15T09:30:00Z",
            "updated": "2024-01-15T09:30:00Z",
            "migrationVersion": 1
          },
          "email": "admin@itential.com"
        },
        "owner": {
          "_id": "string",
          "provenance": "Local AAA",
          "username": "admin@pronghorn",
          "firstname": "admin",
          "memberOf": [
            {
              "groupId": "string",
              "aaaManaged": true
            }
          ],
          "assignedRoles": [
            {
              "roleId": "66ec91e12b18975149d9e0d9"
            }
          ],
          "inactive": true,
          "lastLogin": "2024-01-15T09:30:00Z",
          "_meta": {
            "created": "2024-01-15T09:30:00Z",
            "updated": "2024-01-15T09:30:00Z",
            "migrationVersion": 1
          },
          "email": "admin@itential.com"
        }
      }
    }
  ],
  "metadata": {
    "skip": 1,
    "limit": 1,
    "total": 1,
    "currentPageSize": 1
  }
}

Searches the Task collection.

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.

orderenumOptional

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