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": 1, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "occaecat", "not-in": "qui", "equals": "magna mollit in ea", "contains": "in exercitation reprehenderit", "starts-with": "sint", "ends-with": "dolore", "dereference": "occaecat cillum", "gt": "ex", "gte": "culpa Excepteur", "lt": "Excepteur proident", "lte": "adipisicing mollit sit", "q": "consequat sint ut incididunt", "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 retrieved search results", "data": [ { "_id": "B6eE0435-62a8-BCE8-D2A8-C8f27e39B5DA", "location": "Broker", "view": null, "status": "running", "app": "dolor voluptate aliquip in proident", "name": "fugiat do aliqua", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/JOjP5bfNN/~0" }, { "type": "encryption", "pointer": "/~0/U/~1/~0/~1/S/qu6B/Em,c1P7" }, { "type": "encryption", "pointer": "/u/nHgMK+sja/~0/~1/~1/~1/H8qwOjq0HNJ/~0/~0/~1/AKuDDw/tIt" }, { "type": "encryption", "pointer": "/hV8HAhvULaW/~1/jk/lsAAb" } ] }, "last_updated": "2016-10-31T07:05:56.87Z", "encodingVersion": 1, "job": { "_id": "e902fa00f31e9247a30638f8", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "1da7e30b9639fec523b236a7", "d0c633691e8ba566e1ebb9cc", "15df89748688155a1bcc33a0", "5e709db4e23d033fb4fec460", "4f705146d9d02e23faca19f6" ] }, "incomingRefs": [], "groups": [ { "_id": "a326011ee8e042e4a72182f0", "provenance": "adipisicing dolor Ut", "name": "in nulla aliquip irure", "description": "ut ipsum ullamco aute irure", "memberOf": [ { "groupId": "8785fbd874c3363998091a82", "aaaManaged": false }, { "groupId": "36233dc9d8e83c47ba03a17d", "aaaManaged": false }, { "groupId": "5f43b57fe715ad046728654d", "aaaManaged": false }, { "groupId": "9fb9aaf378e6b889a84dc83e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "mollit non" } ], "inactive": false, "_meta": { "created": "1985-01-30T11:26:47.912Z", "updated": "1956-02-12T08:24:44.244Z", "migrationVersion": -27339101 } }, { "_id": "ddfffe15469798b05f5f3f9a", "provenance": "dolor non", "name": "velit in esse irure", "description": "Lorem veniam elit amet anim", "memberOf": [ { "groupId": "da591e5b4052ef54203b1492", "aaaManaged": true }, { "groupId": "95b5ccf2326bcd9a8fde5d03", "aaaManaged": true }, { "groupId": "40f7cf1fd7559a2f678965e6", "aaaManaged": true }, { "groupId": "4ff4d5d2b799eabfff9da17f", "aaaManaged": false }, { "groupId": "fdbd3f4464dddcce21cccda6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit" }, { "roleId": "magna eiusmod sed eu consequat" }, { "roleId": "deserunt et irure mollit" }, { "roleId": "anim" } ], "inactive": true, "_meta": { "created": "1998-12-14T17:47:59.548Z", "updated": "1993-09-09T09:17:04.933Z", "migrationVersion": -51008105 } }, { "_id": "dafdd1c549a1d2901ea2fa06", "provenance": "esse est ad non", "name": "fugiat incididunt", "description": "in", "memberOf": [ { "groupId": "a90bd703e8070f8dd9333ecb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse Excepteur laboris cillum reprehenderit" }, { "roleId": "laborum aliquip Lorem Excepteur" }, { "roleId": "minim mollit" }, { "roleId": "velit" }, { "roleId": "nostrud dolore proident" } ], "inactive": false, "_meta": { "created": "1984-08-15T21:01:17.315Z", "updated": "2024-05-30T15:23:57.25Z", "migrationVersion": 37911316 } } ], "type": "operation", "metrics": { "start_time": "fugiat reprehenderit commodo", "end_time": -95252804.27147464, "server_id": "sint consectetur dolor dolore Ut", "finish_state": "paused", "run_time": -57407828.36473062, "retrying": true, "user": "", "owner": "Pronghorn" } } ], "metadata": { "skip": 40173439, "limit": -36363584, "total": 57697937, "nextPageSkip": null, "previousPageSkip": -6400348, "currentPageSize": 23536037 } }
{ "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" } } } ] }