OMomni
Documents v2

Get draft state

Changed on

Read the named draft's state. The response can be used as a request body when creating and patching drafts. The response includes draftOf.identifier, the published document this draft belongs to.

get/v2/documents/{documentId}/draft/{draftId}

Request

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

Path parameters

documentIdstring required

The published document's URL slug (e.g. abc123) or its canonical workbook UUID.

draftIdstring required

The draft workbook identifier, returned by Create draft and patch 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

Draft 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