API reference
- Getting Started with Your API
- SDKs and Toolkits
- Content Overview
- GETGet Document Content
- PUTUpdate Document Content
- DELDelete Document Content
- HEADGet Document Content Headers
- GETGet Resized Image
- GETGet Document Content by Path
- PUTUpdate Document Content by Path
- DELDelete Document Content by Path
- HEADGet Document Content Headers by Path
- GETGet Resized Image by Path
- GETGet Documents
- POSTCreate Document
- DELDelete Documents
- GETGet Document
- PUTUpdate Document
- DELDelete Document
- PATCHPatch Document
- GETGet Document by Path
- PUTMove Document
- PUTCopy Document
- GET
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"publishSetCode": "<string>",
"extension": "<string>",
"documentTypeFQN": "<string>",
"listFQN": "<string>",
"contentLength": 123,
"contentMimeType": "<string>",
"contentUpdateDate": "2023-11-07T05:31:56Z",
"publishState": "<string>",
"properties": "<unknown>",
"insertDate": "2023-11-07T05:31:56Z",
"updateDate": "2023-11-07T05:31:56Z",
"activeDateRange": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
}
}Create Document
Create Document. However, if you are creating an empty folder in the files list then you only need to provide the name, documentTypeFQN, and listFQN fields - replace the name value with the full path of your folder.
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"publishSetCode": "<string>",
"extension": "<string>",
"documentTypeFQN": "<string>",
"listFQN": "<string>",
"contentLength": 123,
"contentMimeType": "<string>",
"contentUpdateDate": "2023-11-07T05:31:56Z",
"publishState": "<string>",
"properties": "<unknown>",
"insertDate": "2023-11-07T05:31:56Z",
"updateDate": "2023-11-07T05:31:56Z",
"activeDateRange": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Query Parameters
limits which fields are returned in the response body
Body
The Mozu.Content.Contracts.Document to Add to the Mozu.Content.Contracts.DocumentList
Container for schema-enforced and schemaless data. A document is primarily used to store content (html, text, numbers, dates, JSON, binary data) that is directly or indirectly used for the storefront website experience and may be addressed via the Hypr theming engine language. A document belongs to a documentList and has an underlying documentType. The documentType describes any required and optional schema. Additionally, a binary object may be stored on the document's content subresource and edge cached via the Mozu CDN.
Read-only, system generated 32 digit alpha-numeric string that uniquely identifies the document.
The fully qualified name of the document including path. Unique within the documentList. This field is a required field, but it can be updated.
ReadOnly, path portion of the Name property.
The name of the publish set that this document belongs to, if any.
If applicable, the file extension associated with the document content.
The full name of the documentType that underlies this document. This field must be supplied upon document creation and cannot be updated.
The fully qualified name of the documentList to which the document belongs. This field is read-only and represents which documentList the document is created in.
The size of the content subresource in decimal number of OCTETs. When updating the content subresource, the contentLength is captured from the Content-Length header, if present, or is otherwise computed from the total size of the http body.
The mime type of the document's binary content, provided via the Content-Type header when updating the content subresource. If no value is provided then "application/octet-stream" is set by default.
The date and time the most recent content update was made via the content subresource. UTC date/time. System-supplied and read-only.
The current publish status of the document. If publishing is not supported or is currently disabled in the documentList then the value will be "active". If publishing is supported and enabled, then the publish state may be "draft" or "active". A document may have both an "active" and "draft" version. The publishState denotes which version of the document being interacted with. This field is read-only.
A JSON object of name/value pairs. Name parts are matched against the underlying documentType properties names. Any matching name parts must have a value part that conforms to the matching property schema. Any non-matching name/value pairs are considered dynamic schema and may have a value part of valid JSON. The properties field can be used for sorting/filtering and can be projected in the documents returned within a documentList view.
The date and time the document was added to the documentList. This field is system-supplied and read-only.
The date and time the most recent document update was made. If publishing is enabled, then this value will represent the last draft update if the publishState is draft, or the last publish date if the publishState is active.
Show child attributes
Show child attributes
Response
Success
Container for schema-enforced and schemaless data. A document is primarily used to store content (html, text, numbers, dates, JSON, binary data) that is directly or indirectly used for the storefront website experience and may be addressed via the Hypr theming engine language. A document belongs to a documentList and has an underlying documentType. The documentType describes any required and optional schema. Additionally, a binary object may be stored on the document's content subresource and edge cached via the Mozu CDN.
Read-only, system generated 32 digit alpha-numeric string that uniquely identifies the document.
The fully qualified name of the document including path. Unique within the documentList. This field is a required field, but it can be updated.
ReadOnly, path portion of the Name property.
The name of the publish set that this document belongs to, if any.
If applicable, the file extension associated with the document content.
The full name of the documentType that underlies this document. This field must be supplied upon document creation and cannot be updated.
The fully qualified name of the documentList to which the document belongs. This field is read-only and represents which documentList the document is created in.
The size of the content subresource in decimal number of OCTETs. When updating the content subresource, the contentLength is captured from the Content-Length header, if present, or is otherwise computed from the total size of the http body.
The mime type of the document's binary content, provided via the Content-Type header when updating the content subresource. If no value is provided then "application/octet-stream" is set by default.
The date and time the most recent content update was made via the content subresource. UTC date/time. System-supplied and read-only.
The current publish status of the document. If publishing is not supported or is currently disabled in the documentList then the value will be "active". If publishing is supported and enabled, then the publish state may be "draft" or "active". A document may have both an "active" and "draft" version. The publishState denotes which version of the document being interacted with. This field is read-only.
A JSON object of name/value pairs. Name parts are matched against the underlying documentType properties names. Any matching name parts must have a value part that conforms to the matching property schema. Any non-matching name/value pairs are considered dynamic schema and may have a value part of valid JSON. The properties field can be used for sorting/filtering and can be projected in the documents returned within a documentList view.
The date and time the document was added to the documentList. This field is system-supplied and read-only.
The date and time the most recent document update was made. If publishing is enabled, then this value will represent the last draft update if the publishState is draft, or the last publish date if the publishState is active.
Show child attributes
Show child attributes