Summary
Gets Tasks
Description
Search the Task collection.
Route
GET /operations-manager/tasks
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| queryParameters | object | yes | The query parameters available for this method. |
{ "queryParameters": { "limit": 1, "skip": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "amet", "not-in": "voluptate quis", "equals": "officia proident", "contains": "cupidatat in minim", "starts-with": "nulla deserunt aliqua dolor", "ends-with": "nulla non", "dereference": "aliquip voluptate Ut", "gt": "dolore ad esse", "gte": "dolor Excepteur labore minim", "lt": "anim dolore eu ut enim", "lte": "eiusmod", "q": "dolor esse ut sed tempor", "actionableTasks": false } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "include": { "type": "string", "description": "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'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" }, "dereference": { "description": "Designates foreign key fields to dereference in the API output.", "type": "string" }, "gt": { "description": "Returns results where the specified fields have values greater than the specified values.", "type": "string" }, "gte": { "description": "Returns results where the specified fields have values greater than or equal to the specified values.", "type": "string" }, "lt": { "description": "Returns results where the specified fields have values less than the specified values.", "type": "string" }, "lte": { "description": "Returns results where the specified fields have values less than or equal to the specified values.", "type": "string" }, "q": { "description": "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.", "type": "string" }, "actionableTasks": { "type": "boolean", "description": "If true, only returns actionable tasks that the current user has write access to.", "default": false } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| result | object | The Tasks that matched the search query. |
{ "message": "Successfully imported 3 of 4 documents", "data": [ { "_id": "4Dd54da0-07fe-70ef-2e07-Bd30358dF71B", "location": "Broker", "view": null, "status": "complete", "app": "consequat eu fugiat minim ullamco", "name": "laborum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/qWVB/~0/wlQqjamb/e26R,j1NQ/l-33TJg/FLF2EhrJV/Sftdsem7v" }, { "type": "encryption", "pointer": "/bNQtc4h/KNGH-/~0/~1" }, { "type": "encryption", "pointer": "/~1/n7dG/~1/~1/GkiciZ" } ] }, "last_updated": "1985-11-26T09:06:19.741Z", "encodingVersion": 1, "job": { "_id": "447914d11afdb9adc1115456", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "eaa4d0663da1c1571b1e933a", { "_id": "3d754fb3e33c198644fe114c", "provenance": "adipisicing", "name": "id ipsum exercitation irure", "description": "sit", "memberOf": [ { "groupId": "cf86d284e246d4efcc86c93e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo" }, { "roleId": "aute" } ], "inactive": true, "_meta": { "created": "1946-12-09T01:57:41.152Z", "updated": "1997-03-26T18:17:17.301Z", "migrationVersion": 74389159 } }, "868049d14fadda7e327f88cf" ], "type": "manual", "metrics": { "start_time": "anim", "claim_time": "2010-03-08T07:58:37.675Z", "end_time": 69421886.6950632, "server_id": "aliqua", "finish_state": "success", "run_time": 19005216.51295106, "user": { "_id": "9a05efcd0a6c699ebd30d52b", "provenance": "dolor veniam", "username": "eiusmod", "firstname": "sit exercitation", "memberOf": [ { "groupId": "57835bf2c529a58ee23113f7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim consequat" }, { "roleId": "Excepteur" }, { "roleId": "minim ut consectetur" }, { "roleId": "nulla in" }, { "roleId": "id Excepteur" } ], "inactive": false, "lastLogin": "1993-01-20T03:48:27.525Z", "_meta": { "created": "1994-08-15T06:04:58.054Z", "updated": "2025-08-06T20:35:48.828Z", "migrationVersion": 91907706 }, "email": "aliquip adipisicing" }, "owner": "" } }, { "_id": "cadaF74d-1c7d-36d6-BfE6-0eCdf7b93e7a", "location": "Adapter", "view": "minim Excepteur irure aliquip consectetur", "status": "error", "app": "enim et ea", "name": "in officia Excepteur laboris sit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/IUQVYE6luFd" }, { "type": "encryption", "pointer": "/~0/~0/zWS+dRyW9S/MGFclUF/~0/~0/i0xM/tMYlG/~0" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/To0y/" }, { "type": "encryption", "pointer": "/gIWShvM4/~1/pZD/mD2nGMtLNC7/wrPxSbMk./~0/~0" } ] }, "last_updated": "1976-04-16T09:07:10.665Z", "encodingVersion": 1, "job": { "_id": "fdaaac4dca094957d0619cfe", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "fe54c64fc967539c5a765fca", "provenance": "eiusmod elit", "name": "minim commodo", "description": "pariatur commodo Lorem minim qui", "memberOf": [ { "groupId": "e89f339bbd4758f0e625c2d0", "aaaManaged": false }, { "groupId": "a8b7acb98b7600ec6e68c14e", "aaaManaged": false }, { "groupId": "3a86df4149b61ddff6834923", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est" }, { "roleId": "dolor consequat deserunt adipisicing" } ], "inactive": true, "_meta": { "created": "1997-10-26T10:17:06.229Z", "updated": "1989-10-21T21:55:53.189Z", "migrationVersion": 20855253 } }, { "_id": "a465dcb9409d90ae93e300c2", "provenance": "ea magna non dolore dolore", "name": "Duis aute", "description": "aute reprehenderit Lorem ullamco", "memberOf": [ { "groupId": "90598ccaa0ce2df29ead2def", "aaaManaged": true }, { "groupId": "e45dca9d8c1a4c9bae97f3bb", "aaaManaged": true }, { "groupId": "5ca549f56855580a2e734955", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est" }, { "roleId": "non consectetur" }, { "roleId": "et reprehenderit nulla id" }, { "roleId": "commodo" } ], "inactive": false, "_meta": { "created": "1972-06-05T11:13:36.025Z", "updated": "2002-09-08T11:58:12.767Z", "migrationVersion": 81257058 } }, { "_id": "67f18d3f410edb078cb7c3c7", "provenance": "est voluptate", "name": "veniam cillum consequat sit", "description": "dolor", "memberOf": [ { "groupId": "9dbd567a0571b0b0bffe4047", "aaaManaged": false }, { "groupId": "9ac30a7b6d2fc9873c4cd99f", "aaaManaged": false }, { "groupId": "2935e8301de5fb76507c7246", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip non" }, { "roleId": "ut" }, { "roleId": "tempor ut consequat" } ], "inactive": true, "_meta": { "created": "1966-04-16T17:13:05.835Z", "updated": "1961-05-01T23:54:00.016Z", "migrationVersion": 92286630 } }, "02d25d5cda5b0548e3ad72ef" ], "type": "manual", "metrics": { "start_time": "ut proident in Excepteur", "claim_time": "2006-11-07T09:29:54.348Z", "end_time": -46759578.61130384, "server_id": "velit ut exercitation reprehenderit", "finish_state": "success", "run_time": 14338443.114333317, "user": "fdf01c299e402248aa0f2cdc", "owner": { "_id": "84f6879c397a43c1d845d752", "provenance": "nisi", "username": "ullamco commodo", "firstname": "elit culpa pariatur", "memberOf": [ { "groupId": "bf786a8096d8606613b6ec74", "aaaManaged": true }, { "groupId": "9de494d9850ef0aea98af64e", "aaaManaged": false }, { "groupId": "a5275494b69940287deda7ac", "aaaManaged": false }, { "groupId": "543a17e0dd41766bd6aab280", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut nisi Lorem ipsum" }, { "roleId": "ex enim dolore in magna" }, { "roleId": "Ut" }, { "roleId": "magna qui minim" }, { "roleId": "fugiat dolor pariatur sunt" } ], "inactive": true, "lastLogin": "1963-02-16T13:40:35.058Z", "_meta": { "created": "2012-05-04T15:08:54.549Z", "updated": "1990-08-21T21:38:55.14Z", "migrationVersion": 12907905 }, "email": "adipisicing esse fugiat officia magna" } } }, { "_id": "971fDCdE-23c5-Bf94-Eb47-2aD5CcADDdA2", "location": "Application", "view": "in", "status": "complete", "app": "consectetur dolore", "name": "culpa incididunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/wi/~0/bLQ-SakODn/~0/~1/aWzYD/~1" }, { "type": "encryption", "pointer": "/xollEjhKfw9/~0/K1rDgUe4/~0/~1/~0/JOa5/~0" }, { "type": "encryption", "pointer": "/~0/L/qh/~1" }, { "type": "encryption", "pointer": "/zn4G/~0/~0/TZ/~0/CgYPj/rG/~0" }, { "type": "encryption", "pointer": "/FNMu/~1/~1/~0/Z8nXkYK5V" } ] }, "last_updated": "1972-07-17T00:04:01.452Z", "encodingVersion": 1, "job": { "_id": "d1fae88b98bdea377c4b14a8", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "d46d336111349a099149351d", "7326fd5328baff93b45110a0", "269e893c101e20ac09141bb4", "4deb95b6d36637f00c1c096d" ] }, "groups": [ "f9eee46d5f19ab436a316738", { "_id": "e7379406c77a557382728bfb", "provenance": "commodo", "name": "Lorem", "description": "reprehenderit eu", "memberOf": [ { "groupId": "8a2fe974f9f05594cca2edae", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum dolor" } ], "inactive": true, "_meta": { "created": "1970-09-17T05:40:00.454Z", "updated": "1969-12-12T22:01:36.022Z", "migrationVersion": -70748636 } }, "7ac6a1329b417f4b61cdc380", "2fbe0d7cbaeb8d9058ba4a49", "415acc50894ecb31a4c4ae2c" ], "type": "manual", "metrics": { "start_time": "laboris labore tempor anim", "claim_time": "1960-02-04T06:54:23.414Z", "end_time": 24468407.556150496, "server_id": "eiusmod pariatur ut aliqua cillum", "finish_state": "paused", "run_time": 92198743.14482725, "user": "f11ff7149373d038241dd947", "owner": "120bf02d37209ee5c2b76439" } } ], "metadata": { "skip": -14280533, "limit": 87485480, "total": 79152451, "nextPageSkip": null, "previousPageSkip": -44221336, "currentPageSize": 78194529 } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "task-api" } }, "metadata": { "$ref": "common-api#/definitions/pagination-metadata" } } } ] }