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": 50, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "velit", "not-in": "adipisicing eiusmod veniam non", "equals": "incididunt", "contains": "cillum aute adipisicing dolor", "starts-with": "Lorem culpa reprehenderit minim dolor", "ends-with": "dolor nisi sint aliqua in", "dereference": "qui non elit eu", "gt": "fugiat", "gte": "magna qui id ea dolor", "lt": "nisi elit eu", "lte": "ut pariatur ut", "q": "exercitation", "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": "d8f354f8-E318-F2ED-F9Cf-4BEdF037Bf37", "location": "Application", "view": null, "status": "error", "app": "qui ut exercitation nostrud non", "name": "sunt eiusmod", "variables": { "decorators": [ { "type": "encryption", "pointer": "/y/~0/R28/3WXi+/zXA152VJpo/~0/~1/~0/Xou49/~0/N/~1" } ] }, "last_updated": "1995-02-25T16:36:36.383Z", "encodingVersion": 1, "job": { "_id": "4a3756fa3e72236c061d7ee8", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "ddbe27ca26ef478c8033231d", { "_id": "ff29184787212842ce05dfc3", "provenance": "magna et sed", "name": "nisi Excepteur cillum nostrud", "description": "in dolore ad non ut", "memberOf": [ { "groupId": "31a8b3264c74c908235713ac", "aaaManaged": true }, { "groupId": "0393e216d29da0a93d0281db", "aaaManaged": true }, { "groupId": "1c04df1b047faa6a0efd857c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation sunt laboris" }, { "roleId": "Ut do Excepteur dolore sit" } ], "inactive": false, "_meta": { "created": "1994-04-12T15:55:20.905Z", "updated": "2010-01-31T20:40:59.495Z", "migrationVersion": -37517059 } }, "82ad7dcd0ac442dfb3137efe" ], "type": "operation", "metrics": { "start_time": "ipsum reprehenderit ea labore elit", "end_time": -29478307.761712015, "server_id": "proident et", "finish_state": "success", "run_time": 26830854.77232398, "retrying": false, "user": "820cd320ae3d01a9e7667ff5", "owner": { "_id": "334e1cc85f672d0fb27c2ffb", "provenance": "et dolore id", "username": "nulla magna", "firstname": "Duis fugiat non laboris", "memberOf": [ { "groupId": "2918b016f3649cb0cb975193", "aaaManaged": true }, { "groupId": "cdc9bf2722991e396f950078", "aaaManaged": false }, { "groupId": "a2f4cfceaf999cd928ff9d95", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" } ], "inactive": true, "lastLogin": "2003-01-05T03:49:45.707Z", "_meta": { "created": "1961-02-21T05:18:07.566Z", "updated": "1990-05-23T17:42:31.869Z", "migrationVersion": 95776747 }, "email": "consectetur voluptate sed nulla" } } }, { "_id": "A6ed99Ae-6a6A-bCCe-b2df-B14b10dEEEeC", "location": "Application", "view": "nostrud est", "status": "scheduled", "app": "do id ex amet nisi", "name": "et do", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/~1/~1/WM.7B.4/nIDFt/I/~0/~1/i+De2IpEJqs" }, { "type": "encryption", "pointer": "/~1/M0GI7,x58P" }, { "type": "encryption", "pointer": "/~1/n+7/Rv/FdfI657Q/cz1G0TE" } ] }, "last_updated": "1985-07-23T02:20:51.442Z", "encodingVersion": 1, "job": { "_id": "26957aca60ef57cc7dcac486", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "de82adc5b9d8e4dc06cf682e", "provenance": "incididunt", "name": "aute", "description": "deserunt consequat eiusmod ex proident", "memberOf": [ { "groupId": "258981d5c0aa9067262476af", "aaaManaged": true }, { "groupId": "ba31b23a188691014946aa88", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt" }, { "roleId": "ullamco cupidatat" }, { "roleId": "veniam enim magna nulla aute" } ], "inactive": true, "_meta": { "created": "1962-07-06T05:29:12.205Z", "updated": "1950-03-22T05:55:18.818Z", "migrationVersion": -2085941 } } ], "type": "operation", "metrics": { "start_time": "dolor aliquip ullamco nisi Excepteur", "end_time": 52216322.519031554, "server_id": "elit", "finish_state": "complete", "run_time": 7742201.559594169, "retrying": true, "user": { "_id": "03b43ff4da97982eb134ea21", "provenance": "officia in labore", "username": "dolore irure in Duis", "firstname": "veniam esse nostrud", "memberOf": [ { "groupId": "a2f259cbd87a512822af2afc", "aaaManaged": true }, { "groupId": "f4e52a03bf9b715a0fc40650", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea aliquip" }, { "roleId": "tempor eu ut eiusmod Excepteur" }, { "roleId": "nulla nostrud in sint" }, { "roleId": "aliqua fugiat sed ex Lorem" } ], "inactive": false, "lastLogin": "1959-01-13T05:07:15.29Z", "_meta": { "created": "1950-09-06T13:51:50.255Z", "updated": "2022-05-15T15:37:03.984Z", "migrationVersion": 2337734 }, "email": "minim cupidatat" }, "owner": "" } }, { "_id": "EB4Dcf58-49c4-938c-DCEe-B85CD3BCe1Ad", "location": "Adapter", "view": null, "status": "canceled", "app": "non", "name": "officia dolor dolore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1" }, { "type": "encryption", "pointer": "/A9dGvd..f" }, { "type": "encryption", "pointer": "/IyU269/ST/~0" }, { "type": "encryption", "pointer": "/~0/o" }, { "type": "encryption", "pointer": "/t/dw1W2i.G/Ya29g/vohC/I8Bi2EZLDkY/w7m/~0/IblvJUIOI/UBH0WL1R6a" } ] }, "last_updated": "1967-11-02T11:36:47.394Z", "encodingVersion": 1, "job": { "_id": "92c925692733c5d4da8862e5", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "70a3a67fb05814c7d0b39e39", "provenance": "et fugiat minim irure", "name": "irure", "description": "ea", "memberOf": [ { "groupId": "4b903a1df6d785ab3c900979", "aaaManaged": true }, { "groupId": "b6f7ee0a7790685179da1999", "aaaManaged": false }, { "groupId": "bdafef7b42efe30d41f4cbed", "aaaManaged": false }, { "groupId": "3140fc3af41a80a7c9b669c4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in enim adipisicing consectetur" } ], "inactive": true, "_meta": { "created": "1962-08-19T00:16:06.293Z", "updated": "1993-07-08T11:18:35.562Z", "migrationVersion": -9150835 } } ], "type": "operation", "metrics": { "start_time": "aute laboris", "end_time": 56022395.34981263, "server_id": "irure minim", "finish_state": "running", "run_time": -62035781.35957861, "retrying": true, "user": "3a964b3df1fc92959b1da360", "owner": "" } }, { "_id": "9f6fD209-285D-073B-4a83-6AFE35fcEBf0", "location": "Application", "view": "irure", "status": "scheduled", "app": "exercitation voluptate proident est", "name": "incididunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/o/d" }, { "type": "encryption", "pointer": "/Fzg/LiK76," } ] }, "last_updated": "1955-04-20T20:38:58.632Z", "encodingVersion": 1, "job": { "_id": "7399fe8ee2945852f948a7db", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "764f30a17b319b60c8a03995", "a5ff74027aca9df257982ea1" ] }, "incomingRefs": [], "groups": [ { "_id": "b0dfeb65029d440fa30ab865", "provenance": "laborum ipsum do aliqua", "name": "in qui velit amet", "description": "officia eu culpa sunt", "memberOf": [ { "groupId": "9da12fd898ae0ff8c6532ed9", "aaaManaged": false }, { "groupId": "60f4e74e1849f14725bb523e", "aaaManaged": false }, { "groupId": "2deb1e18990dfe5b7b7c2f1f", "aaaManaged": false }, { "groupId": "e2fc8852ec946119710b3d5d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor cupidatat adipisicing" }, { "roleId": "Lorem reprehenderit eu exercitation consectetur" }, { "roleId": "amet" }, { "roleId": "id cupidatat ipsum in consequat" }, { "roleId": "sed velit officia sint laborum" } ], "inactive": true, "_meta": { "created": "1960-02-05T16:49:09.733Z", "updated": "1983-02-23T13:21:02.334Z", "migrationVersion": 36625170 } }, "28fb2c67b71e008e87f3db32" ], "type": "operation", "metrics": { "start_time": "in dolor Excepteur ullamco", "end_time": -99009138.57272719, "server_id": "non qui culpa commodo ullamco", "finish_state": "success", "run_time": -36024714.002021074, "retrying": null, "user": { "_id": "e600cc537bacc2265f14fd9b", "provenance": "qui sunt velit esse", "username": "mollit ad", "firstname": "non consequat", "memberOf": [ { "groupId": "d94f48b1ea653fa134b31ce6", "aaaManaged": true }, { "groupId": "cf06ec66fc17c46a4245cd0f", "aaaManaged": false }, { "groupId": "d49ef2a64765f4505cb30a9b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua commodo" }, { "roleId": "in Ut" }, { "roleId": "cillum sunt" }, { "roleId": "do dolore" } ], "inactive": false, "lastLogin": "1996-09-07T02:48:59.695Z", "_meta": { "created": "1987-03-24T13:25:10.701Z", "updated": "2016-04-15T01:13:25.156Z", "migrationVersion": -89118227 }, "email": "quis eu" }, "owner": "063e6a59abef1dd24d9cea0c" } }, { "_id": "c1f455E0-4F58-f08f-69B3-F39d5C81EfbC", "location": "Broker", "view": null, "status": "canceled", "app": "officia ex ullamco in ad", "name": "consectetur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/onB/~0/GO/~1/~0/zpi3mckwESo/~1/ghUjRIjP/d57Q+uj/i+9gCh6pC" }, { "type": "encryption", "pointer": "/nKXg6TC5" }, { "type": "encryption", "pointer": "/mn5FTkTbSG1/B/bpS-mqD82Z/~1/~1/K" }, { "type": "encryption", "pointer": "/X/~1/nka4QWC3/hFE+k2/Rs/zyuOPZG9D/~1/ViYE0" } ] }, "last_updated": "1965-04-24T19:28:15.936Z", "encodingVersion": 1, "job": { "_id": "fd4eb6ef15dfc3a7db2b5178", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "6c65443df48c1fa14378c926", "9e9c493ab633003588021ad8", "989136a175266a69417037c5", "29d5226280317a9676befc9b", "3cbedd11b3c9b086e8b8a70f" ] }, "incomingRefs": [], "groups": [ "d47b77974aad406981613202", "263399a1cf2d5dc3fa8d0ab6", "75de2ef1c972ac5159dc9252", "8fcdcc485c771cc06b876bb7", { "_id": "086788e6f6093c43edc3326b", "provenance": "in quis", "name": "exercitation in deserunt eiusmod cupidatat", "description": "cillum", "memberOf": [ { "groupId": "fe43dd31470bf55c271dba93", "aaaManaged": true }, { "groupId": "2d1d683f93032d25051308d2", "aaaManaged": true }, { "groupId": "47f1aa0b97a1b7382e719a70", "aaaManaged": true }, { "groupId": "40964ab4492e739428072a70", "aaaManaged": true }, { "groupId": "e63c03d4115cfa63364f4efe", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation aliquip Duis et ut" } ], "inactive": false, "_meta": { "created": "1975-05-30T00:15:43.913Z", "updated": "2000-04-19T06:58:10.781Z", "migrationVersion": -7636386 } } ], "type": "operation", "metrics": { "start_time": "tempor et sunt est", "end_time": 70920417.44334656, "server_id": "veniam", "finish_state": "success", "run_time": -75629367.15937427, "retrying": null, "user": "Pronghorn", "owner": "Pronghorn" } } ], "metadata": { "skip": 76476647, "limit": 68482656, "total": -11963257, "nextPageSkip": null, "previousPageSkip": 85583635, "currentPageSize": 30678155 } }
{ "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" } } } ] }