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": 10, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "nostrud dolore velit mollit", "not-in": "sint nisi", "equals": "minim", "contains": "irure consectetur ad occaecat Duis", "starts-with": "sed Duis", "ends-with": "voluptate occaecat aliquip dolor", "dereference": "sit deserunt incididunt labore in", "gt": "sed Duis anim", "gte": "in dolor", "lt": "id qui", "lte": "quis in deserunt est", "q": "eu cillum cupidatat", "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": "D2222e1c-52C6-fa9F-aED0-81c38cF9ed51", "location": "Broker", "view": "pariatur est", "status": "running", "app": "Ut in ad in esse", "name": "dolore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/A/oXui/~1/nkG-cd/~0/xjyVj," } ] }, "last_updated": "1983-05-18T04:14:26.219Z", "encodingVersion": 1, "job": { "_id": "abae4221205a37f91cf5ce5b", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "762e7c9827c758bfbbfcdfe7", "5a0c3a7c5c820cede8e84968", "33857e04bbb61aa83478313e", "949a3233d609c967142e26b4" ] }, "incomingRefs": [], "groups": [ "cc0f32732843a2c4708118db", { "_id": "cf195703a3e6dfe5862e7ad1", "provenance": "deserunt proident commodo aliquip irure", "name": "ad sint ipsum", "description": "sed", "memberOf": [ { "groupId": "98191a0f64111ca77ce8c9b3", "aaaManaged": false }, { "groupId": "3c006d8711cd5e7ef47e35b3", "aaaManaged": true }, { "groupId": "a2491307181abb0d54c7917c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa elit fugiat" }, { "roleId": "ut est" } ], "inactive": true, "_meta": { "created": "1981-02-15T22:32:53.81Z", "updated": "1967-09-04T07:59:07.968Z", "migrationVersion": -45385906 } }, "13ad94855295403503bbe2c5", "e034f8de7713ee72dc97eb61" ], "type": "manual", "metrics": { "start_time": "fugiat dolore Excepteur", "claim_time": "2011-10-15T07:09:37.848Z", "end_time": -24256769.973788068, "server_id": "eu eiusmod ea non Excepteur", "finish_state": "failure", "run_time": -11901436.462213606, "user": { "_id": "53164dd002c438782ebb159b", "provenance": "labore do", "username": "eiusmod aute sint cupidatat", "firstname": "do dolor veniam eu", "memberOf": [ { "groupId": "79e2ed33bb83247c459611af", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in" } ], "inactive": false, "lastLogin": "2000-01-05T06:02:18.731Z", "_meta": { "created": "2016-07-25T06:32:39.557Z", "updated": "1973-07-17T08:50:41.177Z", "migrationVersion": -85445370 }, "email": "culpa Ut" }, "owner": { "_id": "f8c659301c269393dff21f5f", "provenance": "aliqua sit", "username": "adipisicing eiusmod", "firstname": "consequat velit", "memberOf": [ { "groupId": "57d41969a680ce59103d9de2", "aaaManaged": true }, { "groupId": "10e8b0790ed63e0465985a38", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "magna dolore" }, { "roleId": "est elit" }, { "roleId": "nulla ea non anim" }, { "roleId": "Duis tempor magna enim dolor" }, { "roleId": "deserunt eu sint minim ea" } ], "inactive": false, "lastLogin": "1993-05-27T10:01:59.1Z", "_meta": { "created": "1961-07-11T06:38:40.737Z", "updated": "1991-06-27T01:41:33.969Z", "migrationVersion": 42461967 }, "email": "adipisicing" } } }, { "_id": "A0d57bFA-Bbdc-5Ecf-48F8-fa153eEDb7E1", "location": "Application", "view": "occaecat consequat", "status": "scheduled", "app": "nisi proident in", "name": "est elit pariatur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/pHF/~1/~1/XodoEAF,/~0/~0/ra-SH/~0" } ] }, "last_updated": "1972-08-26T10:40:49.472Z", "encodingVersion": 1, "job": { "_id": "195b56e88243a53839bfbfe6", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "f47acddc238071e08b8d19f6", "provenance": "irure", "name": "reprehenderit dolore", "description": "aute", "memberOf": [ { "groupId": "83f6c5ceb3eb9b9b869bae77", "aaaManaged": true }, { "groupId": "b40b293f1acaa7b4b9228457", "aaaManaged": false }, { "groupId": "201631d7dec65d9989d8f45c", "aaaManaged": true }, { "groupId": "c8bd8d1f824bedfda10d9b9f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore" }, { "roleId": "nostrud consequat" }, { "roleId": "enim" }, { "roleId": "laboris est elit" }, { "roleId": "fugiat" } ], "inactive": false, "_meta": { "created": "1949-11-03T08:18:35.183Z", "updated": "1994-09-16T22:58:51.587Z", "migrationVersion": -17420577 } }, "c0411e7f253bd6b41403c2d3" ], "type": "manual", "metrics": { "start_time": "dolor fugiat eiusmod adipisicing", "claim_time": "1953-12-31T06:01:32.457Z", "end_time": 44026666.64177707, "server_id": "nisi anim voluptate", "finish_state": "incomplete", "run_time": -91528403.2697162, "user": { "_id": "4438011837de3a931ae183f9", "provenance": "do dolor qui ipsum", "username": "mollit ut elit esse", "firstname": "dolor esse irure fugiat Duis", "memberOf": [ { "groupId": "d4c8794765620248a0d4c6c3", "aaaManaged": false }, { "groupId": "f47fb98d813cce6b0912cb24", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore" }, { "roleId": "nostrud proident fugiat sunt elit" }, { "roleId": "minim ut aliqua Excepteur Ut" } ], "inactive": true, "lastLogin": "2013-05-19T14:18:23.759Z", "_meta": { "created": "1994-04-30T20:55:05.167Z", "updated": "2001-05-20T16:45:57.127Z", "migrationVersion": -94972752 }, "email": "est sit et commodo" }, "owner": { "_id": "a5ae3df9b8b45197eb45c53a", "provenance": "minim nulla non", "username": "laborum sunt", "firstname": "anim esse exercitation", "memberOf": [ { "groupId": "88099158adc03d33012fc190", "aaaManaged": true }, { "groupId": "c85a16722725efd5f2fa605b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur pariatur esse ad" }, { "roleId": "tempor ea fugiat" } ], "inactive": false, "lastLogin": "1974-03-07T02:03:02.585Z", "_meta": { "created": "1959-12-09T06:49:28.492Z", "updated": "2015-05-02T02:10:13.629Z", "migrationVersion": 62461198 }, "email": "in ad cupidatat labore" } } } ], "metadata": { "skip": -22042608, "limit": -5806871, "total": 38943302, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 47717336 } }
{ "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" } } } ] }