What the query answers with.
API reference sections
Schema
TaskQueryResponse
Type object
Shape
| Field | Type | Description |
|---|---|---|
| rowsrequired | array of TaskRow | The matching tasks, one row each, in the requested order. |
| definitionsrequired | array of AttributeDefinition | Every attribute definition in play: the system registry always, plus the scoped workspaces' custom definitions - so a surface draws a value from its type rather than guessing. |
| tagsrequired | array of AttributeTag | The scoped workspaces' tag tables (live tags only, merge tombstones resolved away), so a |
| groups | array of TaskGroup | Corpus-wide counts per group - per list, or per bucket - when the query asked for them with Names are not repeated here. A group carries its key - a Default |
| projectedrequired | boolean | Whether every workspace in scope has reached the read model at all. |
| updating_workspaces | array of WorkspaceId | The workspaces the answer may be behind on, by the same rule search and the attribute query use: named rather than waited for. Default |
| limitrequired | integer (uint, >= 0) | The page size actually applied, after the store's cap. |
| next_after | string or null | The Default |
| restarted | boolean | The Default |
| covered | boolean or null | Whether the rows and counts include every write in [ `None` means this server cannot tell - an older store that never read the requirement. A client must read A different question from [ Default |
{
"rows": [
{
"workspace": "00000000-0000-4000-8000-000000000000",
"document": "00000000-0000-4000-8000-000000000000",
"node": "string",
"task": "string",
"node_kind": "string",
"lifecycle": "string",
"document_trashed": false,
"in_trash": false,
"breadcrumb": "string",
"title": "string",
"attributes": [
{
"id": "string",
"role": "string",
"kind": "string",
"value": "string",
"zone": "string",
"label": "string"
}
]
}
],
"definitions": [
{
"id": "string",
"key": "string",
"label": "string",
"value_type": "string",
"cardinality": "string",
"scope": "string",
"system": false,
"options": [],
"filterable": false,
"sortable": false,
"groupable": false
}
],
"tags": [
{
"id": "string",
"name": "string",
"color": "string",
"workspace": {}
}
],
"groups": [],
"projected": false,
"updating_workspaces": [],
"limit": 0,
"next_after": "string",
"restarted": false,
"covered": false
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Used by
Generated from contract version 1. Last updated .
