v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Documents

Patch draft

Apply the patch to an existing draft addressed by draftIdentifier. Pure apply — no draft creation, no publish.

patch/api/v2/documents/{identifier}/draft/{draftIdentifier}

Path parameters

draftIdentifierstring required

Draft workbook identifier (see PATCH /api/v2/documents/{identifier}/draft).

Example:def456

Draft workbook identifier (see PATCH /api/v2/documents/{identifier}/draft).

identifierstring required

Published document identifier.

Example:abc123

Published document identifier.

Request body

descriptionstring nullable

namestring

Document name.

summarystring

Optional. Caller-supplied description of what this patch changes, written to the history audit trail. When omitted, the server auto-generates one from the touched sections.

modelIdstring uuid

The document's base model. Immutable and accepted only so a GET response round-trips through PATCH: a value matching the current model is a no-op, and a differing value is rejected — it cannot re-base the document. Omit it to leave the model untouched.

workbookModelIdstring uuid

The server-assigned workbook-layer model. Read-only and accepted only so a GET response round-trips through PATCH: a value from a GET of the draft or of the published document it targets is a no-op, and any other value is rejected. Omit it otherwise.

Response

Patch applied to draft successfully.

descriptionstring nullable required

Document description.

draftIdentifierstring required

Identifier of the draft the patch was applied to.

identifierstring required

Published document identifier the draft targets.

namestring required

Document name.