Sign in

v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB
Content Document Operations

Get a document in a specific project

Get a document from a specific project. Documents with state unpublished will be retrieved.

Only documents that have been previously added to a project will show on the response. Check how to make changes to channels and content in a Project.

A document in core may be have changes that aren't yet published, these are stored in a separate variant of the document (the 'unpublished' variant). When requesting a document for core, the 'published' variant is retrieved, unless there is none (the page has never been published yet), in which case the unpublished variant is fetched.

get/project/{project_id}/document/{document_path}

Path parameters

project_idstring required

specifies the project content is fetched from

document_pathstring required

Path of a document. This is the absolute path to the document, including the document name

Response

OK

contentTypestring required

the content type of the document (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content

namestring required

identifying name of this document. Only valid characters are lowercase alphanumeric, dash, dot, and underscore. This value appears in URLs. The value must alsomatch the document name(last part of the path) in the document path.

displayNamestring required

name of this document. Used in labels in the CMS UI and in Delivery API. The displayName can only be set if either is true:a. the document is new, b. the document only exists in the project specified in this operation

localestring

document locale

pathstring required

absolute path of this document in the content repository