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": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "adipisicing occaecat ut esse", "not-in": "occaecat sed et do cupidatat", "equals": "eiusmod", "contains": "exercitation proident commodo", "starts-with": "labore Excepteur dolore nostrud", "ends-with": "sit cillum ad", "dereference": "commodo", "gt": "qui labore et Excepteur", "gte": "incididunt velit amet", "lt": "qui officia quis", "lte": "ex deserunt amet", "q": "mollit", "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": "5f3606FD-1c9D-287b-ACBd-a8ee75f5FdCA", "location": "Application", "view": null, "status": "canceled", "app": "anim in reprehenderit esse", "name": "velit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/Wbc/RqDb7EbR/S++hADHe/~1/hZsbf/D2t2" }, { "type": "encryption", "pointer": "/~1/LS+xEPM/kMIVD/gv/~0/C/x7h0+ClrPd/~0" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/lH8XZeuY9F/~0/~1/EEKyG+EE" }, { "type": "encryption", "pointer": "/~0/~1/wCZ5mk9fxv/Z9IT-" } ] }, "last_updated": "2022-03-13T14:39:36.447Z", "encodingVersion": 1, "job": { "_id": "7d0753a54fccf64042f1edc7", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "c135d817c86ef53d1294b0e3", "96a415a9680bb86bbd91a910", "f72f9e69e68bbb453190fb27", "83dad3b0479ee700693db881" ] }, "incomingRefs": [], "groups": [ { "_id": "97940bb194891e434986edd5", "provenance": "dolor sit occaecat", "name": "aute", "description": "enim do Lorem adipisicing commodo", "memberOf": [ { "groupId": "2078c39031bf27b5756727ab", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum magna aute Duis non" }, { "roleId": "ad culpa reprehenderit consectetur" } ], "inactive": false, "_meta": { "created": "1997-09-16T13:46:40.04Z", "updated": "2021-08-16T00:26:13.806Z", "migrationVersion": 24157670 } }, { "_id": "b3a81c5c914bf1a2bda4575a", "provenance": "nostrud", "name": "sunt minim", "description": "laboris sunt", "memberOf": [ { "groupId": "8d3640e02288b95b840edddb", "aaaManaged": true }, { "groupId": "081233be946d4b6e524a61ae", "aaaManaged": true }, { "groupId": "984cdecd9cabb200fcea8c5e", "aaaManaged": false }, { "groupId": "99e28d00b15db2a0eb70b669", "aaaManaged": false }, { "groupId": "afaf69c0cbc7a83025a3167c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut ut" }, { "roleId": "qui do ex" }, { "roleId": "occaecat aliqua et" } ], "inactive": true, "_meta": { "created": "1955-08-02T18:02:24.928Z", "updated": "1961-08-26T00:26:42.979Z", "migrationVersion": 58162788 } }, { "_id": "8bac60d2b2968a9a2daaa013", "provenance": "aliquip sed dolore quis", "name": "eu anim", "description": "dolore ad", "memberOf": [ { "groupId": "57c6a8602c5caba93f293b07", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et sunt" }, { "roleId": "et veniam laboris in" } ], "inactive": true, "_meta": { "created": "1995-04-28T17:31:33.589Z", "updated": "2001-06-28T14:01:55.273Z", "migrationVersion": -97883004 } } ], "type": "manual", "metrics": { "start_time": "enim aute quis", "claim_time": "1950-11-22T20:05:58.226Z", "end_time": 87757802.81183532, "server_id": "minim sit nostrud", "finish_state": "running", "run_time": 58095727.125532866, "user": { "_id": "e9b54526c962b1e33a9f249f", "provenance": "pariatur consectetur velit dolor", "username": "officia esse", "firstname": "in proident consectetur sint minim", "memberOf": [ { "groupId": "6ac09961a2542ca8382d267d", "aaaManaged": true }, { "groupId": "9eb6381ce5b2624aeb3f46c8", "aaaManaged": false }, { "groupId": "4e37817f2144d0a40a4cbab6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "mollit adipisicing enim" }, { "roleId": "reprehenderit" }, { "roleId": "est et culpa sint" }, { "roleId": "in enim elit" } ], "inactive": true, "lastLogin": "2009-07-15T02:27:42.613Z", "_meta": { "created": "1962-02-06T12:48:32.8Z", "updated": "1989-12-29T20:52:14.168Z", "migrationVersion": -69321811 }, "email": "ut aliqua" }, "owner": "117cac77c14db84361e15bbc" } }, { "_id": "0FDa20bd-4eb1-F2b0-b7Ff-051E07F9f26D", "location": "Adapter", "view": null, "status": "running", "app": "ut", "name": "cillum ullamco et est", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0" } ] }, "last_updated": "1961-10-21T15:15:23.462Z", "encodingVersion": 1, "job": { "_id": "6c1de83084314b35630603ee", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "64f04c3142c7cb4da0be64a9", "provenance": "in Duis", "name": "veniam", "description": "nulla anim", "memberOf": [ { "groupId": "6bcbfc185598288fd0cf0f54", "aaaManaged": true }, { "groupId": "4ccca0791d2a8e4b76235893", "aaaManaged": true }, { "groupId": "00de7034ce0c72d5d92e96c7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "voluptate dolore" }, { "roleId": "dolor amet" } ], "inactive": true, "_meta": { "created": "1965-12-23T01:53:04.78Z", "updated": "1994-12-25T15:04:47.397Z", "migrationVersion": 69342882 } }, "1e327c2cc545bb4df8981281", "6a173261c49f38acb7dfa655" ], "type": "manual", "metrics": { "start_time": "incididunt irure consectetur sit Excepteur", "claim_time": "1996-06-08T02:52:58.287Z", "end_time": -67073940.373619445, "server_id": "dolore dolor anim in", "finish_state": "success", "run_time": 23571813.394981727, "user": "3c492f836477ced33932066d", "owner": { "_id": "5a64661fe1502daabd1e80c4", "provenance": "sed anim", "username": "fugiat magna minim esse", "firstname": "adipisicing aliquip", "memberOf": [ { "groupId": "2a8af634e3ab29163d481a94", "aaaManaged": true }, { "groupId": "d734abeb6a8c82598b51ae62", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur" }, { "roleId": "laborum minim" }, { "roleId": "ut Duis adipisicing sint in" } ], "inactive": false, "lastLogin": "1952-03-05T00:49:50.381Z", "_meta": { "created": "2024-04-29T11:09:43.733Z", "updated": "1952-12-11T19:14:12.111Z", "migrationVersion": -90366715 }, "email": "cillum labore magna adipisicing" } } } ], "metadata": { "skip": 45606324, "limit": -85382269, "total": 24103171, "nextPageSkip": -50408525, "previousPageSkip": null, "currentPageSize": -9060187 } }
{ "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" } } } ] }