OMomni
Documents v2

Get document state

Changed on

Retrieve the document's published state. The response can be used as-is as the request body in a call to the Patch draft API.

If documentId names a draft instead of a published document, the response also includes draftOf.identifier, the published document the draft belongs to. To read a draft's state, use Get draft state, which returns the same draftOf field. To read an app document's HTML, use Read app content.

get/v2/documents/{documentId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v2/documents/{documentId}
  • Auth
    HTTP bearer

Path parameters

documentIdstring required

The document's URL slug (e.g. abc123) or its canonical workbook UUID. Also accepts a draft identifier, in which case the response is the draft's state with draftOf.identifier naming the published document.

Query parameters

prettyboolean

Format response with 2-space indentation for readability. Accepts true, 1, or no value (e.g., ?pretty). Default is compact (single-line) JSON.

Response

Document state.

namestring required

Document name.

descriptionstring nullable required

Document description.

modelIdstring uuid

The SHARED or SHARED_EXTENSION model the workbook is built on.

workbookModelIdstring uuid

The workbook-layer model ID. Each document has its own workbook model for document-specific fields and calculations. For drafts, this returns the draft's workbook model ID, not the published document's.

containersobject[]

Container layout array (grid / stack / page / reference containers, recursively nested). On a patch, when present this fully replaces the existing layout. The server validates the full structure on apply; container instanceKey / referenceKey values round-trip unchanged. See the dashboard layout reference for the complete grammar.

Changes

  • 43290040f88fRevision changes
    • warning

      added the new foreign enum value to the /// response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the required property / to the response with the status