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": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "ad deserunt", "not-in": "do proident ea fugiat", "equals": "nulla", "contains": "pariatur dolore", "starts-with": "quis dolore labore", "ends-with": "nulla", "dereference": "in", "gt": "officia in dolore qui", "gte": "ex adipisicing culpa", "lt": "et minim ullamco", "lte": "sunt et ipsum Duis", "q": "dolor sunt Duis pariatur", "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": "d47F085B-fB60-A1dA-aD8f-e90d773926d6", "location": "Broker", "view": null, "status": "paused", "app": "in esse", "name": "do", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/gKeL+A5U/Ci/ZaRWwJu8yL2/~0/oicXoon" }, { "type": "encryption", "pointer": "/LIqAJF58J/JK/~0/~1/~1" }, { "type": "encryption", "pointer": "/~1/MpyNABZ/H/~1/~1/vGNFD,Wknqg/hcs" }, { "type": "encryption", "pointer": "/~0/p" }, { "type": "encryption", "pointer": "/~1/~0/~1/x/VbnTKZh4" } ] }, "last_updated": "1991-04-06T00:47:22.733Z", "encodingVersion": 1, "job": { "_id": "97fb77433082cd618a5025b1", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "5b8431db9468c4b6e4c682d3", "provenance": "cillum pariatur ea dolore tempor", "name": "nulla", "description": "esse cupidatat", "memberOf": [ { "groupId": "fcd947f9ef1943b58330efd8", "aaaManaged": true }, { "groupId": "ab2ca102ff365c416a1e1c14", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat" }, { "roleId": "ut" } ], "inactive": false, "_meta": { "created": "1958-08-15T19:10:30.972Z", "updated": "1967-04-09T03:19:18.627Z", "migrationVersion": 1526937 } }, "001c460fe76aac392dcd41d1", "b22b85fcadb2f4c82b9a1d35", "04c97b4e8e204400e1808876" ], "type": "operation", "metrics": { "start_time": "commodo ad ut eu", "end_time": -45311159.44601374, "server_id": "eu", "finish_state": "success", "run_time": -97423846.44191752, "retrying": true, "user": { "_id": "051f50f3a07be297413ee714", "provenance": "dolore", "username": "elit qui irure laborum ut", "firstname": "nostrud sed", "memberOf": [ { "groupId": "3c7a85042f0d4c0a0048ec63", "aaaManaged": false }, { "groupId": "d02d76a9a35199f6728e87a2", "aaaManaged": true }, { "groupId": "cf0f030eb748c7407955b0a5", "aaaManaged": false }, { "groupId": "575aa1afbef633986cf3752f", "aaaManaged": false }, { "groupId": "16bb871aa0c72c075aa06ee0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco" }, { "roleId": "sed magna" }, { "roleId": "veniam tempor" }, { "roleId": "aute exercitation eu in" }, { "roleId": "ex ad irure tempor qui" } ], "inactive": true, "lastLogin": "1950-10-31T01:22:44.96Z", "_meta": { "created": "2013-08-16T15:13:38.139Z", "updated": "1988-03-25T20:19:59.31Z", "migrationVersion": 34377351 }, "email": "in ea est" }, "owner": "773a1dcce3ede0f2e95a9435" } }, { "_id": "c3db9596-b7fD-901b-3fE4-cCA170933fFB", "location": "Broker", "view": null, "status": "scheduled", "app": "nulla ex", "name": "esse fugiat commodo", "variables": { "decorators": [ { "type": "encryption", "pointer": "/XH4W/~1/k,K/NrH/~1" } ] }, "last_updated": "1945-09-22T18:28:48.618Z", "encodingVersion": 1, "job": { "_id": "4c6cb3cc2cdc5ba46aa55b28", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "b1587e26a9933fbe912bedff", "30d81dbaaebecf20d52fe135", "b115046a843d598e49439dae" ] }, "groups": [ { "_id": "5040d345a0ac0c297937ef41", "provenance": "dolore ullamco amet", "name": "Excepteur aliquip aute cupidatat consectetur", "description": "ipsum", "memberOf": [ { "groupId": "ca52f7c4c505aef70e04e9cc", "aaaManaged": false }, { "groupId": "adf1c607a3612bc1e936bffe", "aaaManaged": true }, { "groupId": "cf2f85e616c528610d5885a6", "aaaManaged": true }, { "groupId": "7713bdca8d7e942463ed97ca", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea culpa irure ad" }, { "roleId": "culpa Lorem" }, { "roleId": "in exercitation sed" } ], "inactive": true, "_meta": { "created": "2019-06-14T01:25:00.843Z", "updated": "1946-04-30T01:34:41.969Z", "migrationVersion": -79759626 } }, { "_id": "7fdeafad2cff325fecf42677", "provenance": "laborum ut amet", "name": "laboris id", "description": "dolor veniam sit", "memberOf": [ { "groupId": "47657f5b84d98e4dba8a44b7", "aaaManaged": false }, { "groupId": "055b598bb632b52454009ba0", "aaaManaged": true }, { "groupId": "1a570389eec4c2661a74c67d", "aaaManaged": true }, { "groupId": "0307901cff38eee8ec5bb47c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi et ea nulla" }, { "roleId": "proident Excepteur dolore dolor" }, { "roleId": "mollit commodo incididunt culpa" }, { "roleId": "ut pariatur velit occaecat dolore" } ], "inactive": true, "_meta": { "created": "2009-06-29T02:59:14.217Z", "updated": "1990-10-13T19:57:31.157Z", "migrationVersion": 23394481 } }, "58752ece480bbe47f22b741e" ], "type": "operation", "metrics": { "start_time": "Excepteur ea incididunt nulla", "end_time": 67685704.40650049, "server_id": "nisi dolor labore", "finish_state": "success", "run_time": -74486863.15716663, "retrying": true, "user": "d06806a4a78408103e77c484", "owner": "" } }, { "_id": "cbeB9DAf-ca39-feef-B64F-7DbCdbCCd73C", "location": "Adapter", "view": null, "status": "canceled", "app": "ea", "name": "culpa qui", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/HvRmE2/Ta/~0/~1/~0/WN9lxSn4s6m/bJdPk,/QcYgCftz1yh/ASxBg/~1/rRI9F5-I" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/JM/Wjs5X/~1/arRfA/~1/UhInHd" } ] }, "last_updated": "1991-02-05T23:31:30.727Z", "encodingVersion": 1, "job": { "_id": "6990866e1bcedbd4cca56728", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "756f388c75bc534b43c849ec", "provenance": "amet pariatur dolore", "name": "aliquip occaecat irure", "description": "nisi minim", "memberOf": [ { "groupId": "0df515c08dcc6c2e83290b39", "aaaManaged": false }, { "groupId": "a62c9e27d6ba5b001b144016", "aaaManaged": false }, { "groupId": "20692cdbe86e8974f736f5b1", "aaaManaged": true }, { "groupId": "33b51c5a58e947e019a8d318", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea aute" }, { "roleId": "ipsum adipisicing" }, { "roleId": "anim ea in enim" }, { "roleId": "proident in amet" } ], "inactive": false, "_meta": { "created": "2000-01-16T21:07:20.322Z", "updated": "1980-01-31T04:21:29.929Z", "migrationVersion": 89846571 } }, "45f78865d22f9aae61499807", { "_id": "0fcb0e07136070124aada009", "provenance": "ad cupidatat amet pariatur consectetur", "name": "dolore et consequat", "description": "consequat", "memberOf": [ { "groupId": "fbbe9f4bf0479c858579c50a", "aaaManaged": false }, { "groupId": "e072d168b6514b069ed0fd95", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit nostrud" }, { "roleId": "consectetur" }, { "roleId": "deserunt est enim" }, { "roleId": "nulla irure" }, { "roleId": "est velit aliquip et qui" } ], "inactive": true, "_meta": { "created": "1995-04-14T10:54:52.541Z", "updated": "2014-11-27T22:34:38.787Z", "migrationVersion": 60883784 } } ], "type": "operation", "metrics": { "start_time": "tempor velit", "end_time": 77443097.19150549, "server_id": "velit", "finish_state": "success", "run_time": 83062759.65759373, "retrying": true, "user": { "_id": "706d69db948464bc1b0747fc", "provenance": "aliqua nostrud dolore sint", "username": "id tempor", "firstname": "nulla ad labore reprehenderit fugiat", "memberOf": [ { "groupId": "daae55d68915b985ba5b6142", "aaaManaged": false }, { "groupId": "30589ddd983c0b43cddcda55", "aaaManaged": true }, { "groupId": "8e9649ff96ef9739cdd2006c", "aaaManaged": false }, { "groupId": "d18348fd6735616091b59924", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat ullamco cupidatat laboris" }, { "roleId": "et" }, { "roleId": "proident sed irure do" }, { "roleId": "in" } ], "inactive": false, "lastLogin": "1976-01-17T11:29:35.027Z", "_meta": { "created": "1969-10-25T07:47:33.169Z", "updated": "1968-12-01T20:46:03.739Z", "migrationVersion": 17023300 }, "email": "Excepteur cillum" }, "owner": { "_id": "8558fdbc48f786b35aa3e603", "provenance": "incididunt in ut eu", "username": "nisi", "firstname": "amet veniam Excepteur", "memberOf": [ { "groupId": "24479efd6b27d97f0031c31b", "aaaManaged": true }, { "groupId": "344f2b0068b98011843be13e", "aaaManaged": false }, { "groupId": "1fb9ac668eda145b8541a7de", "aaaManaged": true }, { "groupId": "5a5c972938067dc0808d7d9c", "aaaManaged": false }, { "groupId": "947f254fa9c6c36be2c147b9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "labore" }, { "roleId": "sint id in tempor qui" }, { "roleId": "enim ullamco est in" }, { "roleId": "ex" } ], "inactive": true, "lastLogin": "1988-11-03T14:35:22.955Z", "_meta": { "created": "2019-09-11T19:42:23.902Z", "updated": "1947-08-11T17:56:20.759Z", "migrationVersion": -48937066 }, "email": "dolore dolor" } } }, { "_id": "5a0Ce68a-3E1f-8307-16FF-BFa5Ba2B120a", "location": "Adapter", "view": "elit", "status": "complete", "app": "quis sunt eiusmod anim consectetur", "name": "ea ad nisi", "variables": { "decorators": [ { "type": "encryption", "pointer": "/zNDyn./~0/Dnz2,K8J/xu/yeNV/we/~1" }, { "type": "encryption", "pointer": "/v/~0/~0/y/~1/~0/~0/~1" }, { "type": "encryption", "pointer": "/und/a,0Jm6c/Lm4wQY,/~0/~1" }, { "type": "encryption", "pointer": "/~1/pW8A/kTXw+Vma" }, { "type": "encryption", "pointer": "/~1/~1/MXG/~0" } ] }, "last_updated": "1979-06-19T09:43:45.995Z", "encodingVersion": 1, "job": { "_id": "fa8fbca68e0949f12f70b19d", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "26ddbcf56b64545477acaea7" ] }, "groups": [ "569b81aaa638208952f245f0", "b81ca8e2ddf173c740ac64cc", "2aa6cf7cf4ef84c2c25d2148", "1f3f67a69fc2d1db85a16ff0" ], "type": "operation", "metrics": { "start_time": "amet cillum velit", "end_time": -42811167.25805046, "server_id": "laboris", "finish_state": "paused", "run_time": -77529547.30260098, "retrying": null, "user": { "_id": "83662f889bb56463f0c893c0", "provenance": "in", "username": "magna aute dolor dolore", "firstname": "amet", "memberOf": [ { "groupId": "967121b744222adcfb0b682a", "aaaManaged": true }, { "groupId": "888d9a8bd6da499dd11da306", "aaaManaged": false }, { "groupId": "29f6ec84eacb2d34ef7e485c", "aaaManaged": true }, { "groupId": "f72da40457c3ed2fff68fd49", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" }, { "roleId": "aute reprehenderit fugiat" } ], "inactive": false, "lastLogin": "1991-09-25T09:01:46.829Z", "_meta": { "created": "1993-08-09T06:08:39.262Z", "updated": "2016-04-08T06:26:24.189Z", "migrationVersion": -57351029 }, "email": "do nulla" }, "owner": "Pronghorn" } } ], "metadata": { "skip": 20024666, "limit": -59898804, "total": 62555272, "nextPageSkip": null, "previousPageSkip": -92018635, "currentPageSize": -99984450 } }
{ "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" } } } ] }