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,description", "exclude": "description", "in": "minim cupidatat", "not-in": "adipisicing quis dolore labore", "equals": "occaecat aliqua incididunt nostrud proident", "contains": "nulla officia consequat", "starts-with": "incididunt ex et", "ends-with": "id elit fugiat Duis", "dereference": "elit nulla deserunt fugiat ea", "gt": "culpa Duis sunt ex", "gte": "sed dolore", "lt": "exercitation sunt laborum amet", "lte": "ipsum", "q": "in dolor anim ipsum ullamco", "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": "8FBF41cC-3dCb-94CB-Cf9F-D7e4Af0b81dF", "location": "Application", "view": "aliquip", "status": "running", "app": "in reprehenderit", "name": "laboris nostrud occaecat cillum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/lxhBk1WLpv/~0/GVT6/~0/n,JYrSMFZ-/~0/i9z46sPTJ/~1" } ] }, "last_updated": "1961-10-30T20:51:29.311Z", "encodingVersion": 1, "job": { "_id": "6978921b16a8b68f65079ecb", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "91cb6003dcb675b3e2c7a292", "provenance": "ullamco id", "name": "in", "description": "enim est sed aute aliqua", "memberOf": [ { "groupId": "07bc558fb041394744510973", "aaaManaged": true }, { "groupId": "0fe586a8dffea6bf0935298b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat" }, { "roleId": "est qui" }, { "roleId": "ullamco voluptate" }, { "roleId": "officia velit eiusmod incididunt enim" }, { "roleId": "est ut aliqua ad sint" } ], "inactive": true, "_meta": { "created": "1947-08-31T10:34:49.89Z", "updated": "2003-10-11T15:10:51.744Z", "migrationVersion": -90517433 } }, { "_id": "e0099f122e9fca8dfa71b028", "provenance": "aliqua in amet", "name": "laboris fugiat Duis", "description": "id magna elit", "memberOf": [ { "groupId": "c97986ec4ee923abfefe4d43", "aaaManaged": false }, { "groupId": "8f21b7b04924c3ec0dcbabd3", "aaaManaged": false }, { "groupId": "b4df9764e5c6e89db3eda35a", "aaaManaged": false }, { "groupId": "9c0316ba69d5a92571a442de", "aaaManaged": false }, { "groupId": "37de98f32487600b850caf03", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris" }, { "roleId": "Excepteur consequat esse non" }, { "roleId": "incididunt laborum velit" }, { "roleId": "non elit in veniam reprehenderit" }, { "roleId": "dolor" } ], "inactive": true, "_meta": { "created": "2002-08-08T20:23:58.167Z", "updated": "2003-03-31T03:48:25.684Z", "migrationVersion": -4956354 } }, "449ffa44ed75e654d7753925" ], "type": "operation", "metrics": { "start_time": "quis nulla nostrud ut proident", "end_time": 78215126.40003157, "server_id": "in exercitation", "finish_state": "running", "run_time": -68936120.96671866, "retrying": true, "user": "c2903e3de6d3c0e170c08a19", "owner": "" } }, { "_id": "6E117e5e-5674-561F-0d68-E9AeDeA2e207", "location": "Broker", "view": null, "status": "incomplete", "app": "reprehenderit", "name": "deserunt aliquip anim veniam sint", "variables": { "decorators": [ { "type": "encryption", "pointer": "/vAR.XYY/EyE/z/4O.qBGev3/~1/~1/~0/~1/X4eaD5H0fHF/~0/ql1kEX/zbTf,,,-IjG" }, { "type": "encryption", "pointer": "/~0/~1/~1/~1" } ] }, "last_updated": "2006-11-01T01:39:56.702Z", "encodingVersion": 1, "job": { "_id": "d43e60672c65e1836c1835bd", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "693dd0551988347f43c3a9ea", "af36cd3d267df351ec2908a2", "783de8158afda2bcf73ccb56" ] }, "incomingRefs": [], "groups": [ { "_id": "7409a9328248786043e98b27", "provenance": "dolore ut", "name": "sed amet id mollit", "description": "consequat in veniam tempor", "memberOf": [ { "groupId": "eb1d3211bb2faa51ec97c29b", "aaaManaged": false }, { "groupId": "c6505f3781649497723dbab7", "aaaManaged": false }, { "groupId": "5a0d303e877d661ab4ee94fe", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in magna labore" } ], "inactive": true, "_meta": { "created": "1994-11-15T01:08:19.31Z", "updated": "1963-06-13T02:26:02.867Z", "migrationVersion": 38081791 } }, { "_id": "063426cc07099f11c4492f8e", "provenance": "laborum enim in", "name": "qui est", "description": "dolor commodo cillum amet", "memberOf": [ { "groupId": "c22524b131434eb9bc9c5297", "aaaManaged": false }, { "groupId": "602f0864f69b3e552ad254d2", "aaaManaged": false }, { "groupId": "8874598fe56344afd1b97841", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi id enim in" }, { "roleId": "non incididunt cupidatat" }, { "roleId": "nulla nisi in" } ], "inactive": false, "_meta": { "created": "1993-11-20T10:22:31.773Z", "updated": "1980-11-15T03:56:02.518Z", "migrationVersion": 10927901 } }, { "_id": "bea640efa6216bbba26a4f7b", "provenance": "enim", "name": "pariatur incididunt", "description": "pariatur est id in", "memberOf": [ { "groupId": "4b301d7f67772e80d1b04cb5", "aaaManaged": true }, { "groupId": "40ac18062705b34ae2f7aa92", "aaaManaged": false }, { "groupId": "ba142f46ce4bc73c64effbd0", "aaaManaged": true }, { "groupId": "70abe6f686f2c17c87dd52ce", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse est in ad consectetur" }, { "roleId": "commodo veniam ut" }, { "roleId": "aliqua laborum dolor sint" } ], "inactive": false, "_meta": { "created": "2008-01-24T14:30:00.809Z", "updated": "1980-07-30T02:06:36.969Z", "migrationVersion": -33209658 } } ], "type": "operation", "metrics": { "start_time": "laborum", "end_time": -56357185.909503385, "server_id": "anim pariatur exercitation", "finish_state": "running", "run_time": 77083731.45135671, "retrying": true, "user": { "_id": "e65b9aad08d921b6cb03078e", "provenance": "quis commodo", "username": "minim ex", "firstname": "cupidatat et", "memberOf": [ { "groupId": "6aab42a3d1142ad111f3a5af", "aaaManaged": true }, { "groupId": "f5e298a4b0e845ce0e4b521f", "aaaManaged": false }, { "groupId": "a48760d195efc86eb2041f78", "aaaManaged": false }, { "groupId": "1986be5541cabb1f5ddae822", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt" }, { "roleId": "ipsum" }, { "roleId": "Lorem" } ], "inactive": false, "lastLogin": "1978-03-02T04:39:42.119Z", "_meta": { "created": "1972-05-07T21:31:24.102Z", "updated": "1979-06-25T09:13:56.094Z", "migrationVersion": -31277146 }, "email": "consectetur culpa id reprehenderit ea" }, "owner": "" } } ], "metadata": { "skip": -54629707, "limit": 99274647, "total": -54743219, "nextPageSkip": 13080608, "previousPageSkip": -63394258, "currentPageSize": -81403669 } }
{ "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" } } } ] }