{ "openapi": "3.0.4", "info": { "title": "Content Management API", "description": "Use the XM Cloud Content Management API to build a content model that structures and organizes your data. Content types make up the content model while the content items contain the data itself. The API definitions are written in JSON.\n{% admonition type=\"info\" name=\"Note\" %}A `name` field can be alphanumeric, and can contain periods, underscores, and hyphens, but not spaces or other special characters. It cannot start with an underscore. The `dateTime` format is ISO 8601. {% /admonition %}\n## Authentication\n\nTo use this REST API, you must authorize your API requests. To do this, you\nneed the following information:\n\n - The URL of your XM Cloud Content server (for example, `cs-cmapi.sitecorecloud.io` or a [custom hostname](https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/custom-hostnames.html)).\n - The environment ID (for example, `main`).\n\nTo use the Try it feature, enter this information on the Environments tab, by hovering your mouse over the variable and then clicking Edit.\nTokens are used for API security. You need to generate an OAuth client bearer token and use it to authenticate. A successful authentication request requires the following credential properties: `oauth2_client_id`, the `oauth2_client_secret`, or an `oauth2_token`.\n### Create an OAuth client bearer token\n\n{% admonition type=\"info\" name=\"Note\" %}The Settings menu is only\nvisible if you have the Admin role.{%\n /admonition %}\n\nTo create an OAuth client bearer token:\n\n 1. In XM Cloud Content, on the menu bar, click Settings.\n 2. In the left pane, click Content management API.\n 3. On the Content management API page, in the Grant type section, click Client credentials.\n 4. Copy the following credentials and paste them into your development tool, and then execute the Generate token method:\n\n - Client ID - The client ID for XM Cloud Content.\n - Client secret - The client secret for the XM Cloud Content.\n - Audience - The audience for your tenant. This will be in the form `https://api.sitecorecloud.io`.\n - Authority - The authority for your tenant. This is the POST URL, in the form `https://auth.sitecorecloud.io/oauth/token`.", "license": { "name": "closed source", "url": "https://www.sitecore.com" }, "version": "v2.0", "x-metadata": { "product": "SitecoreAI Content" } }, "servers": [ { "url": "https://{server}", "variables": { "server": { "default": "edge-platform.sitecorecloud.io/cs", "description": "The base server URL." } } } ], "security": [ { "OAuth2.0": [] } ], "tags": [ { "name": "Content items", "description": "A content item contains data that aligns with the data model and is structured according to the content type." }, { "name": "Content types", "description": "A content type defines the content structure, or schema, for a page type and is tailored to a particular use case. It contains various field types, such as rich text, date and time, boolean, number, reference, and so on. For example, a product catalog typically includes individual pages for each product, with each page displaying a product image, a title, a short description, a price, and an inventory counter. The Product content type that supports this structure includes:\n - A short text field (title)\n - A rich text field (short description)\n - A number field (price)\n - A number field (inventory counter)\n - A media fragment (product image)\n - A reference field for a detailed specification PDF\n\n{% admonition type=\"info\" name=\"Note\"%}Private fields are used by the Delivery API and are available in preview. They are not available in the delivery schema.{% /admonition %}\nA content type can include a fragment. Fragments let you:\n - Extend content types by reusing fields. This is useful when there are multiple content types that use a similar set of fields. This lets you manage the common field set centrally.\n - Define a common schema for a set of fields that can be used in multiple content types and which updates dynamically when changes are made.\n - Initiate an action. For example, the `XMCMedia` content type includes a media fragment that retrieves media using its file ID from a defined URI and path.\n - In GraphQL, an interface is created for every fragment. For example, for a fragment called `Page`, each specific page type can have its own fields. The `Page` interface provides a way to query all pages collectively.\n\n{% admonition type=\"info\" name=\"Important\" %}When you change a fragment, you are changing the schema. When the fragment is published, your changes will be applied everywhere the fragment is used.{%\n /admonition %}" }, { "name": "Branches", "description": "A branch is an isolated workspace that contains its own set of content types, content items, and media. Every branch is created from the `main` branch and maintains a connection to it. This lets you experiment without impacting the original content repository. When you change the items in one branch, it does not affect the other branches or the `main` branch." }, { "name": "Locales", "description": "A locale is an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). For example, the locale for American English is `en-US` and for British English is `en-GB`. The region code is optional." }, { "name": "Taxonomies", "description": "A taxonomy contains a list of terms that you can associate with content items, making it easier to find those items because of their common properties. For example, a taxonomy for a sporting goods site could be used to classify sportswear into running clothes, running shoes, and accessories." }, { "name": "Users", "description": "An XM Cloud Content user is someone who is logged into the XM Cloud Content system. You can retrieve the first and last name of a specific user." }, { "name": "Worksets", "description": "A workset brings content items, content types, and taxonomies together in a group and allows you to execute tasks on it." }, { "name": "Tasks", "description": "A task is an operation that executes across a workset and the content items, content types, and taxonomies it contains (for example, you could create a task to publish all content items in a workset)." }, { "name": "Task types", "description": "A task type defines a process that can be executed as a task on a workset. An example of a task type is `Publishing` or `Validation`. There are two types of external tasks:\n - Those that are actions (`isAction: true`) associated with a content type or fragment and executed on a single item in a workset.\n - Those executed on an entire workset (`isAction: false`). These external tasks can issue callback requests to send tasks." }, { "name": "Jobs", "description": "A job consists of tasks that are to be executed on a workset." }, { "name": "Job types", "description": "A job type is a sequence of processes to execute on a workset." } ], "x-tagGroups": [ { "name": "Content endpoints", "tags": [ "Content items", "Content types", "Taxonomies" ] }, { "name": "Branch endpoints", "tags": [ "Branches" ] }, { "name": "Localization endpoints", "tags": [ "Locales" ] }, { "name": "Workset endpoints", "tags": [ "Worksets", "Job types", "Jobs", "Task types", "Tasks" ] }, { "name": "Security endpoints", "tags": [ "Users" ] } ], "paths": { "/api/v2/cm/branches/{branchId}/content-items/{contentItemId}": { "delete": { "tags": [ "Content items" ], "summary": "Delete a content item", "description": "Deletes a content item with a specific ID. You can only delete content items with a DRAFT status.", "operationId": "DeleteContentItem", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The content item identifier, for example `mmdvOOpQH0CY4QRLztHflg`.", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "The IETF language tag, for example, `en-US`.", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version, for example `1`.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "Successful deletion" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Content items" ], "summary": "Retrieve a content item", "description": "Retrieves a content item from a specific branch using its ID.", "operationId": "ContentItemById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The content item identifier, for example `mmdvOOpQH0CY4QRLztHflg`.", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "The IETF language tag, for example, `en-US`.", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the content item, for example `1`.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Content items" ], "summary": "Partially update a content item", "description": "Partially updates the content item, replacing only those fields provided in the request.", "operationId": "PatchContentItem", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The ID of the content item, for example `8cwa-M3RYUSfdCSeP_YuSQ`.", "required": true, "schema": { "type": "string" } }, { "name": "x-cs-revisionId", "in": "header", "description": "The hash version of the content item, for example `8cwa-M3RYUSfdCSeP_YuSQ`.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "The IETF language tag, for example, `en-US`.", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The content item version, for example `1` .", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Parameter containing the content item details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentItemPatchRequest" }, "example": { "requestData": { "name": "Patched Content Item Name", "label": "Patched Content Item Label", "fields": { "TextFieldName": { "value": "Example text value", "type": "Text" }, "BooleanFieldName": { "value": true, "type": "Boolean" }, "NumberFieldName": { "value": 42, "type": "Number" }, "DateTimeFieldName": { "value": "2024-08-01T12:00:00Z", "type": "DateTime" }, "RichTextFieldName": { "value": { "firstParagraph": [ "This is rich text." ], "secondParagraph": [ "Another paragraph." ] }, "type": "RichText" }, "JsonFieldName": { "value": { "key1": [ 1, 2, 3 ], "key2": [ "a", "b", "c" ] }, "type": "Json" }, "ReferenceFieldName": { "value": [ { "RelatedType": 1, "Id": "referenceItemId" } ], "type": "Reference" }, "SelectFieldName": { "value": [ { "Id": "selectOptionId" } ], "type": "Select" } }, "versionTags": [ "versionTag1", "versionTag2" ] } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemPatchRequest" }, "example": { "requestData": { "name": "Patched Content Item Name", "label": "Patched Content Item Label", "fields": { "TextFieldName": { "value": "Example text value", "type": "Text" }, "BooleanFieldName": { "value": true, "type": "Boolean" }, "NumberFieldName": { "value": 42, "type": "Number" }, "DateTimeFieldName": { "value": "2024-08-01T12:00:00Z", "type": "DateTime" }, "RichTextFieldName": { "value": { "firstParagraph": [ "This is rich text." ], "secondParagraph": [ "Another paragraph." ] }, "type": "RichText" }, "JsonFieldName": { "value": { "key1": [ 1, 2, 3 ], "key2": [ "a", "b", "c" ] }, "type": "Json" }, "ReferenceFieldName": { "value": [ { "RelatedType": 1, "Id": "referenceItemId" } ], "type": "Reference" }, "SelectFieldName": { "value": [ { "Id": "selectOptionId" } ], "type": "Select" } }, "versionTags": [ "versionTag1", "versionTag2" ] } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemPatchRequest" }, "example": { "requestData": { "name": "Patched Content Item Name", "label": "Patched Content Item Label", "fields": { "TextFieldName": { "value": "Example text value", "type": "Text" }, "BooleanFieldName": { "value": true, "type": "Boolean" }, "NumberFieldName": { "value": 42, "type": "Number" }, "DateTimeFieldName": { "value": "2024-08-01T12:00:00Z", "type": "DateTime" }, "RichTextFieldName": { "value": { "firstParagraph": [ "This is rich text." ], "secondParagraph": [ "Another paragraph." ] }, "type": "RichText" }, "JsonFieldName": { "value": { "key1": [ 1, 2, 3 ], "key2": [ "a", "b", "c" ] }, "type": "Json" }, "ReferenceFieldName": { "value": [ { "RelatedType": 1, "Id": "referenceItemId" } ], "type": "Reference" }, "SelectFieldName": { "value": [ { "Id": "selectOptionId" } ], "type": "Select" } }, "versionTags": [ "versionTag1", "versionTag2" ] } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentItemPatchRequest" }, "example": { "requestData": { "name": "Patched Content Item Name", "label": "Patched Content Item Label", "fields": { "TextFieldName": { "value": "Example text value", "type": "Text" }, "BooleanFieldName": { "value": true, "type": "Boolean" }, "NumberFieldName": { "value": 42, "type": "Number" }, "DateTimeFieldName": { "value": "2024-08-01T12:00:00Z", "type": "DateTime" }, "RichTextFieldName": { "value": { "firstParagraph": [ "This is rich text." ], "secondParagraph": [ "Another paragraph." ] }, "type": "RichText" }, "JsonFieldName": { "value": { "key1": [ 1, 2, 3 ], "key2": [ "a", "b", "c" ] }, "type": "Json" }, "ReferenceFieldName": { "value": [ { "RelatedType": 1, "Id": "referenceItemId" } ], "type": "Reference" }, "SelectFieldName": { "value": [ { "Id": "selectOptionId" } ], "type": "Select" } }, "versionTags": [ "versionTag1", "versionTag2" ] } } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Content items" ], "summary": "Create a new version of a content item", "description": "Creates a new version of a content item with the same ID as the original, but the version number is updated (for example, from `1` to `2`). You can work on the versions independently.", "operationId": "AddNewVersionContentItem", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The content item identifier, for example `mmdvOOpQH0CY4QRLztHflg`.", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "The IETF language tag, for example, `en-US`.", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the content item details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Content items" ], "summary": "Update a content item", "description": "Updates a content item with a specific ID, locale, and version. You can, for example, add or modify content, delete existing content, or change properties associated with the content (such as taxonomy terms). {% admonition type=\"info\" name=\"Note\" %} The Update method replaces the existing content item with the request body. It does not merge content. Therefore, your request must include the new version of the content, including both updates and any data you want to retain. Anything not included in your request will be lost. {% /admonition %}", "operationId": "UpdateContentItem", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The ID of the content item, for example `8cwa-M3RYUSfdCSeP_YuSQ`.", "required": true, "schema": { "type": "string" } }, { "name": "x-cs-revisionId", "in": "header", "description": "The hash version of the content item, for example `1IcUUQq73YFLLyzQkWt71D`.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "The IETF language tag, for example, `en-US`.", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The content item version, for example `1` .", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Parameter containing the content item details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentItemUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/versions": { "get": { "tags": [ "Content items" ], "summary": "Retrieve the versions and statuses of a content item", "description": "Lists the versions and statuses of a specific content item, in a specific branch.", "operationId": "ContentItemVersionsStatusesById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The content item identifier, for example `mmdvOOpQH0CY4QRLztHflg`.", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "The IETF language tag, for example, `en-US`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionsStatusesListResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-items": { "get": { "tags": [ "Content items" ], "summary": "Retrieve a list of content items", "description": "Lists all the content items in a specific branch. If you don't specify any filtering parameters, you will retrieve all available content items.", "operationId": "GetContentItems", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "View", "in": "query", "schema": { "pattern": "includeFieldsData", "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "fragment.id", "in": "query", "schema": { "type": "string" } }, { "name": "fragment.key", "in": "query", "schema": { "type": "string" } }, { "name": "system.contentType.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.contentType.name", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.status", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "linkedTo", "in": "query", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "system.availabilityDate.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.availabilityDate.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "latestVersion", "in": "query", "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string" } }, { "name": "taxonomy[{taxonomyId}].id", "in": "query", "description": "Filter by a taxonomy term. Replace `{taxonomyId}` with the taxonomy ID you want to filter by and set the value to the term ID you want to use, for example, `taxonomy[56TqdLYFoShmYA1mfJn0PX].id = 3GfL56YUvmCHg2u2d4ohOa`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemResourceContentItemListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Content items" ], "summary": "Create a content item", "description": "Creates a new content item based on a specific content type. It is the content type that determines the structure of the content.", "operationId": "AddContentItem", "parameters": [ { "name": "branchId", "in": "path", "description": "The name of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the content type details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentItemCreateRequest" }, "example": { "locale": "ExampleLocale", "contentTypeId": "ExampleContentTypeId", "fields": { "ExampleBoolFieldId": { "value": true }, "ExampleTextId": { "value": "This is an example of a text field. It can contain more detailed information and span multiple lines if needed." }, "ExampleRichTextId": { "value": "

This is an example of a rich text field. It can include HTML tags for formatting.

" }, "ExampleDateFieldId": { "value": "2024-07-10T12:34:56.1234567Z" }, "ExampleNumberFieldId": { "value": 200.5 }, "ExampleSelectFieldId": { "value": [ { "name": "red" }, { "name": "white" } ] }, "ExampleJsonFieldId": { "value": "{\"ExampleProperty1\":\"ExamplePropertyValue1\",\"ExampleProperty2\":123,\"ExampleProperty3\":true}" } }, "name": "ExampleName", "label": null, "versionTags": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemCreateRequest" }, "example": { "locale": "ExampleLocale", "contentTypeId": "ExampleContentTypeId", "fields": { "ExampleBoolFieldId": { "value": true }, "ExampleTextId": { "value": "This is an example of a text field. It can contain more detailed information and span multiple lines if needed." }, "ExampleRichTextId": { "value": "

This is an example of a rich text field. It can include HTML tags for formatting.

" }, "ExampleDateFieldId": { "value": "2024-07-10T12:34:56.1234567Z" }, "ExampleNumberFieldId": { "value": 200.5 }, "ExampleSelectFieldId": { "value": [ { "name": "red" }, { "name": "white" } ] }, "ExampleJsonFieldId": { "value": "{\"ExampleProperty1\":\"ExamplePropertyValue1\",\"ExampleProperty2\":123,\"ExampleProperty3\":true}" } }, "name": "ExampleName", "label": null, "versionTags": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemCreateRequest" }, "example": { "locale": "ExampleLocale", "contentTypeId": "ExampleContentTypeId", "fields": { "ExampleBoolFieldId": { "value": true }, "ExampleTextId": { "value": "This is an example of a text field. It can contain more detailed information and span multiple lines if needed." }, "ExampleRichTextId": { "value": "

This is an example of a rich text field. It can include HTML tags for formatting.

" }, "ExampleDateFieldId": { "value": "2024-07-10T12:34:56.1234567Z" }, "ExampleNumberFieldId": { "value": 200.5 }, "ExampleSelectFieldId": { "value": [ { "name": "red" }, { "name": "white" } ] }, "ExampleJsonFieldId": { "value": "{\"ExampleProperty1\":\"ExamplePropertyValue1\",\"ExampleProperty2\":123,\"ExampleProperty3\":true}" } }, "name": "ExampleName", "label": null, "versionTags": null } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentItemCreateRequest" }, "example": { "locale": "ExampleLocale", "contentTypeId": "ExampleContentTypeId", "fields": { "ExampleBoolFieldId": { "value": true }, "ExampleTextId": { "value": "This is an example of a text field. It can contain more detailed information and span multiple lines if needed." }, "ExampleRichTextId": { "value": "

This is an example of a rich text field. It can include HTML tags for formatting.

" }, "ExampleDateFieldId": { "value": "2024-07-10T12:34:56.1234567Z" }, "ExampleNumberFieldId": { "value": 200.5 }, "ExampleSelectFieldId": { "value": [ { "name": "red" }, { "name": "white" } ] }, "ExampleJsonFieldId": { "value": "{\"ExampleProperty1\":\"ExamplePropertyValue1\",\"ExampleProperty2\":123,\"ExampleProperty3\":true}" } }, "name": "ExampleName", "label": null, "versionTags": null } } }, "required": true }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "409": { "description": "Conflict" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/copy": { "post": { "tags": [ "Content items" ], "summary": "Create a copy of a content item with a new locale", "description": "Creates a copy of a content item with a new locale. The original and the copy have the same ID and version number. The original content item and the copy can be worked on and published independently. To create a copy, locales must already be defined.", "operationId": "CopyContentItem", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentItemId", "in": "path", "description": "The ID of the content item, for example `8cwa-M3RYUSfdCSeP_YuSQ`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The content item version, for example `1` .", "schema": { "type": "integer", "format": "int32" } }, { "name": "sourceLocale", "in": "query", "description": "The source locale of the content item. A locale is the IETF language tag, for example, `en-US`.", "schema": { "type": "string" } }, { "name": "destinationLocale", "in": "query", "description": "The destination locale of the content item. A locale is the IETF language tag, for example, `fr-FR`.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}": { "delete": { "tags": [ "Content types" ], "summary": "Delete a content type", "description": "Deletes a content type that is no longer needed. The content type must have a `DRAFT` status and no linked content items.", "operationId": "DeleteContentType", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The content type identifier, for example `1jUvDOTMA3sWkBM17Z1nI3`", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the content type, for example `1`. If this is `null`, the latest version is assumed.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "Successful deletion" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Content types" ], "summary": "Retrieve a content type", "description": "Retrieves a content type from a specific branch using its ID.", "operationId": "ContentTypeByIdentifier", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The content type ID, for example `4c2PuJUHuIgClc5NWDaGav`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the content type, for example `1`.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Content types" ], "summary": "Partially update a content type", "description": "Partially updates the content type, replacing only those fields provided in the request.", "operationId": "PatchContentType", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The ID of the content type, for example `8cwa-M3RYUSfdCSeP_YuSQ`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the content type.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Parameter containing the content type details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentTypePatchRequest" }, "example": { "requestData": { "name": "Patched Content Type Name", "label": "Patched Content Type Label", "description": "Patched description for the content type.", "isDirectQuery": true, "isPrivate": false, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } } } ], "fragments": [ "fragment1", "fragment2" ], "fragmentKey": "fragmentKey1", "versionTags": [ "versionTag1", "versionTag2" ] } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypePatchRequest" }, "example": { "requestData": { "name": "Patched Content Type Name", "label": "Patched Content Type Label", "description": "Patched description for the content type.", "isDirectQuery": true, "isPrivate": false, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } } } ], "fragments": [ "fragment1", "fragment2" ], "fragmentKey": "fragmentKey1", "versionTags": [ "versionTag1", "versionTag2" ] } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentTypePatchRequest" }, "example": { "requestData": { "name": "Patched Content Type Name", "label": "Patched Content Type Label", "description": "Patched description for the content type.", "isDirectQuery": true, "isPrivate": false, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } } } ], "fragments": [ "fragment1", "fragment2" ], "fragmentKey": "fragmentKey1", "versionTags": [ "versionTag1", "versionTag2" ] } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentTypePatchRequest" }, "example": { "requestData": { "name": "Patched Content Type Name", "label": "Patched Content Type Label", "description": "Patched description for the content type.", "isDirectQuery": true, "isPrivate": false, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } } } ], "fragments": [ "fragment1", "fragment2" ], "fragmentKey": "fragmentKey1", "versionTags": [ "versionTag1", "versionTag2" ] } } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "409": { "description": "Conflict" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Content types" ], "summary": "Create a new version of a content type", "description": "Creates a copy of a content type with the same ID as the original, but the version number is updated (for example, from `1` to `2`). You can work on the versions independently. During this process you can also create associated content type values, even if you want to add more later.", "operationId": "AddNewVersionContentType", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The ID of the content type, for example `color`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the content type request.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } } }, "required": true }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "409": { "description": "Conflict" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Content types" ], "summary": "Update a content type", "description": "Updates a content type with a specific ID. {% admonition type=\"info\" name=\"Note\" %} The Update method replaces the existing content type with the request body. It does not merge content. Therefore, your request must include the new version of the content type, including both updates and any data you want to retain. Anything not included in your request will be lost. {% /admonition %}", "operationId": "UpdateContentType", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The ID of the content type to update, for example `8cwa-M3RYUSfdCSeP_YuSQ`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the content type.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Parameter containing the content type details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentTypeUpdateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "versionTags": null, "fields": [ { "id": "text-field-id", "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": false, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "id": "rich-text-field-id", "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": false, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "id": "boolean-field-id", "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "id": "datetime-field-id", "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "id": "reference-field-id", "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "id": "select-field-id", "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "id": "json-field-id", "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "409": { "description": "Conflict" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-types": { "get": { "tags": [ "Content types" ], "summary": "Retrieve a list of content types", "description": "Lists all defined content types. If you don't specify any filtering parameters, you will retrieve all available content types.", "operationId": "ContentTypesList", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "system.status", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.availabilityDate.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.availabilityDate.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "isFragment", "in": "query", "schema": { "type": "string" } }, { "name": "fragment.id", "in": "query", "schema": { "type": "string" } }, { "name": "fragment.key", "in": "query", "schema": { "type": "string" } }, { "name": "latestVersion", "in": "query", "schema": { "type": "string" } }, { "name": "taxonomy.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResponseListResult" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Content types" ], "summary": "Create a content type", "description": "Creates a content type to structure content for a particular purpose.", "operationId": "AddContentType", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the content type details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "fields": [ { "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": true, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": true, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null, "versionTags": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "fields": [ { "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": true, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": true, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null, "versionTags": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "fields": [ { "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": true, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": true, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null, "versionTags": null } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreateRequest" }, "example": { "name": "Example Content Type", "label": "Example Content Type Label", "isDirectQuery": null, "fields": [ { "name": "Text Field Name", "label": "Text Field Label", "type": "Text", "required": true, "helpText": "This is a text field used for storing simple text values.", "priorityField": true, "isPrivate": true, "singleLineText": true, "rules": { "length": { "min": 1, "max": 255 }, "regexp": { "value": "^[a-zA-Z0-9 ]*$" } }, "defaultValues": { "": "text", "en-US": "text", "en-GB": "text" } }, { "name": "Rich Text Field", "label": "Rich Text Label", "type": "RichText", "required": true, "helpText": "Enter rich text content", "priorityField": true, "isPrivate": true, "rules": { "length": { "min": 5, "max": 255 } }, "defaultValues": { "": { "firstParagraph": { "text": "Sample rich text (default locale).", "type": "paragraph" } }, "en-US": { "firstParagraph": { "text": "Sample rich text (en-US).", "type": "paragraph" } }, "en-GB": { "firstParagraph": { "text": "Sample rich text (en-GB).", "type": "paragraph" } } } }, { "name": "Boolean Field Name", "label": "Boolean Field Label", "type": "Boolean", "required": false, "helpText": "This is a boolean field used for true/false values.", "priorityField": false, "isPrivate": false, "defaultValues": { "": true, "en-US": true, "en-GB": true } }, { "name": "DateTime Field Name", "label": "DateTime Field Label", "type": "DateTime", "required": false, "helpText": "This is a date-time field used for storing date and time values.", "priorityField": false, "isPrivate": false, "rules": { "dateTimeRange": { "min": "2024-07-10T12:34:56.1234567Z", "max": "2024-12-31T10:03:16.0000000Z" }, "isFutureDate": { "value": true } }, "defaultValues": { "": "2024-07-10T12:34:56.0000000Z", "en-US": "2024-07-10T12:34:56.0000000Z" } }, { "name": "Reference Field Name", "label": "Reference Field Label", "type": "Reference", "required": false, "helpText": "This is a reference field used for linking to other content items.", "priorityField": false, "isPrivate": false, "rules": { "countLimit": { "min": 1, "max": 5 }, "referencetypes": { "values": [ "item", "media" ] } }, "defaultValues": { "": [ "id1", "id2" ], "en-US": [ "id3", "id4" ] } }, { "name": "Select Field Name", "label": "Select Field Label", "type": "Select", "required": false, "helpText": "This is a select field used for choosing from predefined options.", "priorityField": false, "isPrivate": false, "reference": { "id": "reference-id" }, "rules": { "countLimit": { "min": 1, "max": 5 } }, "defaultValues": { "": [ { "id": "id1" } ] } }, { "name": "JSON Field Name", "label": "JSON Field Label", "type": "Json", "required": true, "helpText": "This is a JSON field used for storing structured data in JSON format.", "priorityField": false, "isPrivate": false, "rules": { "length": { "min": 10, "max": 1000 } }, "defaultValues": { "": { "foo": 1 }, "en-US": { "foo": 1 }, "en-GB": { "foo": 1 } } } ], "fragments": [], "fragmentKey": null, "versionTags": null } } } }, "responses": { "201": { "description": "Content type successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/versions": { "get": { "tags": [ "Content types" ], "summary": "Retrieve the versions and statuses of a content type", "description": "Lists the versions and statuses of a content type from a specific branch.", "operationId": "ContentTypeVersionsStatusesById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The content type identifier, for example `mmdvOOpQH0CY4QRLztHflg`.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "New version successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionsStatusesListResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found" }, "500": { "description": "Server-side exception during request execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/copy": { "post": { "tags": [ "Content types" ], "summary": "Create a new version of a content type", "description": "Creates a copy of a content type with the same ID as the original, but the version number is updated (for example, from `1` to `2`). You can work on the versions independently. During this process you can also create associated content type values, even if you want to add more later.", "operationId": "CopyContentType", "parameters": [ { "name": "branchId", "in": "path", "description": "The name of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "contentTypeId", "in": "path", "description": "The ID of the content type, for example `color`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the content type.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "New version successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v2/cm/branches/{branchId}": { "delete": { "tags": [ "Branches" ], "summary": "Delete a branch", "description": "Deletes a branch with a specific ID. Deleting a branch does not affect the main branch.", "operationId": "BranchDelete", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "get": { "tags": [ "Branches" ], "summary": "Retrieve a branch by its ID", "description": "Retrieves a branch using its ID.", "operationId": "EnvironmentById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchResource" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Branches" ], "summary": "Update a branch", "description": "Updates the details associated with a branch with a specific ID.", "operationId": "EnvironmentUpdate", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch to update, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The branch to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BranchUpdateResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BranchUpdateResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BranchUpdateResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BranchUpdateResource" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchResource" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches": { "get": { "tags": [ "Branches" ], "summary": "Retrieve all branches", "description": "Lists all available branches.", "operationId": "AllEnvironments", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchListResult" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Branches" ], "summary": "Create a branch", "description": "Creates a new branch. {% admonition type=\"info\" name=\"Note\"%}Branch names must be unique. A maximum of five branches per tenant is supported.{% /admonition %}", "operationId": "AddEnvironment", "requestBody": { "description": "The branch to add.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BranchCreateResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BranchCreateResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BranchCreateResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BranchCreateResource" } } }, "required": true }, "responses": { "201": { "description": "Branch successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchResourceResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/locales/{localeId}": { "delete": { "tags": [ "Locales" ], "summary": "Delete a locale", "description": "Deletes a locale with a specific ID (for example, `en-US`). You cannot delete\na locale if it is being used by a content item or if it is the default locale.", "operationId": "DeleteLocale", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch for example `main`.", "required": true, "schema": { "type": "string" } }, { "name": "localeId", "in": "path", "description": "The locale identifier, for example `en-US`.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion." }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "get": { "tags": [ "Locales" ], "summary": "Retrieve a locale", "description": "Retrieves a locale with a specific ID, for example `sv-SE`.", "operationId": "LocaleById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `main`.", "required": true, "schema": { "type": "string" } }, { "name": "localeId", "in": "path", "description": "The locale identifier, for example `sv-SE`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Locales" ], "summary": "Update a locale", "description": "Updates a locale. For example, to update the name of a locale that is being changed from `French(France)` to `French(fr-FR)`.", "operationId": "UpdateLocale", "parameters": [ { "name": "branchId", "in": "path", "description": "The name of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "localeId", "in": "path", "description": "The ID of the locale, for example, `da-DK`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the locale details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LocaleUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocaleUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocaleUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LocaleUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/locales": { "get": { "tags": [ "Locales" ], "summary": "Retrieve a list of locales", "description": "Lists all defined locales. If you don't specify any filtering parameters, you will retrieve all available locales.", "operationId": "GetLocales", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Locales" ], "summary": "Create a locale", "description": "Creates a locale (for example, create a locale called `es-CL` for\nSpanish(Chile) and set it as the default locale). A locale consists of a\ntwo- or three-letter language code and a two- or three-letter region code.\nThe region code is optional (for example, English can be defined as en or eng).", "operationId": "AddLocale", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the locale details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LocaleCreateRequest" }, "example": { "id": "en-US", "label": "English", "default": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocaleCreateRequest" }, "example": { "id": "en-US", "label": "English", "default": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocaleCreateRequest" }, "example": { "id": "en-US", "label": "English", "default": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LocaleCreateRequest" }, "example": { "id": "en-US", "label": "English", "default": false } } }, "required": true }, "responses": { "201": { "description": "Locale successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}": { "delete": { "tags": [ "Taxonomies" ], "summary": "Delete a taxonomy", "description": "Deletes a taxonomy with a specific ID. You cannot delete a taxonomy if it is being used by a content type.", "operationId": "DeleteTaxonomy", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taxonomyId", "in": "path", "description": "The ID of the taxonomy, for example `color`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the taxonomy, for example `1`.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "Successful deletion." }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "get": { "tags": [ "Taxonomies" ], "summary": "Retrieve a taxonomy", "description": "Retrieves a taxonomy with a specific ID for example `color`.", "operationId": "TaxonomyById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taxonomyId", "in": "path", "description": "The ID of the taxonomy, for example `color`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the taxonomy.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Taxonomies" ], "summary": "Create a new version of a taxonomy", "description": "Creates a copy of a taxonomy with the same ID as the original, but the version number is updated (for example, from `1` to `2`). You can work on the versions independently.", "operationId": "AddNewVersionTaxonomy", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taxonomyId", "in": "path", "description": "The ID of the taxonomy, for example `running`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the taxonomy request.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } } }, "required": true }, "responses": { "201": { "description": "New version created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Taxonomies" ], "summary": "Update a taxonomy", "description": "Updates a taxonomy. You can, for example, add new taxonomy terms, delete existing terms, or change properties associated with the taxonomy or its terms.", "operationId": "UpdateTaxonomy", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taxonomyId", "in": "path", "description": "The ID of the taxonomy, for example `color`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the taxonomy, for example `1`", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Parameter containing the taxonomy details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaxonomyUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/versions": { "get": { "tags": [ "Taxonomies" ], "summary": "Retrieve the versions and statuses of a taxonomy", "description": "Lists the versions and statuses of a specific taxonomy, in a specific branch.", "operationId": "TaxonomyVersionsStatusesById", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taxonomyId", "in": "path", "description": "The ID of the taxonomy, for example `color`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionsStatusesListResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/taxonomies": { "get": { "tags": [ "Taxonomies" ], "summary": "Retrieve a list of taxonomies", "description": "Lists all defined taxonomies. If you don't specify any filtering parameters, you will retrieve all available taxonomies.", "operationId": "GetTaxonomies", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "system.status", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.createdAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.updatedAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedBy.id", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedAt.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.publishedAt.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.availabilityDate.startDate", "in": "query", "schema": { "type": "string" } }, { "name": "system.availabilityDate.endDate", "in": "query", "schema": { "type": "string" } }, { "name": "latestVersion", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Taxonomies" ], "summary": "Create a taxonomy", "description": "Creates a taxonomy. A taxonomy contains a list of terms that you can associate with content items, making it easier to find those items because of their common properties. For example, a taxonomy for a sporting goods site can classify items into running clothes, running shoes, and accessories. As part of the taxonomy creation process, you create the associated taxonomy terms. You can add additional terms later if required.", "operationId": "AddTaxonomy", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameter containing the taxonomy request.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaxonomyCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxonomyCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaxonomyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/copy": { "post": { "tags": [ "Taxonomies" ], "summary": "Copy a taxonomy", "description": "Creates a copy of a taxonomy with the same ID as the original, but the version number is updated (for example, from `1` to `2`). You can work on the versions independently.", "operationId": "CopyTaxonomy", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taxonomyId", "in": "path", "description": "The ID of the taxonomy, for example `color`.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The version of the taxonomy, for example `1`", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Retrieve a user by ID", "description": "Retrieves the first and last name of a user using their ID along with their authId, organization ID, and type of user.", "operationId": "GetUserById", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the user, for example `6Ioy0AbFz5Xv5C6mWJXgoF`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Users" ], "summary": "Update a user", "description": "Updates the first or last name of a user with a specific ID.", "operationId": "UpdateUser", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the user.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Nothing to update" }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/users/auth/{auth0Id}": { "get": { "tags": [ "Users" ], "summary": "Retrieve a user using their authorization ID", "description": "Retrieves the first and last name of a user based on their email\naddress.The email address is a unique identifier for the user.This\nrequest retrieves the first and last name of a specific Content Hub ONE user using the User ID", "operationId": "GetUserByAuthId", "parameters": [ { "name": "auth0Id", "in": "path", "description": "The auth ID of the user, for example `auth0|30a022c29056d6663266bdg0`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/users": { "get": { "tags": [ "Users" ], "summary": "Retrieve a list of users", "description": "Lists all users with accounts define for a specific XM Cloud Content instance. If you don't specify any filtering parameters, you will retrieve all available users.", "operationId": "GetUsers", "parameters": [ { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Request does not contain required scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/jobs/{jobId}": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve job details", "description": "Lists information about a specific job. This is useful, for example, when you want to get the provisioning status using the task identifier.", "operationId": "GetJob", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The unique identifier of job details.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobGetResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/jobs": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve a list of job details", "description": "Lists job details and associated information. If you don't specify any filtering parameters, you will retrieve all workset chain execution details.", "operationId": "GetListJob", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Jobs" ], "summary": "Create chain execution details for a workset and job", "description": "Creates execution details for a specific workset and job using their IDs.", "operationId": "CreateJob", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the job to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JobCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JobCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JobCreateRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve task details", "description": "Lists information about a specific task.", "operationId": "GetTask", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taskId", "in": "path", "description": "The unique identifier of the task details.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGetResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve a list of tasks", "description": "Lists tasks and associated details. If you don't specify any filtering parameters, you will retrieve all tasks.", "operationId": "GetListTask", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Tasks" ], "summary": "Create execution details for specific workset and task", "description": "Creates new execution details for a specific workset and task using their IDs.", "operationId": "CreateTask", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the task to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaskCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskCreateRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreateResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/tasks/{taskId}/items": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve details", "description": "Lists task details for a specific workset.", "operationId": "GetTaskItems", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taskId", "in": "path", "description": "The task identifier.", "required": true, "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskItemListResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback": { "post": { "tags": [ "Tasks" ], "summary": "Update task details", "description": "Updates the process status or statistics of a task.", "operationId": "CallbackUpdateTask", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taskId", "in": "path", "description": "The unique identifier of the task details.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the task to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaskUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskUpdateRequest" } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback/log": { "post": { "tags": [ "Tasks" ], "summary": "Log item failures for a task", "description": "This endpoint can be used by external tasks to report an error while processing a specific workset item as part of a workset execution.", "operationId": "CallbackLogItemFailures", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "taskId", "in": "path", "description": "The unique identifier of the task.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the item failures to log.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaskLogFailuresRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskLogFailuresRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskLogFailuresRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskLogFailuresRequest" } } } }, "responses": { "204": { "description": "Workset Item Execution Failure was successfully registered." }, "400": { "description": "Invalid object in request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token." }, "403": { "description": "Request does not contain required scopes." }, "404": { "description": "Task details not found using specified ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server side exception during request execution." } } } }, "/api/v2/cm/job-types/{jobTypeId}": { "delete": { "tags": [ "Job types" ], "summary": "Delete a job type", "description": "Deletes all the processes in the job type using its identifier.", "operationId": "DeleteJobType", "parameters": [ { "name": "jobTypeId", "in": "path", "description": "The unique identifier of the job.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion" }, "400": { "description": "Request not valid or error during operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Job type not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "get": { "tags": [ "Job types" ], "summary": "Retrieve a job type", "description": "Retrieves a specific job type using its identifier.", "operationId": "GetJobType", "parameters": [ { "name": "jobTypeId", "in": "path", "description": "The unique identifier of the job.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Job type not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Job types" ], "summary": "Update a job type", "description": "Updates a job type using its identifier.", "operationId": "UpdateJobType", "parameters": [ { "name": "jobTypeId", "in": "path", "description": "The unique identifier of the job type.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the updated details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Job type not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/job-types": { "get": { "tags": [ "Job types" ], "summary": "Retrieve a list of job types", "description": "Lists job types.", "operationId": "GetListJobType", "parameters": [ { "name": "SortBy", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobTypeResponse" } } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Job type not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Job types" ], "summary": "Create a job type", "description": "Creates a job type.", "operationId": "CreateJobType", "requestBody": { "description": "The request containing the details of the job type to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JobTypeRequest" } } } }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/task-types/{taskTypeId}": { "delete": { "tags": [ "Task types" ], "summary": "Delete a task type", "description": "Deletes a task type using its identifier.", "operationId": "DeleteTaskType", "parameters": [ { "name": "taskTypeId", "in": "path", "description": "The unique identifier of the task type.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mvc.ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Task type not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mvc.ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "get": { "tags": [ "Task types" ], "summary": "Retrieve a task type", "description": "Retrieves a specific task type using its identifier.", "operationId": "GetTaskType", "parameters": [ { "name": "taskTypeId", "in": "path", "description": "The unique identifier of the workset.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Task not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Task types" ], "summary": "Update a task type", "description": "Updates a task type using its identifier.", "operationId": "UpdateTaskType", "parameters": [ { "name": "taskTypeId", "in": "path", "description": "The unique identifier of the task type.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the task type to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mvc.ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Task type not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mvc.ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/task-types": { "get": { "tags": [ "Task types" ], "summary": "Retrieve a list of task types", "description": "Lists task types. If you don't specify any filtering parameters, \nyou will retrieve all task types.", "operationId": "GetListTaskType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTypeResponse" } } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Task type not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Task types" ], "summary": "Create a task type", "description": "Creates a new task type.", "operationId": "AddTaskType", "requestBody": { "description": "The request containing the details of the task type to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeRequest" } } } }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tasks.TaskTypeResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mvc.ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/worksets/{worksetId}": { "delete": { "tags": [ "Worksets" ], "summary": "Delete a workset", "description": "Deletes a workset. This does not delete the individual content items, content types, or taxonomies it contains {% admonition type=\"info\" name=\"Note\"%} You can only delete worksets that have not been used by a process. Worksets expire after 30 days. {% /admonition %}", "operationId": "DeleteWorkset", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "worksetId", "in": "path", "description": "The unique identifier of the workset.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "get": { "tags": [ "Worksets" ], "summary": "Retrieve a workset using its ID", "description": "Lists the items, options, and so on that are in a workset with a specific ID.", "operationId": "GetWorkset", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "worksetId", "in": "path", "description": "The unique identifier of the workset.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorksetResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "patch": { "tags": [ "Worksets" ], "summary": "Partially update a workset", "description": "Partially updates the content items, content types, and taxonomies that make up a particular workset using the following [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) operations: add, remove, replace, move, copy, and test.", "operationId": "PartialUpdateWorkSet", "parameters": [ { "name": "branchId", "in": "path", "description": "TThe ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "worksetId", "in": "path", "description": "The unique identifier of the workset.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the workset to update.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "204": { "description": "Successful update" }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "put": { "tags": [ "Worksets" ], "summary": "Update a workset", "description": "Updates a particular workset, including the content items, content types, taxonomies and so on.", "operationId": "UpdateWorkset", "parameters": [ { "name": "branchId", "in": "path", "description": "TThe ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "worksetId", "in": "path", "description": "The unique identifier of the workset.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the workset to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WorksetUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorksetUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorksetUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorksetUpdateRequest" } } } }, "responses": { "204": { "description": "Successful update." }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/worksets": { "get": { "tags": [ "Worksets" ], "summary": "Retrieve a list of worksets", "description": "Lists worksets that have been created. If you don't specify any filtering parameters, you will retrieve all available worksets.", "operationId": "GetListWorkset", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorksetListResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } }, "post": { "tags": [ "Worksets" ], "summary": "Create a workset", "description": "Creates a workset to hold a group of content items, content types, or taxonomies. This allows you to run tasks for the workset.", "operationId": "CreateWorkset", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the details of the workset to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WorksetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorksetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorksetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorksetRequest" } } } }, "responses": { "201": { "description": "Successful creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorksetResponse" } } } }, "400": { "description": "Request not valid or error during operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "500": { "description": "Server-side exception during request execution" } } } }, "/api/v2/cm/branches/{branchId}/worksets/{worksetId}/items": { "get": { "tags": [ "Worksets" ], "summary": "Retrieve all the items in a workset with a specific ID", "description": "Lists the content items, content types, and taxonomies that are in a particular workset using its ID.", "operationId": "GetWorksetItems", "parameters": [ { "name": "branchId", "in": "path", "description": "The ID of the branch, for example `prod`.", "required": true, "schema": { "type": "string" } }, { "name": "worksetId", "in": "path", "description": "The workset identifier.", "required": true, "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "MinimumPageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "x-sc-continuation", "in": "header", "description": "The continuation token for next results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorksetItemListResponse" } } } }, "401": { "description": "Unauthorized request or invalid access token" }, "403": { "description": "Request does not contain required scopes" }, "404": { "description": "Item or entity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server-side exception during request execution" } } } } }, "components": { "schemas": { "BaseTaskMessageLogDTO": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32", "nullable": true }, "type": { "$ref": "#/components/schemas/ItemType" }, "locale": { "type": "string", "nullable": true }, "logTime": { "type": "string", "format": "date-time" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BooleanFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ContentItemCreateRequest": { "type": "object", "properties": { "locale": { "type": "string", "nullable": true }, "contentTypeId": { "type": "string", "nullable": true }, "fields": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ContentItemNoFieldsResponse": { "required": [ "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "locale": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "system": { "$ref": "#/components/schemas/ContentItemSystemResource" }, "contextSearchSimilarity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ContentItemNoFieldsResponseContentItemListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContentItemNoFieldsResponse" }, "nullable": true } }, "additionalProperties": false }, "ContentItemPatchRequest": { "type": "object", "additionalProperties": false }, "ContentItemResource": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ContentItemResourceContentItemListResponse": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ContentItemResponseContentItemListResponse" }, { "$ref": "#/components/schemas/ContentItemNoFieldsResponseContentItemListResponse" } ], "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContentItemResource" }, "nullable": true } }, "additionalProperties": false }, "ContentItemResponse": { "required": [ "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "locale": { "type": "string", "nullable": true }, "fields": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "nullable": true, "readOnly": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "system": { "$ref": "#/components/schemas/ContentItemSystemResource" }, "contextSearchSimilarity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ContentItemResponseContentItemListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContentItemResponse" }, "nullable": true } }, "additionalProperties": false }, "ContentItemSystemResource": { "required": [ "contentType", "createdAt", "createdBy", "environment", "hash", "type" ], "type": "object", "properties": { "contentType": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PublishStatus" }, "availabilityDate": { "type": "string", "format": "date-time", "nullable": true }, "unavailabilityDate": { "type": "string", "format": "date-time", "nullable": true }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "publishedBy": { "type": "string", "nullable": true }, "archivedDate": { "type": "string", "format": "date-time", "nullable": true }, "archivedBy": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContentItemUpdateRequest": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ContentTypeCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isDirectQuery": { "type": "boolean", "nullable": true }, "isPrivate": { "type": "boolean", "nullable": true }, "fields": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TextFieldType" }, { "$ref": "#/components/schemas/RichTextFieldType" }, { "$ref": "#/components/schemas/NumberFieldType" }, { "$ref": "#/components/schemas/BooleanFieldType" }, { "$ref": "#/components/schemas/DateTimeFieldType" }, { "$ref": "#/components/schemas/ReferenceFieldType" }, { "$ref": "#/components/schemas/SelectFieldTypeRequest" }, { "$ref": "#/components/schemas/JsonFieldType" } ] }, "nullable": true }, "fragments": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fragmentKey": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ContentTypePatchRequest": { "type": "object", "additionalProperties": false }, "ContentTypeResponse": { "required": [ "fields", "id", "name", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isDirectQuery": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "fields": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TextFieldType" }, { "$ref": "#/components/schemas/RichTextFieldType" }, { "$ref": "#/components/schemas/NumberFieldType" }, { "$ref": "#/components/schemas/BooleanFieldType" }, { "$ref": "#/components/schemas/DateTimeFieldType" }, { "$ref": "#/components/schemas/ReferenceFieldType" }, { "$ref": "#/components/schemas/SelectFieldTypeRequest" }, { "$ref": "#/components/schemas/JsonFieldType" } ] }, "nullable": true }, "fragmentKey": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fragments": { "type": "array", "items": { "type": "string" }, "nullable": true }, "system": { "$ref": "#/components/schemas/PublishSystemResource" } }, "additionalProperties": false }, "ContentTypeResponseListResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "minimumPageSize": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeResponse" }, "nullable": true } }, "additionalProperties": false }, "ContentTypeUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isDirectQuery": { "type": "boolean", "nullable": true }, "isPrivate": { "type": "boolean", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fields": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TextFieldType" }, { "$ref": "#/components/schemas/RichTextFieldType" }, { "$ref": "#/components/schemas/NumberFieldType" }, { "$ref": "#/components/schemas/BooleanFieldType" }, { "$ref": "#/components/schemas/DateTimeFieldType" }, { "$ref": "#/components/schemas/ReferenceFieldType" }, { "$ref": "#/components/schemas/SelectFieldTypeRequest" }, { "$ref": "#/components/schemas/JsonFieldType" } ] }, "nullable": true }, "fragments": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fragmentKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DateTimeFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "rules": { "$ref": "#/components/schemas/DateTimeFieldTypeRules" } }, "additionalProperties": false }, "DateTimeFieldTypeRules": { "type": "object", "properties": { "dateTimeRange": { "$ref": "#/components/schemas/DateTimeRangeRule" }, "isFutureDate": { "$ref": "#/components/schemas/IsFutureDateRule" } }, "additionalProperties": false }, "DateTimeRangeRule": { "type": "object", "properties": { "min": { "type": "string", "nullable": true }, "max": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecimalPlacesRule": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BranchCreateResource": { "required": [ "id", "name", "source" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string" }, "source": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "BranchListResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BranchResource" }, "nullable": true } }, "additionalProperties": false }, "BranchResource": { "required": [ "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "system": { "$ref": "#/components/schemas/SystemResource" } }, "additionalProperties": false }, "BranchResourceResponse": { "required": [ "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "system": { "$ref": "#/components/schemas/SystemResource" } }, "additionalProperties": false }, "BranchSystemResource": { "required": [ "createdAt", "createdBy", "environment", "hash", "type" ], "type": "object", "properties": { "environment": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BranchUpdateResource": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Common.SystemResource": { "required": [ "createdAt", "createdBy", "hash", "type" ], "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldReferenceRequest": { "type": "object", "properties": { "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldReferenceTypesRule": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "IsFutureDateRule": { "type": "object", "properties": { "value": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ItemType": { "enum": [ "ContentItem", "ContentType", "Taxonomy" ], "type": "string" }, "JsonFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "rules": { "$ref": "#/components/schemas/JsonFieldTypeRules" } }, "additionalProperties": false }, "JsonFieldTypeRules": { "type": "object", "properties": { "length": { "$ref": "#/components/schemas/LengthRule" } }, "additionalProperties": false }, "LengthRule": { "type": "object", "properties": { "min": { "type": "integer", "format": "int32", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "LimitNumberRule": { "type": "object", "properties": { "min": { "type": "number", "format": "double", "nullable": true }, "max": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "LimitRule": { "type": "object", "properties": { "min": { "type": "integer", "format": "int64", "nullable": true }, "max": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "LocaleCreateRequest": { "required": [ "default", "id", "label" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "default": { "type": "boolean" } }, "additionalProperties": false }, "LocaleListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocaleResponse" }, "nullable": true } }, "additionalProperties": false }, "LocaleResponse": { "required": [ "default", "id", "label", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "label": { "minLength": 1, "type": "string" }, "default": { "type": "boolean" }, "system": { "$ref": "#/components/schemas/BranchSystemResource" } }, "additionalProperties": false }, "Mvc.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "Mvc.ValidationProblemDetails": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "LocaleUpdateRequest": { "required": [ "default", "label" ], "type": "object", "properties": { "label": { "minLength": 1, "type": "string" }, "default": { "type": "boolean" } }, "additionalProperties": false }, "NumberFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "rules": { "$ref": "#/components/schemas/NumberFieldTypeRules" } }, "additionalProperties": false }, "NumberFieldTypeRules": { "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/LimitNumberRule" }, "decimalPlaces": { "$ref": "#/components/schemas/DecimalPlacesRule" } }, "additionalProperties": false }, "Operation": { "type": "object", "properties": { "value": { "type": "object", "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array" } ], "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "PublishStatus": { "enum": [ "Draft", "Published", "Archived" ], "type": "string" }, "PublishSystemResource": { "required": [ "createdAt", "createdBy", "environment", "hash", "type" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PublishStatus" }, "availabilityDate": { "type": "string", "format": "date-time", "nullable": true }, "unavailabilityDate": { "type": "string", "format": "date-time", "nullable": true }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "publishedBy": { "type": "string", "nullable": true }, "archivedDate": { "type": "string", "format": "date-time", "nullable": true }, "archivedBy": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReferenceFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "rules": { "$ref": "#/components/schemas/ReferenceFieldTypeRules" } }, "additionalProperties": false }, "ReferenceFieldTypeRules": { "type": "object", "properties": { "countLimit": { "$ref": "#/components/schemas/LimitRule" }, "referencetypes": { "$ref": "#/components/schemas/FieldReferenceTypesRule" } }, "additionalProperties": false }, "RegexpRule": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RichTextFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "rules": { "$ref": "#/components/schemas/RichTextFieldTypeRules" } }, "additionalProperties": false }, "RichTextFieldTypeRules": { "type": "object", "properties": { "length": { "$ref": "#/components/schemas/LengthRule" } }, "additionalProperties": false }, "SelectFieldTypeRequest": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "reference": { "$ref": "#/components/schemas/FieldReferenceRequest" }, "rules": { "$ref": "#/components/schemas/SelectFieldTypeRules" } }, "additionalProperties": false }, "SelectFieldTypeRules": { "type": "object", "properties": { "countLimit": { "$ref": "#/components/schemas/LimitRule" } }, "additionalProperties": false }, "SystemResource": { "required": [ "createdAt", "createdBy", "hash", "type" ], "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxonomyCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "label": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyTermCreateRequest" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyResponse" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyResponse": { "required": [ "id", "name", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "minLength": 1, "type": "string" }, "label": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyTermResponse" }, "nullable": true }, "system": { "$ref": "#/components/schemas/PublishSystemResource" } }, "additionalProperties": false }, "TaxonomyTermCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxonomyTermResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxonomyTermUpdateRequest": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxonomyUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "versionTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyTermUpdateRequest" }, "nullable": true } }, "additionalProperties": false }, "TextFieldType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "enum": [ "Text", "RichText", "Number", "Boolean", "DateTime", "Reference", "Select", "Json" ], "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "priorityField": { "type": "boolean" }, "isPrivate": { "type": "boolean", "nullable": true }, "singleLineText": { "type": "boolean" }, "rules": { "$ref": "#/components/schemas/TextFieldTypeRules" }, "defaultValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "TextFieldTypeRules": { "type": "object", "properties": { "length": { "$ref": "#/components/schemas/LengthRule" }, "regexp": { "$ref": "#/components/schemas/RegexpRule" } }, "additionalProperties": false }, "UserListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserResponse" }, "nullable": true } }, "additionalProperties": false }, "UserResponse": { "required": [ "authId", "id", "organizationId", "type" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "authId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/UserType" }, "email": { "type": "string", "nullable": true }, "givenName": { "type": "string", "nullable": true }, "familyName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserType": { "enum": [ "User", "Client" ], "type": "string" }, "ValidationProblemDetails": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "VersionsStatusesListResponse": { "type": "object", "properties": { "versionsStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/VersionsStatusesResponse" }, "nullable": true } }, "additionalProperties": false }, "VersionsStatusesResponse": { "type": "object", "properties": { "version": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/PublishStatus" } }, "additionalProperties": false }, "JobCreateRequest": { "required": [ "name", "worksetId", "jobTypeId" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "worksetId": { "minLength": 1, "type": "string" }, "jobTypeId": { "minLength": 1, "type": "string" }, "options": { "$ref": "#/components/schemas/WorksetExecutionOptions" } }, "additionalProperties": false }, "JobCreateResponse": { "required": [ "id", "name", "options", "system", "worksetId", "jobTypeId" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "worksetId": { "type": "string", "nullable": true }, "jobTypeId": { "type": "string", "nullable": true }, "options": { "$ref": "#/components/schemas/WorksetExecutionOptions" }, "system": { "$ref": "#/components/schemas/TaskSystemResponse" } }, "additionalProperties": false }, "JobGetResponse": { "required": [ "id", "name", "options", "system", "worksetId", "jobTypeId" ], "type": "object", "properties": { "steps": { "type": "array", "items": { "$ref": "#/components/schemas/JobStep" }, "nullable": true }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "worksetId": { "type": "string", "nullable": true }, "jobTypeId": { "type": "string", "nullable": true }, "options": { "$ref": "#/components/schemas/WorksetExecutionOptions" }, "system": { "$ref": "#/components/schemas/TaskSystemResponse" } }, "additionalProperties": false }, "JobListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobGetResponse" }, "nullable": true } }, "additionalProperties": false }, "JobStep": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "taskTypeId": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "executionMode": { "$ref": "#/components/schemas/JobStepMode" } }, "additionalProperties": false }, "TaskCreateRequest": { "required": [ "name", "worksetId", "taskTypeId" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "worksetId": { "minLength": 1, "type": "string" }, "taskTypeId": { "minLength": 1, "type": "string" }, "options": { "$ref": "#/components/schemas/WorksetExecutionOptions" } }, "additionalProperties": false }, "TaskCreateResponse": { "required": [ "id", "name", "options", "system", "worksetId", "taskTypeId" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "worksetId": { "type": "string", "nullable": true }, "taskTypeId": { "type": "string", "nullable": true }, "options": { "$ref": "#/components/schemas/WorksetExecutionOptions" }, "system": { "$ref": "#/components/schemas/TaskSystemResponse" } }, "additionalProperties": false }, "TaskGetResponse": { "required": [ "id", "name", "options", "system", "worksetId", "taskTypeId" ], "type": "object", "properties": { "statistics": { "$ref": "#/components/schemas/TaskStatistics" }, "messageLog": { "type": "array", "items": { "$ref": "#/components/schemas/BaseTaskMessageLogDTO" }, "nullable": true }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "worksetId": { "type": "string", "nullable": true }, "taskTypeId": { "type": "string", "nullable": true }, "options": { "$ref": "#/components/schemas/WorksetExecutionOptions" }, "system": { "$ref": "#/components/schemas/TaskSystemResponse" } }, "additionalProperties": false }, "TaskItemListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetItemExecutionFailure" }, "nullable": true } }, "additionalProperties": false }, "TaskListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskGetResponse" }, "nullable": true } }, "additionalProperties": false }, "TaskLogFailuresRequest": { "required": [ "failures" ], "type": "object", "properties": { "failures": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetItemExecutionFailure" } } }, "additionalProperties": false }, "TaskStatistics": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "processed": { "type": "integer", "format": "int32" }, "succeeded": { "type": "integer", "format": "int32" }, "ignored": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TaskStatus": { "required": [ "state" ], "type": "object", "properties": { "state": { "$ref": "#/components/schemas/TaskStateCallbackRequest" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskStatusDTO": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/TaskState" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskSystemResponse": { "required": [ "createdAt", "createdBy", "hash", "type" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/TaskStatusDTO" }, "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Tasks.TaskTypeOptions": { "type": "object", "properties": { "canBeStopped": { "type": "boolean" } }, "additionalProperties": false }, "Tasks.TaskTypeSettings": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Tasks.TaskTypeVariableDefinition": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/Task.TaskTypeVariableType" } }, "additionalProperties": false }, "Tasks.TaskTypeRequest": { "required": [ "isAction", "settings" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isAction": { "type": "boolean" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/Tasks.TaskTypeVariableDefinition" }, "nullable": true, "readOnly": true }, "options": { "$ref": "#/components/schemas/Tasks.TaskTypeOptions" }, "settings": { "$ref": "#/components/schemas/Tasks.TaskTypeSettings" } }, "additionalProperties": false }, "Tasks.TaskTypeResponse": { "required": [ "id", "name", "options", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isAction": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/Tasks.TaskTypeVariableDefinition" }, "nullable": true }, "options": { "$ref": "#/components/schemas/Tasks.TaskTypeOptions" }, "settings": { "$ref": "#/components/schemas/Tasks.TaskTypeSettings" }, "system": { "$ref": "#/components/schemas/Common.SystemResource" } }, "additionalProperties": false }, "TaskUpdateRequest": { "required": [ "statistics", "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/TaskStatus" }, "statistics": { "$ref": "#/components/schemas/TaskStatistics" } }, "additionalProperties": false }, "WorksetExecutionOptions": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false }, "TaskState": { "enum": [ "Created", "Pending", "InProgress", "Completed", "Failed", "Stopped", "Waiting" ], "type": "string" }, "Task.TaskTypeVariableType": { "enum": [ "String", "Number", "Integer", "Boolean", "DateTime", "Collection", "List" ], "type": "string" }, "TaskStateCallbackRequest": { "enum": [ "InProgress", "Completed", "Failed", "Stopped", "Waiting" ], "type": "string" }, "WorksetGetListResponse": { "required": [ "id", "name", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "system": { "$ref": "#/components/schemas/WorksetSystemResource" } }, "additionalProperties": false }, "WorksetItem": { "required": [ "id", "type", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string" }, "version": { "type": "integer", "format": "int32" }, "locale": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ItemType" } }, "additionalProperties": false }, "WorksetItemExecutionFailure": { "required": [ "item" ], "type": "object", "properties": { "item": { "$ref": "#/components/schemas/WorksetItem" }, "messages": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "WorksetItemListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetItem" }, "nullable": true } }, "additionalProperties": false }, "WorksetListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "nullable": true }, "next": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetGetListResponse" }, "nullable": true } }, "additionalProperties": false }, "WorksetOptions": { "required": [ "source" ], "type": "object", "properties": { "source": { "$ref": "#/components/schemas/WorksetSource" } }, "additionalProperties": false }, "JobTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "options": { "$ref": "#/components/schemas/TaskTypeOptions" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/JobStep" }, "nullable": true } }, "additionalProperties": false }, "JobTypeResponse": { "required": [ "id", "name", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "options": { "$ref": "#/components/schemas/TaskTypeOptions" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/JobStep" }, "nullable": true }, "system": { "$ref": "#/components/schemas/SystemResource" } }, "additionalProperties": false }, "JobStepMode": { "enum": [ "Strict", "Lenient", "Selective" ], "type": "string" }, "TaskTypeOptions": { "type": "object", "properties": { "canBeStopped": { "type": "boolean" }, "canCallback": { "type": "boolean" } }, "additionalProperties": false }, "TaskTypeResponse": { "required": [ "id", "name", "options", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTypeVariableDefinition" }, "nullable": true }, "options": { "$ref": "#/components/schemas/TaskTypeOptions" }, "system": { "$ref": "#/components/schemas/SystemResource" } }, "additionalProperties": false }, "TaskTypeVariableDefinition": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/TaskTypeVariableType" } }, "additionalProperties": false }, "TaskTypeVariableType": { "enum": [ "String", "Number", "Integer", "Boolean", "DateTime", "Collection", "List" ], "type": "string" }, "WorksetRequest": { "required": [ "items", "name", "options" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetItem" } }, "options": { "$ref": "#/components/schemas/WorksetOptions" } }, "additionalProperties": false }, "WorksetResponse": { "required": [ "id", "name", "options", "system" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetItem" }, "nullable": true }, "options": { "$ref": "#/components/schemas/WorksetOptions" }, "system": { "$ref": "#/components/schemas/WorksetSystemResource" } }, "additionalProperties": false }, "WorksetSource": { "required": [ "sourceId" ], "type": "object", "properties": { "sourceId": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "WorksetSystemResource": { "required": [ "createdAt", "createdBy", "hash", "type" ], "type": "object", "properties": { "readOnly": { "type": "boolean" }, "type": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorksetUpdateRequest": { "required": [ "items", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorksetItem" } } }, "additionalProperties": false } }, "securitySchemes": { "OAuth2.0": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "scopes": {} } } } } } }