v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB
Content Document Operations

Create or update a document in a specific project

Create or update a document in a specific project.

The document will be created with state unpublished. To make changes available on the live website, it's necessary to merge the project.

put/project/{project_id}/document/{document_path}

Path parameters

project_idstring required

specifies the project content is added to

document_pathstring required

Path of a document. This is the absolute path to the document, including the document name. Folders appearing in this path need to preexist

Headers

X-Resource-Versionstring

Resource's version, as obtained when GETting the resource. The first time a resource is created, a empty value is expected (omit the header). Must be used in any subsequent update requests of this resource

Request body

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

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