Docmost Octri Preview
POST/shares/transclusion/lookup

Resolve transcluded content in a public share

Resolves transcluded block content referenced in a public share. Provide shareId and a references array containing the source page and transclusion IDs for each block. The array can contain up to 50 references.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

The public share identifier and references to transcluded blocks to resolve.

referencesarray<object>required
References to resolve; each item includes a source page ID and transclusion ID. The array can contain up to 50 items.
shareIdstringrequired
Share identifier or slug.

2 status codes
200Returns the resolved content for the requested transclusions.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
404Returned when the specified share does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 404 is returned when the share identified by shareId does not exist. Supply shareId and references; each reference must include sourcePageId and transclusionId, and the array can contain at most 50 items.