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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "laboris Excepteur eu tempor", "not-in": "magna laboris consequat", "equals": "est Excepteur ut cupidatat", "contains": "aliqua voluptate tempor labore", "starts-with": "cillum sint dolor", "ends-with": "non", "dereference": "commodo est fugiat et tempor", "gt": "veniam magna", "gte": "in laboris", "lt": "elit nulla", "lte": "in", "q": "deserunt ut et ullamco 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": "AF40B286-feFe-af60-BBf5-B5C4d02DbfD6", "location": "Adapter", "view": null, "status": "canceled", "app": "voluptate ullamco sint", "name": "cillum id nostrud", "variables": { "decorators": [ { "type": "encryption", "pointer": "/yqBwwrZ" } ] }, "last_updated": "2003-08-22T21:40:09.1Z", "encodingVersion": 1, "job": { "_id": "1525e2e7dfa70be364ac506f", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "b8b369d3512b2e4ae3b6fc45", "62173c36df4128fe6e6fff9f" ], "type": "operation", "metrics": { "start_time": "quis magna aliqua ullamco minim", "end_time": 87618459.00801224, "server_id": "dolor dolore", "finish_state": "success", "run_time": -38205146.79122695, "retrying": null, "user": "13fbb7e49c54f0377d0bcf43", "owner": { "_id": "8b204ae9c47ea7be603ee4f3", "provenance": "eiusmod Excepteur dolor in", "username": "cupidatat minim exercitation", "firstname": "ex ea incididunt Ut", "memberOf": [ { "groupId": "d5f390a629a30c42b1d391e2", "aaaManaged": false }, { "groupId": "d9982c0c92ca4d7207650b30", "aaaManaged": false }, { "groupId": "fbbe416364b1b3dfb74eca91", "aaaManaged": true }, { "groupId": "bb57838786e7d07acd229b86", "aaaManaged": true }, { "groupId": "7544b0b469eaa54e79c72aef", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia labore eiusmod minim ea" }, { "roleId": "dolore sunt" }, { "roleId": "officia Ut sint veniam" }, { "roleId": "fugiat laboris ut pariatur exercitation" } ], "inactive": true, "lastLogin": "2010-08-22T18:04:50.054Z", "_meta": { "created": "1996-07-04T04:54:58.451Z", "updated": "1972-08-09T17:41:49.517Z", "migrationVersion": -78202720 }, "email": "laborum officia Ut" } } }, { "_id": "2Fa6a5Cf-a1ab-2fa0-c76e-3Ee2eE1E1Ef2", "location": "Adapter", "view": "magna exercitation aliquip", "status": "complete", "app": "qui", "name": "irure", "variables": { "decorators": [ { "type": "encryption", "pointer": "/I3bP/2C1a/~0/Xl9/~0/~0" } ] }, "last_updated": "1946-02-04T04:34:16.223Z", "encodingVersion": 1, "job": { "_id": "1e42cec8d767a03962478a93", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "a94d45139f26b4f21311b30c" ], "type": "operation", "metrics": { "start_time": "sit amet id tempor", "end_time": 68387906.45464829, "server_id": "ea mollit nostrud nulla", "finish_state": "incomplete", "run_time": -39530556.49091368, "retrying": null, "user": "42b9225cd068f3ccc505c2a4", "owner": "" } } ], "metadata": { "skip": -82617560, "limit": 46526320, "total": -34569057, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -77630813 } }
{ "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" } } } ] }