Read document
traceable_doc_readRead a document or a template. Both modes return meta.revision (on a full read, revision= on the [[document]] line): pass it as baseRevision on your next content write so it is refused if the document changes in between. mode=outline returns metadata + the body heading outline + titlePageHeadings + landmarks (the row order and kind of the revision table, references, glossary, Test Plan and similar rows, and of each diagram and image row with its caption; a diagram also gives its status) + item counts + the document's references with the referenceId a citation uses (cheap; default when exploring). mode=full returns the content as Traceable Markdown (TrMD): segments as [[segment …]], each block prefixed with its [[row N]] anchor annotation, including ID-grid structure ([[id-header types=…]]). When other documents in the project trace INTO this one, a second text block lists those incoming links, grouped under each source document (its number, name and id) as " -> "; a bounded read lists only the links into the rows it returns. Link cells in the TrMD list a row's outgoing links only. Bound a full read with fromOrder/toOrder (row orders from the outline or a prior read) to load only a section; a range that holds no rows says so and gives the row orders the document spans. Accepts a template id (from traceable_workspace_templates) so you can inspect a template body and its column structure before cloning it with traceable_doc_create.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | outline (default) or full | |
| toOrder | No | Last row order to include (full mode) | |
| fromOrder | No | First row order to include (full mode) | |
| documentId | Yes | A document or template UUID (from traceable_workspace_map / traceable_workspace_templates) |