Data model
The following tables describe the schema and attributes used in XM Cloud Content.
For guidance on API syntax, see Syntax.
Content types
The following table describes the schema for a content type.
| Field type | Description | Required | Limit |
|---|---|---|---|
| Name | An internal name used when managing the content type in XM Cloud Content. | Yes | 40 characters |
| ID | Content type identifier that must be unique per tenant. It must be alphanumeric, and can contain periods, underscores, and hyphens, but not spaces or other special characters. It cannot start with the word taxonomy. The ID cannot be media. Consecutive periods are not allowed. Once defined it cannot be changed. | Yes | 40 characters |
| Description | Description of the content type, displayed in the user interface. | No | 256 characters |
| Fields | Fields defined for the content type. | N/A | 50 fields |
| System | List of system attributes for a content item. | N/A | N/A |
The maximum number of content types per tenant is 150.
Content type fields
The following table describes the schema for content type fields.
Restricted words for field IDs
The following words are reserved and cannot be used as a field ID:
- id
- locale
- name
- ref
- sysCreatedAt
- sysCreatedBy
- sysStatus
- sysUpdatedBy
- sysUpdatedAt
- sysPublishedAt
- sysPublishedBy
- sysVersion
Field types
You can add any of the following fields to a content type.
| Field type | Description | Limit |
|---|---|---|
| Text | Single line or multi-line text. | 50,000 characters |
| Rich text | Text with formatting. Rich text fields include text formatting. The value and the formatting are saved separately as JSON. | 200,000 characters |
| Media | Related media items. | 50 items |
| Date time | ISO 8601 format of date and time representation (year-month-day-time), for example, 2022-04-24T19:13:55. In the app, time is displayed as mm/dd/yyyy. | N/A |
| Number | Integer. | 9223372036854775807 |
| Boolean | Two options, such as the true or false states of a check box. | N/A |
| Reference | Related content items. | 50 items |
| Select | Related taxonomies. | 300 items |
| JSON | Valid JSON object. | 100,000 characters (excluding spaces and new line characters) |
Content items
The following table describes the data model for content items.
| Field name | Description | Required | Limit |
|---|---|---|---|
| Content TypeId | ID of the content type the item belongs to. | Yes | N/A |
| Name | The name of the content item. The name displayed at the top of the page automatically changes to match what you type here. | N/A | 1,000 characters |
| Fields | Fields defined for the content item. | N/A | 50 fields |
| System | List of system attributes for a content item. | N/A | N/A |
The maximum number of content items is 100,000. To specify a content item ID, add it to the request; otherwise, it is auto-generated. You can only specify the content item ID using the APIs.
Locales
The following table describes the data model for locales. A locale is a culture code that consists of a two-letter language code and a two-letter region code, for example, the locale for American English is en-US and for British English is en-GB.
| Field name | Description | Required | Limit |
|---|---|---|---|
| ID | ID of the locale. You can retrieve the list of supported locales, by adding the supported attribute to the GET locales method. | Yes | N/A |
| Name | The name of the locale. The name displayed in the Localization section of the content item's details page. | N/A | 50 characters |
The maximum number of locales per tenant is 25.
Media items
The following media item formats are supported:
- Spreadsheet (.
csv, .xlsand .xlsx) - Document (.
doc, .docx, .txt, and .rtf) - Image (.
gif, .jpeg, .jpg, .png, .tif, .tiff, .svg, .eps, andwebp) - PDF (.
pdf) - Presentation (.
pptand .pptx)
The following table describes the data model for media items.
| Field type | Description | Required | Limit |
|---|---|---|---|
| ID | Unique identifier for the media item. It must be alphanumeric, and can contain periods, underscores and hyphens, but not spaces or other special characters. It cannot start with the word taxonomy. By default, the identifier is the same as the name. Once defined it cannot be changed. | Yes | 256 characters |
| Name | Name of the media item. It can contain periods but cannot contain spaces or special characters. Defaults to Untitled if left blank. | No | 1,000 characters |
| Description | Description of the media item. | No | 50,000 characters |
| File | File object. | N/A | 70 MB for image files. 200 MB for document files, such as PDFs. |
| System | List of system attributes for a media item. | N/A | N/A |
The maximum number of media items is 250,000.
Taxonomies
The following table describes the data model for taxonomies.
| Field type | Description | Required | Limit |
|---|---|---|---|
| ID | Taxonomy ID that must be unique across taxonomies and cannot start with the word taxonomy. It must be alphanumeric, and can contain underscores, and hyphens. | Yes | 40 characters |
| Name | Name for the taxonomy, displayed in the app. | Yes | 50 characters |
| Value ID | Value ID that must be unique within a taxonomy. It must be alphanumeric, and can contain underscores and hyphens. | Yes | 50 characters |
| Value Name | Name for the value within the taxonomy. | Yes | 50 characters |
The maximum number of taxonomies is 300, and the maximum number of values within a taxonomy is 100.
System attributes
A response also includes the following system attributes:
| Attributes | Description |
|---|---|
| Locale | The locale assigned to the entity. |
| sourceLocale | The locale of the primary content item. |
| Primary | The type of content item. A primary content item is the original content item that was localized to other locales. |
| Type | The type of entity or operation (publish, unpublish). |
| Version | The version of the entity. |
| Status | The status of the entity. |
| CreatedBy | The user who created the entity. |
| CreatedAt | Time when the entity was created. |
| lastPublishProgress | The last publishing status of a content or media item. For items that have never been published, such as a newly created content item, the values will be null. The lastPublishProgress attribute includes the following sub-types.type - indicates whether it is a Publish or Unpublish event. The values can be Publish/Unpublish.lastPublishProgress.status - Indicates the status of the last publishing event. Values: In Progress, Completed, Failed.lastPublishProgress.triggeredBy - indicates who triggered the last publishing or unpublishing event.lastPublishProgress.triggeredAt -indicates when the last publishing or unpublishing event was triggered. |
| PublishedBy | The user who last published the entity. |
| PublishedAt | Time when the entity was last published. |
| UpdatedBy | The user who last modified the entity. |
| UpdatedAt | Time when the entity was last modified. |
You cannot modify system attributes.
| Field name | Description | Required | Limit |
|---|---|---|---|
| Name | Name of the field. | Yes | 40 characters |
| ID | User or system generated identifier of a field in the content type. It must be alphanumeric, with no spaces or other special characters (including underscores). You can use a period as long as it is not at the end of the ID. | Yes | 40 characters |
| Type | Type of field. | Yes | N/A |
| Required | Boolean field that defines whether a field is mandatory. | N/A | N/A |
| Help text | Supplemental text explaining the purpose or use of a field. Text is displayed beneath the field. | No | 100 characters |
The maximum number of fields per content type is 50.
The ID must be unique per content type, and it cannot be changed after the content type has been saved.