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": 25, "skip": 1, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": "culpa nisi id tempor", "not-in": "in proident non ad exercitation", "equals": "reprehenderit Duis minim", "contains": "enim", "starts-with": "nisi officia irure sit esse", "ends-with": "officia aliquip", "dereference": "commodo", "gt": "consectetur est aute", "gte": "Ut Excepteur veniam", "lt": "culpa eiusmod aliquip ullamco", "lte": "voluptate consequat", "q": "elit enim commodo voluptate", "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 created the requested item", "data": [ { "_id": "650ABA5e-1fa9-ABD1-cCEb-2a95e82dB758", "location": "Application", "view": null, "status": "canceled", "app": "pariatur", "name": "ea aute", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/el5U0i/Z86ESGcT/F,QyrxB/o,iXbm7R7/IPHet" }, { "type": "encryption", "pointer": "/~1/~1/~0/Ac,/p0hhqxpM/~1/ZNj7" }, { "type": "encryption", "pointer": "/~1/f4gf6Tm/v19E/klFX,AZv4/~0" } ] }, "last_updated": "1977-07-07T00:21:27.138Z", "encodingVersion": 1, "job": { "_id": "1d75502a6f3c5415c09890f8", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "ed784bee4fec4ba3a13ae0a3", "f593f8ada32cf8e9c14d58c8", "2d8f23faf647a48d7be9d3e1", { "_id": "82cc505ad6e959527cc2f4fe", "provenance": "eiusmod irure", "name": "mollit", "description": "dolore dolor do in labore", "memberOf": [ { "groupId": "c4a920eb3e4f66f785afa973", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur ut amet" }, { "roleId": "anim nostrud tempor magna" }, { "roleId": "et officia" } ], "inactive": true, "_meta": { "created": "1947-02-06T16:58:21.856Z", "updated": "1955-04-02T23:05:53.624Z", "migrationVersion": -54057476 } } ], "type": "manual", "metrics": { "start_time": "magna in pariatur sunt", "claim_time": "1960-04-30T18:36:59.103Z", "end_time": 34708837.13702023, "server_id": "aliqua", "finish_state": "paused", "run_time": 40093509.747876346, "user": "Pronghorn", "owner": "" } }, { "_id": "7cde5592-AD5d-b53E-B827-bBd1ACe479D9", "location": "Application", "view": "in nostrud sint aute", "status": "incomplete", "app": "do consequat exercitation qui aliqua", "name": "eu ad sed ea", "variables": { "decorators": [ { "type": "encryption", "pointer": "/I,ZD/XePMyzG,3/u,jaX/~0" } ] }, "last_updated": "1968-09-26T10:06:52.952Z", "encodingVersion": 1, "job": { "_id": "13abbd63ffc6756928d3d63e", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "062c842628a9645ad9433564", "provenance": "commodo sunt", "name": "esse", "description": "in labore", "memberOf": [ { "groupId": "6c8acd4b847c46fdbc436272", "aaaManaged": false }, { "groupId": "5e25c74249074dea11bab927", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi labore aliqua" }, { "roleId": "aliqua est" }, { "roleId": "culpa officia proident" } ], "inactive": false, "_meta": { "created": "2018-02-23T15:46:07.588Z", "updated": "1965-10-03T16:31:01.103Z", "migrationVersion": -57277657 } }, { "_id": "9b08c36e0c88eb90f9caab53", "provenance": "quis id magna sed nulla", "name": "officia elit dolore", "description": "ut", "memberOf": [ { "groupId": "edbe18e32adf7c60530a7a68", "aaaManaged": false }, { "groupId": "0d38060b302b2d9488cb2e33", "aaaManaged": false }, { "groupId": "f726f70f3f31b3b7cafd3a93", "aaaManaged": false }, { "groupId": "40ce451b6c8c84078ac3cdc8", "aaaManaged": false }, { "groupId": "76f6c67456f65dd453ee9be6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore eiusmod eu" }, { "roleId": "occaecat" }, { "roleId": "dolore commodo et" }, { "roleId": "cillum" }, { "roleId": "eu quis fugiat reprehenderit" } ], "inactive": true, "_meta": { "created": "1986-03-12T07:26:24.798Z", "updated": "1946-05-10T09:42:44.599Z", "migrationVersion": 48456437 } }, { "_id": "e42dabaed9f24fde3838dae0", "provenance": "ullamco enim in cillum", "name": "cupidatat incididunt", "description": "sed", "memberOf": [ { "groupId": "1ea647e78fa69e52a47264d8", "aaaManaged": true }, { "groupId": "987b7c8b9e24f10a98d2027f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem mollit fugiat nisi ut" } ], "inactive": false, "_meta": { "created": "1974-01-25T21:36:23.948Z", "updated": "1973-01-16T21:11:47.763Z", "migrationVersion": -67961165 } }, { "_id": "24a8b4c9768112f1315d7e49", "provenance": "pariatur", "name": "sunt proident ex elit", "description": "anim est sed nisi irure", "memberOf": [ { "groupId": "0b17c67367f1db8b0a077e93", "aaaManaged": true }, { "groupId": "6a3619c6078b6e194370a172", "aaaManaged": false }, { "groupId": "5f98b8ae6883482ee103beb3", "aaaManaged": true }, { "groupId": "fbef8abea6b03a2709a0f97f", "aaaManaged": true }, { "groupId": "37ef5cff276d6c7c2cb820c4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum commodo esse" }, { "roleId": "in" } ], "inactive": false, "_meta": { "created": "1956-12-29T05:19:09.79Z", "updated": "1947-01-19T07:31:58.869Z", "migrationVersion": 228635 } } ], "type": "manual", "metrics": { "start_time": "et anim dolore deserunt", "claim_time": "1964-09-03T01:39:52.137Z", "end_time": 62216221.691033304, "server_id": "labore ex esse mollit", "finish_state": "success", "run_time": 92640984.57815611, "user": "ade53cb7525bd25f75c38933", "owner": "457bf4c1d7069660f60b6a16" } }, { "_id": "E73189AA-9dd6-B048-D735-5E7C012DAec7", "location": "Adapter", "view": "dolore", "status": "paused", "app": "cupidatat Excepteur", "name": "qui", "variables": { "decorators": [ { "type": "encryption", "pointer": "/IN./tpmZbJpI./v9BrYafLPt/~1/~0/~1/~1" }, { "type": "encryption", "pointer": "/~0/D8/osRUl/SliteoJo/~0/DSsG/vkPcRaDNv/mU5IMV4iW/~1/F/d2tJ" } ] }, "last_updated": "2021-05-07T19:55:28.284Z", "encodingVersion": 1, "job": { "_id": "a059f9b1fb635ca4469db250", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "8653231e79a793e0e9967fdd", "dd4192dda5d99f45cbab0d81" ] }, "incomingRefs": [], "groups": [ { "_id": "c88d64c6096976778c6b323e", "provenance": "sed", "name": "Excepteur velit et commodo mollit", "description": "qui exercitation", "memberOf": [ { "groupId": "62f69bce1e4a490a68e2a3be", "aaaManaged": true }, { "groupId": "a72ec3f87691ab98b6c3197d", "aaaManaged": true }, { "groupId": "5e43fcbcc8ce9adb9b7638d1", "aaaManaged": true }, { "groupId": "8892d67a34a0e4895d4a8a41", "aaaManaged": true }, { "groupId": "2fb5528cc02670d91c7233bd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet nostrud" }, { "roleId": "irure esse minim sunt nisi" }, { "roleId": "aliquip ex deserunt" }, { "roleId": "eiusmod cupidatat proident" }, { "roleId": "commodo qui sit ad adipisicing" } ], "inactive": false, "_meta": { "created": "1965-01-10T16:55:17.108Z", "updated": "1983-07-22T12:56:49.063Z", "migrationVersion": -19742295 } }, { "_id": "cb110b786022bf30390dabd4", "provenance": "pariatur quis dolor reprehenderit", "name": "aute adipisicing", "description": "labore amet aute", "memberOf": [ { "groupId": "ce7ab5459d2b8c253cce09e6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore occaecat qui quis" }, { "roleId": "Lorem anim commodo laborum pariatur" }, { "roleId": "consequat ad mollit esse" }, { "roleId": "laboris in reprehenderit" } ], "inactive": true, "_meta": { "created": "1986-05-15T05:07:12.001Z", "updated": "1982-05-30T00:59:27.977Z", "migrationVersion": 86585501 } }, "8dd38545a542356cf14964d5", "fe73b226c29d6e7ecb929a00" ], "type": "manual", "metrics": { "start_time": "labore", "claim_time": "2009-07-30T01:01:11.211Z", "end_time": -63413683.075979054, "server_id": "sint est Duis", "finish_state": "canceled", "run_time": 9862610.36097011, "user": { "_id": "61ac0330172e3c8517ffc2fb", "provenance": "Excepteur", "username": "ea aliqua ex", "firstname": "sed Duis pariatur ex amet", "memberOf": [ { "groupId": "ddf60fb4029b063b8f435eb1", "aaaManaged": false }, { "groupId": "31b5aa1dc36b5534656eb4fe", "aaaManaged": false }, { "groupId": "9b1f68303ad10cd790497520", "aaaManaged": false }, { "groupId": "f77e6b873b71bbc6b90a39ab", "aaaManaged": true }, { "groupId": "81592614333b6b072d13657b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt elit" }, { "roleId": "occaecat dolor culpa reprehenderit" }, { "roleId": "ut magna anim" }, { "roleId": "sunt enim est officia" }, { "roleId": "in ullamco" } ], "inactive": true, "lastLogin": "2005-11-07T13:57:28.651Z", "_meta": { "created": "1959-09-04T15:33:32.902Z", "updated": "1971-10-05T15:35:44.496Z", "migrationVersion": -42144532 }, "email": "dolore velit occaecat voluptate" }, "owner": "Pronghorn" } } ], "metadata": { "skip": 20401535, "limit": 17595321, "total": 47531407, "nextPageSkip": -12752820, "previousPageSkip": 30347636, "currentPageSize": 8629441 } }
{ "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" } } } ] }