Properties
| Name | Type | Description |
|---|---|---|
| variables | object | The variables definition are the part that looks like task(from: $startTime, to: $endTime) in the query. It works just like the argument definitions for a function in a typed language. These variables |
| query | string | A graphQL query specifying the task attributes needed in the response for the specified time window. from: Start time for the query (in epoch milliseconds) and it cannot be older than 36 months from t |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/SearchRequest",
"title": "SearchRequest",
"type": "object",
"properties": {
"variables": {
"type": "object",
"description": "The variables definition are the part that looks like task(from: $startTime, to: $endTime) in the query. \n It works just like the argument definitions for a function in a typed language. These variables are applicable only for persisted queries that has these variables. An example of persisted query with variables - {\n task (from: $startTime, to: $endTime, filter: {\n and : [\n {channelType : {equals: telephony}}\n ]\n } , pagination: {cursor:\"0\"}) {\n tasks {\n id\n channelType\n }\n }\n}",
"example": {
"startTime": 1629369769066,
"endTime": 1629458280000
}
},
"query": {
"type": "string",
"description": "A graphQL query specifying the task attributes needed in the response for the specified time window. from: Start time for the query (in epoch milliseconds) and it cannot be older than 36 months from the current time. to: End time for the query (in epoch milliseconds) and it cannot be greater than the current time. The duration between to and from must not be more than 365 days.\n",
"example": "query($startTime: Long!,$endTime: Long!) { task (from: $startTime, to: $endTime, filter: { and : [ {channelType : {equals: telephony}} {status: {equals: \"created\"}} {owner: {equals: {id: \"owner-id\"}}} {customer: {equals: {name: \"customer-name\"}}} ]} , pagination: {cursor:\"0\"}) { tasks { id channelType}}}"
}
},
"example": null
}