Document saving, loading, locking, and state management

Indicates whether additional documents may be included in the response. Its main purpose is to load a multi-document structure with a single request, which would otherwise require several subsequent document load requests. Additional documents typically only include documents from the document structure who’s main purpose is to group and reference other documents e.g. DITA maps. Whether additional documents are included in the response is left to the discretion of the CMS. This property should only be set to true for initial document load requests. Can be combined with just-in-time loading to minimize document load requests.

The context from which the document was loaded.

The document identifier of the XML document to load. This might be a relative url if the requested document is loaded because it is referred to by another document, in this case the referrerDocumentId is also specified.

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. See the MDN Web Docs for more information.

The requested document is returned successfully.

The document was not changed since it was last requested and the cached version must be used.

The user is not authorized to retrieve the requested document.

The document does not exist in the CMS.

Any error in the 500 range indicates a problem with the CMS.

The body object containing initial content and/or metadata, if any. Also contains the context object. The documentId is not set since it must be determined by the CMS and lock info is not needed as it should always be opened as if it was isLockAcquired true.

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. See the MDN Web Docs for more information.

The document is created successfully. Optionally the CMS can return modified content and/or metadata which Fonto Editor will load.

Fonto Editor provided invalid XML content or invalid/insufficient metadata for the CMS to create the document.

The user is not authorized to create documents.

The document could not be created because the document already exists.

Any error in the 500 range indicates a problem with the CMS.

The document object to save, including the metadata. Also contains the context object and autosave flag.

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. See the MDN Web Docs for more information.

The document is saved successfully. The body of the response may contain an updated documentContext, revisionId and/or lock state.

The document is saved successfully. The documentContext, lock state and revisionId are not updated.

Fonto Editor provided invalid XML content or invalid/insufficient metadata for the CMS to save the document. The editor will warn the user that action is required before the document can be saved. The editor will not automatically retry unless the document's content or metadata are changed.

This response may optionally contain a body to update the remote state of the document, similar to the /document/state endpoint:

The user is not authorized to access the specified document. Fonto Editor will warn the user that the document can no longer be accessed and prevent further edits.

Use the 412 response if the document can not be saved due to its current lock state and/or an incompatible revisionId in the request.

This response may optionally contain a body to update the remote state of the document, similar to the /document/state endpoint:

The document does not exist in the CMS, and thus cannot be saved. Fonto Editor will warn the user that the document can no longer be accessed and prevent further edits.

The save request failed due to failing preconditions. This can be used to indicate that the document content has changed from that of the given revisionId. Fonto Editor will warn the user that the document needs to be reloaded (discarding unsaved changes) before editing can continue. It can also indicate that the lock is no longer acquired.

This response may optionally contain a body to update the remote state of the document, similar to the /document/state endpoint. We recommend using this to make the user aware of the reason the request failed, which could be either a mismatching revisionId or a change in the lock state. If the response does not include a revisionId, Fonto Editor will assume that the revision ID has changed.

Any error in the 500 range indicates a problem with the CMS. Fonto Editor will automatically retry saving the document periodically.

The information of the requested lock.

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. See the MDN Web Docs for more information.

The lock has been successfully acquired/released. The body of the response may contain an updated documentContext, revisionId and/or lock state.

The lock has been successfully acquired/released. The documentContext, other parts of the lock state and the revisionId are not updated.

The user is not authorized to access this document.

Use the 412 response if the lock state can not be modified due to the lock being unavailable and/or an incompatible revisionId in the request.

This response may optionally contain a body to update the remote state of the document, similar to the /document/state endpoint:

The document does not exist in the CMS, and thus cannot be interacted with.

The lock request failed due to failing preconditions. This can be used to indicate that the document status has changed. Fonto Editor will warn the user that the document should be reloaded before they can continue editing.

This response may optionally contain a body to update the remote state of the document, similar to the /document/state endpoint. We recommend using this to make the user aware of the reason this request failed, which could be either a mismatching revisionId or a change in the lock state. If the response does not include a revisionId, Fonto Editor will assume that the revision ID has changed.

Any error in the 500 range indicates a problem with the CMS.

The information for the state request.

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. See the MDN Web Docs for more information.

The states have been retrieved successfully. The body contains an array of the states corresponding to the documentIds in the request.

Any error in the 500 range indicates a problem with the CMS.

The context from which the document was loaded.

The document identifier of the document to load the preview of.

Optional parameter used to request a forced download response from the CMS, when this parameter is true it should be used to set the "Content-Disposition" to "attachment" in the response.

Optional parameter used to request a specific preview variant, can contain arbitrary content as implemented in the operations defined in fontoxml-publication-preview.

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. See the MDN Web Docs for more information.

The presearch was performed successfully.

An error occurred during the presearch.

{
    "results": [
        {
            "status": 200,
            "body": {
                "documentId": "doc-1-dac3",
                "revisionId": "version-1870-f5cd"
            }
        },
        {
            "status": 500,
            "body": {
                "documentId": "doc-3-8b0f"
            }
        }
    ]
}

• Includes a result with status code "200" for the first document because it matches the search query.

• Omits a result where the documentId is that of the second document because it does not match the search query.

• Includes a result with status code "500" for the third document because it could not be searched for an unknown reason.