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": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "adipisicing Lorem aliquip laboris", "not-in": "dolor", "equals": "non in", "contains": "magna", "starts-with": "mollit", "ends-with": "consectetur dolor et", "dereference": "dolore", "gt": "minim eu aliquip Duis Excepteur", "gte": "dolor", "lt": "aliquip pariatur Ut nostrud", "lte": "qui ex magna", "q": "labore aliqua", "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": "4FacDBfB-Af5c-5d22-3E65-88Be53bcA48e", "location": "Broker", "view": "labore est eiusmod", "status": "running", "app": "consequat voluptate sit Lorem fugiat", "name": "in in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/X/~0/~0/lw8Q1JNv/~1/~0" }, { "type": "encryption", "pointer": "/~0/ud8/THkB1FW9//~0" } ] }, "last_updated": "2002-05-17T22:26:31.457Z", "encodingVersion": 1, "job": { "_id": "7affc42f8334b08d77000070", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "769c7c5213eade2971bb3bcd", "provenance": "consequat magna incididunt commodo officia", "name": "est", "description": "aute consequat ullamco", "memberOf": [ { "groupId": "868cd674d9a39902c46e4cbd", "aaaManaged": false }, { "groupId": "0a1bd16d0d126a961697e7a9", "aaaManaged": false }, { "groupId": "e1412e87f01f57907a39a9db", "aaaManaged": false }, { "groupId": "ba5ec906444b57bb3400f911", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat ut minim" }, { "roleId": "sunt anim irure deserunt" }, { "roleId": "in sint Duis" }, { "roleId": "in" }, { "roleId": "voluptate" } ], "inactive": true, "_meta": { "created": "1985-08-26T19:19:14.203Z", "updated": "1973-08-17T20:20:19.158Z", "migrationVersion": -6580813 } }, { "_id": "f01f1b4ff4546695819f9303", "provenance": "in do consequat voluptate", "name": "adipisicing fugiat reprehenderit ea Ut", "description": "nostrud", "memberOf": [ { "groupId": "bf962d341d375a156f5b2363", "aaaManaged": true }, { "groupId": "0192a433827508f8192a80ea", "aaaManaged": false }, { "groupId": "1c33df31370039fe5f4ee0a4", "aaaManaged": true }, { "groupId": "68d94a39717874f8b062de05", "aaaManaged": false }, { "groupId": "5727df906138073bbe229d4c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident irure" }, { "roleId": "officia sunt cillum est qui" }, { "roleId": "dolore laboris est cupidatat" }, { "roleId": "tempor" }, { "roleId": "laborum est do" } ], "inactive": true, "_meta": { "created": "1965-02-08T16:58:37.855Z", "updated": "1963-09-23T10:05:07.718Z", "migrationVersion": 67839683 } } ], "type": "manual", "metrics": { "start_time": "reprehenderit officia laborum nisi amet", "claim_time": "2010-06-09T00:52:55.134Z", "end_time": 86869292.52986473, "server_id": "ad", "finish_state": "success", "run_time": -54492501.73180955, "user": "f97703f7d2b464caee717068", "owner": "Pronghorn" } }, { "_id": "87FEc7d3-A365-cC04-4bFc-Cb7331E966bA", "location": "Application", "view": null, "status": "failure", "app": "non", "name": "mollit voluptate", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/H2DOH/~0/XN7GMX2YQ7l/ltf34H3Yo/io3je/PUlMcU3HwR/h/~0" }, { "type": "encryption", "pointer": "/ABQnT/blPNUJT/~1/MigaFd/dw9BEpu6" }, { "type": "encryption", "pointer": "/t/FG/~0/~1/v2E3K5gE/~1/~1/~1/o/~1/L" }, { "type": "encryption", "pointer": "/j1DQUmUv/~1/~1/f2j4/~1/o2kx77kCm//~0/~1/szm2zM/Cp,TIa/khwwX" }, { "type": "encryption", "pointer": "/mpjF4H/mSZGt.T/dK/~1/Wx5Zgb./zYGQaJTE/~1/~1/~0/Gd" } ] }, "last_updated": "1961-07-24T00:42:43.53Z", "encodingVersion": 1, "job": { "_id": "ca02f48885bdd08be8836293", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "443282f2975b224d0b5c3973", "d713f6d7437765d39edb1cdb", { "_id": "f6785e5bf2d4ee73c08d4aab", "provenance": "voluptate Excepteur", "name": "cillum fugiat", "description": "quis Ut labore pariatur qui", "memberOf": [ { "groupId": "cb2ed43d8cb4341e2af5dff6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation anim" }, { "roleId": "incididunt laboris ex ullamco proident" }, { "roleId": "consectetur" } ], "inactive": true, "_meta": { "created": "1964-11-23T06:15:42.803Z", "updated": "1988-04-23T04:03:21.091Z", "migrationVersion": -40828026 } } ], "type": "manual", "metrics": { "start_time": "aute", "claim_time": "1994-08-19T23:43:45.687Z", "end_time": 117634.28347446024, "server_id": "ullamco adipisicing", "finish_state": "error", "run_time": 55680433.67191565, "user": "Pronghorn", "owner": "cbaf4b1eca07e70ca74fa62d" } } ], "metadata": { "skip": 94233032, "limit": -74334418, "total": 26125223, "nextPageSkip": null, "previousPageSkip": -31357244, "currentPageSize": 91495050 } }
{ "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" } } } ] }