Parameters for filtering, paginating, projecting, and sorting task execution documents. For more information on how to use the search parameters for this API, see https://docs.itential.com/docs/search-api-1
Copied to Clipboard
{
"queryParameters": {
"limit": 25,
"skip": 1,
"order": 1,
"sort": "name",
"include": "name",
"exclude": "_id",
"in": "aliqua fugiat",
"not-in": "in enim ad officia",
"equals": "et ad nisi consequat",
"contains": "id",
"starts-with": "quis enim in",
"ends-with": "officia dolore aliqua ex",
"dereference": "est consectetur aliqua minim ad",
"gt": "dolor est esse",
"gte": "sunt amet est",
"lt": "adipisicing",
"lte": "tempor",
"q": "officia quis elit occaecat",
"actionableTasks": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"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
DetailsExampleSchema
Name
Type
Description
result
object
Results for the given search parameters.
Copied to Clipboard
{
"result": true
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "task-api"
}
},
"total": {
"type": "integer",
"description": "Total number of documents matching the given query parameters."
},
"currentPageSize": {
"type": "integer",
"description": "Total number of documents returned in the items array."
},
"hints": {
"type": "array",
"description": "List of messages containing helpful context-sensitive information",
"items": {
"type": "string"
}
},
"skip": {
"type": "integer",
"description": "Current skip value."
},
"limit": {
"type": "integer",
"description": "Current limit value."
},
"nextPageSkip": {
"type": "integer",
"description": "Value to use for skip to get next page of results."
},
"previousPageSkip": {
"type": "integer",
"description": "Value to use for skip to get previous page of results."
}
}
}