One matching node. The identity is (workspace, document, node), carried together - never a node id on its own.
API reference sections
Schema
AttributeRow
Type object
Shape
| Field | Type | Description |
|---|---|---|
| workspacerequired | WorkspaceId | |
| documentrequired | DocumentId | DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path. |
| noderequired | string | The node id, meaningful only inside |
| node_kindrequired | string | The node's kind token - |
| excerptrequired | string | The node's text, truncated to a bounded number of characters - characters, never bytes, so no language is cut mid-glyph. |
| document_titlerequired | string | The source document's title, from the workspace listing. |
| trashedrequired | boolean | Whether the source document sits in the trash, inherited down the document tree - a child of a binned parent carries no stamp of its own. Trashed rows are flagged, never hidden: restore must be able to find them. |
| attributesrequired | array of AttributeRowValue | Every attribute on the node - not only the ones the filter named, so a row can be drawn without a second request. |
{
"workspace": "00000000-0000-4000-8000-000000000000",
"document": "00000000-0000-4000-8000-000000000000",
"node": "string",
"node_kind": "string",
"excerpt": "string",
"document_title": "string",
"trashed": false,
"attributes": [
{
"id": "string",
"role": "string",
"kind": "string",
"value": "string",
"zone": "string",
"label": "string"
}
]
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .
