{"items":[{"type":"link","label":"Content Management API","link":"/sai/xm-cloud-content/content-management-api","routeSlug":"/sai/xm-cloud-content/content-management-api","content":{"contentType":"overview","meta":{"name":"Content Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/sai/xm-cloud-content/content-management-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/sai/xm-cloud-content/content-management-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs","description":"The base server URL."}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Content Management API (v2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format is ISO 8601.  "},"children":[]}]}]}]}]}],"sectionId":"/sai/xm-cloud-content/content-management-api"}],"sectionId":"/sai/xm-cloud-content/content-management-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this REST API, you must authorize your API requests. To do this, you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"need the following information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your XM Cloud Content server (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cs-cmapi.sitecorecloud.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/custom-hostnames.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom hostname"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The environment ID (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, enter this information on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, by hovering your mouse over the variable and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens 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: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth2_client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth2_client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth2_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/sai/xm-cloud-content/content-management-api/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/create-an-oauth-client-bearer-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth client bearer token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" menu is only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visible if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an OAuth client bearer token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In XM Cloud Content, on the menu bar, click "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the left pane, click "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content management API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content management API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page, in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grant type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, click "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the following credentials and paste them into your development tool, and then execute the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The client ID for XM Cloud Content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The client secret for the XM Cloud Content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audience"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The audience for your tenant. This will be in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.sitecorecloud.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authority"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The authority for your tenant. This is the POST URL, in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.sitecorecloud.io/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}],"sectionId":"/sai/xm-cloud-content/content-management-api/section/create-an-oauth-client-bearer-token"}]}]}},{"type":"link","label":"Authentication","link":"/sai/xm-cloud-content/content-management-api/section/authentication","routeSlug":"/sai/xm-cloud-content/content-management-api/section/authentication","content":null},{"type":"link","label":"Create an OAuth client bearer token","link":"/sai/xm-cloud-content/content-management-api/section/create-an-oauth-client-bearer-token","routeSlug":"/sai/xm-cloud-content/content-management-api/section/create-an-oauth-client-bearer-token","content":null},{"type":"separator","label":"Content endpoints","content":null},{"type":"group","label":"Content items","link":"/sai/xm-cloud-content/content-management-api/content-items","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items","items":[{"label":"Delete a content item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/deletecontentitem","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/deletecontentitem","metadata":{"seo":{"title":"Delete a content item","description":"Deletes a content item with a specific ID. You can only delete content items with a DRAFT status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteContentItem","name":"Delete a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a content item with a specific ID. You can only delete content items with a"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DRAFT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmdvOOpQH0CY4QRLztHflg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"locale","in":"query","schemaId":"schema_1585"},{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","href":"content-items/deletecontentitem","openApiOperationId":"DeleteContentItem","summary":"Delete a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/deletecontentitem"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}"},{"label":"Retrieve a content item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/contentitembyid","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/contentitembyid","metadata":{"seo":{"title":"Retrieve a content item","description":"Retrieves a content item from a specific branch using its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ContentItemById","name":"Retrieve a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a content item from a specific branch using its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmdvOOpQH0CY4QRLztHflg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the content item, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"locale","in":"query","schemaId":"schema_1585"},{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","href":"content-items/contentitembyid","openApiOperationId":"ContentItemById","summary":"Retrieve a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}},"schemaId":"components/schemas/ContentItemResponse"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContentItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/contentitembyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}"},{"label":"Partially update a content item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/patchcontentitem","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/patchcontentitem","metadata":{"seo":{"title":"Partially update a content item","description":"Partially updates the content item, replacing only those fields provided in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchContentItem","name":"Partially update a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates the content item, replacing only those fields provided in the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content item, for example  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8cwa-M3RYUSfdCSeP_YuSQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item version, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-cs-revisionId","in":"header","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hash version of the content item, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8cwa-M3RYUSfdCSeP_YuSQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody","description":"Parameter containing the content item details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"locale","in":"query","schemaId":"schema_1585"},{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[{"name":"x-cs-revisionId","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1*+json/example"]}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","href":"content-items/patchcontentitem","openApiOperationId":"PatchContentItem","summary":"Partially update a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/patchcontentitem"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}"},{"label":"Create a new version of a content item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/addnewversioncontentitem","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/addnewversioncontentitem","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddNewVersionContentItem","name":"Create a new version of a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new version of a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new version of a content item with the same ID as the original, but the version number is updated (for example, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You can work on the versions independently."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmdvOOpQH0CY4QRLztHflg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"text/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"}},"schemaId":"components/schemas/ContentItemUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/post/requestBody","description":"Parameter containing the content item details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"locale","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"text/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","href":"content-items/addnewversioncontentitem","openApiOperationId":"AddNewVersionContentItem","summary":"Create a new version of a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentItemUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"text/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}},"schemaId":"components/schemas/ContentItemResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContentItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/addnewversioncontentitem"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}"},{"label":"Update a content item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/updatecontentitem","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/updatecontentitem","metadata":{"seo":{"title":"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).  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. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateContentItem","name":"Update a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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. "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content item, for example  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8cwa-M3RYUSfdCSeP_YuSQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item version, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-cs-revisionId","in":"header","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hash version of the content item, for example  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1IcUUQq73YFLLyzQkWt71D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"text/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"}},"schemaId":"components/schemas/ContentItemUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/put/requestBody","description":"Parameter containing the content item details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"locale","in":"query","schemaId":"schema_1585"},{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[{"name":"x-cs-revisionId","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"text/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","href":"content-items/updatecontentitem","openApiOperationId":"UpdateContentItem","summary":"Update a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentItemUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"text/json":{"schemaId":"components/schemas/ContentItemUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/ContentItemUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/updatecontentitem"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}"},{"label":"Retrieve the versions and statuses of a content item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/contentitemversionsstatusesbyid","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/contentitemversionsstatusesbyid","metadata":{"seo":{"title":"Retrieve the versions and statuses of a content item","description":"Lists the versions and statuses of a specific content item, in a specific branch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ContentItemVersionsStatusesById","name":"Retrieve the versions and statuses of a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the versions and statuses of a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the versions and statuses of a specific content item, in a specific branch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmdvOOpQH0CY4QRLztHflg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/versions","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"locale","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/versions","href":"content-items/contentitemversionsstatusesbyid","openApiOperationId":"ContentItemVersionsStatusesById","summary":"Retrieve the versions and statuses of a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionsStatusesListResponse"}},"schemaId":"components/schemas/VersionsStatusesListResponse"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VersionsStatusesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionsStatusesListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/contentitemversionsstatusesbyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/versions"},{"label":"Retrieve a list of content items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/getcontentitems","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/getcontentitems","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetContentItems","name":"Retrieve a list of content items","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of content items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all the content items in a specific branch. If you don't specify any filtering parameters, you will retrieve all available content items."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"View","in":"query","schemaId":"schema_1587"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"id","in":"query","schemaId":"schema_1585"},{"name":"fragment.id","in":"query","schemaId":"schema_1585"},{"name":"fragment.key","in":"query","schemaId":"schema_1585"},{"name":"system.contentType.id","in":"query","schemaId":"schema_1585"},{"name":"system.contentType.name","in":"query","schemaId":"schema_1585"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.status","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedBy.id","in":"query","schemaId":"schema_1585"},{"name":"linkedTo","in":"query","schemaId":"schema_1585"},{"name":"locale","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.endDate","in":"query","schemaId":"schema_1585"},{"name":"latestVersion","in":"query","schemaId":"schema_1585"},{"name":"context","in":"query","schemaId":"schema_1585"},{"name":"taxonomy[{taxonomyId}].id","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a taxonomy term. Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{taxonomyId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the taxonomy ID you want to filter by and set the value to the term ID you want to use, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxonomy[56TqdLYFoShmYA1mfJn0PX].id = 3GfL56YUvmCHg2u2d4ohOa"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/content-items","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"View","in":"query","schemaId":"schema_1587"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"id","in":"query","schemaId":"schema_1585"},{"name":"fragment.id","in":"query","schemaId":"schema_1585"},{"name":"fragment.key","in":"query","schemaId":"schema_1585"},{"name":"system.contentType.id","in":"query","schemaId":"schema_1585"},{"name":"system.contentType.name","in":"query","schemaId":"schema_1585"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.status","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedBy.id","in":"query","schemaId":"schema_1585"},{"name":"linkedTo","in":"query","schemaId":"schema_1585"},{"name":"locale","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.endDate","in":"query","schemaId":"schema_1585"},{"name":"latestVersion","in":"query","schemaId":"schema_1585"},{"name":"context","in":"query","schemaId":"schema_1585"},{"name":"taxonomy[{taxonomyId}].id","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items","href":"content-items/getcontentitems","openApiOperationId":"GetContentItems","summary":"Retrieve a list of content items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResourceContentItemListResponse"}},"schemaId":"components/schemas/ContentItemResourceContentItemListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContentItemResourceContentItemListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResourceContentItemListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/getcontentitems"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items"},{"label":"Create a content item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/addcontentitem","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/addcontentitem","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddContentItem","name":"Create a content item","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a content item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new content item based on a specific content type. It is the content type that determines the structure of the content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody","description":"Parameter containing the content type details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/content-items","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1*+json/example"]}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items","href":"content-items/addcontentitem","openApiOperationId":"AddContentItem","summary":"Create a content item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}},"schemaId":"components/schemas/ContentItemResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"409","description":"Conflict"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContentItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/addcontentitem"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items"},{"label":"Create a copy of a content item with a new locale","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-items/copycontentitem","routeSlug":"/sai/xm-cloud-content/content-management-api/content-items/copycontentitem","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CopyContentItem","name":"Create a copy of a content item with a new locale","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1copy/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a copy of a content item with a new locale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentItemId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content item, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8cwa-M3RYUSfdCSeP_YuSQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content item version, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ."},"children":[]}]}]}]},{"name":"sourceLocale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source locale of the content item. A locale is the IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"destinationLocale","in":"query","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination locale of the content item. A locale is the IETF language tag, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1copy/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/copy","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentItemId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"},{"name":"sourceLocale","in":"query","schemaId":"schema_1585"},{"name":"destinationLocale","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["201","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/copy","href":"content-items/copycontentitem","openApiOperationId":"CopyContentItem","summary":"Create a copy of a content item with a new locale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}},"schemaId":"components/schemas/ContentItemResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContentItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentItemResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-items/copycontentitem"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/copy"}],"content":{"contentType":"group","meta":{"name":"Content items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content items","showPageActions":true},{"nodeType":"markdoc","content":"A content item contains data that aligns with the data model and is structured according to the content type."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","summary":"Delete a content item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/content-items/deletecontentitem","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","summary":"Retrieve a content item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-items/contentitembyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","summary":"Partially update a content item","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/content-items/patchcontentitem","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","summary":"Create a new version of a content item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-items/addnewversioncontentitem","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}","summary":"Update a content item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-items/updatecontentitem","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/versions","summary":"Retrieve the versions and statuses of a content item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-items/contentitemversionsstatusesbyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items","summary":"Retrieve a list of content items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-items/getcontentitems","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items","summary":"Create a content item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-items/addcontentitem","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-items/{contentItemId}/copy","summary":"Create a copy of a content item with a new locale","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-items/copycontentitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Content types","link":"/sai/xm-cloud-content/content-management-api/content-types","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types","items":[{"label":"Delete a content type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/deletecontenttype","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/deletecontenttype","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteContentType","name":"Delete a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a content type that is no longer needed. The content type must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and no linked content items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content type identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1jUvDOTMA3sWkBM17Z1nI3"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the content type, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the latest version is assumed."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","href":"content-types/deletecontenttype","openApiOperationId":"DeleteContentType","summary":"Delete a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/deletecontenttype"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}"},{"label":"Retrieve a content type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/contenttypebyidentifier","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/contenttypebyidentifier","metadata":{"seo":{"title":"Retrieve a content type","description":"Retrieves a content type from a specific branch using its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ContentTypeByIdentifier","name":"Retrieve a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a content type from a specific branch using its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content type ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4c2PuJUHuIgClc5NWDaGav"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the content type, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","href":"content-types/contenttypebyidentifier","openApiOperationId":"ContentTypeByIdentifier","summary":"Retrieve a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}},"schemaId":"components/schemas/ContentTypeResponse"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContentTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/contenttypebyidentifier"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}"},{"label":"Partially update a content type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/patchcontenttype","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/patchcontenttype","metadata":{"seo":{"title":"Partially update a content type","description":"Partially updates the content type, replacing only those fields provided in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchContentType","name":"Partially update a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates the content type, replacing only those fields provided in the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content type, for example  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8cwa-M3RYUSfdCSeP_YuSQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":"The version of the content type."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody","description":"Parameter containing the content type details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1*+json/example"]}},"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","href":"content-types/patchcontenttype","openApiOperationId":"PatchContentType","summary":"Partially update a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentItemPatchRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"409","description":"Conflict"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/patchcontenttype"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}"},{"label":"Create a new version of a content type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/addnewversioncontenttype","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/addnewversioncontenttype","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddNewVersionContentType","name":"Create a new version of a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new version of a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a copy of a content type with the same ID as the original, but the version number is updated (for example, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content type, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody","description":"Parameter containing the content type request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1*+json/example"]}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","href":"content-types/addnewversioncontenttype","openApiOperationId":"AddNewVersionContentType","summary":"Create a new version of a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}},"schemaId":"components/schemas/ContentTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"409","description":"Conflict"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContentTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/addnewversioncontenttype"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}"},{"label":"Update a content type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/updatecontenttype","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/updatecontenttype","metadata":{"seo":{"title":"Update a content type","description":"Updates a content type with a specific ID.  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. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateContentType","name":"Update a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a content type with a specific ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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. "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content type to update, for example  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8cwa-M3RYUSfdCSeP_YuSQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":"The version of the content type."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody","description":"Parameter containing the content type details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1*+json/example"]}},"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","href":"content-types/updatecontenttype","openApiOperationId":"UpdateContentType","summary":"Update a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeUpdateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"409","description":"Conflict"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/updatecontenttype"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}"},{"label":"Retrieve a list of content types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/contenttypeslist","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/contenttypeslist","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ContentTypesList","name":"Retrieve a list of content types","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of content types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all defined content types. If you don't specify any filtering parameters, you will retrieve all available content types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"id","in":"query","schemaId":"schema_1585"},{"name":"system.status","in":"query","schemaId":"schema_1585"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.endDate","in":"query","schemaId":"schema_1585"},{"name":"isFragment","in":"query","schemaId":"schema_1585"},{"name":"fragment.id","in":"query","schemaId":"schema_1585"},{"name":"fragment.key","in":"query","schemaId":"schema_1585"},{"name":"latestVersion","in":"query","schemaId":"schema_1585"},{"name":"taxonomy.id","in":"query","schemaId":"schema_1585"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/content-types","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"id","in":"query","schemaId":"schema_1585"},{"name":"system.status","in":"query","schemaId":"schema_1585"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.endDate","in":"query","schemaId":"schema_1585"},{"name":"isFragment","in":"query","schemaId":"schema_1585"},{"name":"fragment.id","in":"query","schemaId":"schema_1585"},{"name":"fragment.key","in":"query","schemaId":"schema_1585"},{"name":"latestVersion","in":"query","schemaId":"schema_1585"},{"name":"taxonomy.id","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types","href":"content-types/contenttypeslist","openApiOperationId":"ContentTypesList","summary":"Retrieve a list of content types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponseListResult"}},"schemaId":"components/schemas/ContentTypeResponseListResult"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContentTypeResponseListResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponseListResult"}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/contenttypeslist"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types"},{"label":"Create a content type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/addcontenttype","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/addcontenttype","metadata":{"seo":{"title":"Create a content type","description":"Creates a content type to structure content for a particular purpose."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddContentType","name":"Create a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a content type to structure content for a particular purpose."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody","description":"Parameter containing the content type details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/content-types","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1*+json/example"]}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types","href":"content-types/addcontenttype","openApiOperationId":"AddContentType","summary":"Create a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/ContentTypeCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Content type successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}},"schemaId":"components/schemas/ContentTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContentTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"409","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/addcontenttype"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types"},{"label":"Retrieve the versions and statuses of a content type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/contenttypeversionsstatusesbyid","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/contenttypeversionsstatusesbyid","metadata":{"seo":{"title":"Retrieve the versions and statuses of a content type","description":"Lists the versions and statuses of a content type from a specific branch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ContentTypeVersionsStatusesById","name":"Retrieve the versions and statuses of a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the versions and statuses of a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the versions and statuses of a content type from a specific branch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content type identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmdvOOpQH0CY4QRLztHflg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/versions","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["201","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/versions","href":"content-types/contenttypeversionsstatusesbyid","openApiOperationId":"ContentTypeVersionsStatusesById","summary":"Retrieve the versions and statuses of a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"New version successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionsStatusesListResponse"}},"schemaId":"components/schemas/VersionsStatusesListResponse"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/VersionsStatusesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionsStatusesListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/contenttypeversionsstatusesbyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/versions"},{"label":"Create a new version of a content type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/content-types/copycontenttype","routeSlug":"/sai/xm-cloud-content/content-management-api/content-types/copycontenttype","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CopyContentType","name":"Create a new version of a content type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1copy/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new version of a content type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a copy of a content type with the same ID as the original, but the version number is updated (for example, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"contentTypeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the content type, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":"The version of the content type."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1copy/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/copy","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"contentTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["201","400","401"],"pointer":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/copy","href":"content-types/copycontenttype","openApiOperationId":"CopyContentType","summary":"Create a new version of a content type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"New version successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}},"schemaId":"components/schemas/ContentTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContentTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-types/copycontenttype"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/copy"}],"content":{"contentType":"group","meta":{"name":"Content types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content types","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content type that supports this structure includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short text field (title)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rich text field (short description)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number field (price)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number field (inventory counter)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A media fragment (product image)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference field for a detailed specification PDF"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Private fields are used by the Delivery API and are available in preview. They are not available in the delivery schema."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A content type can include a fragment. Fragments let you:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate an action. For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XMCMedia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content type includes a media fragment that retrieves media using its file ID from a defined URI and path."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In GraphQL, an interface is created for every fragment. For example, for a fragment called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each specific page type can have its own fields. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interface provides a way to query all pages collectively."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Important"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","summary":"Delete a content type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/content-types/deletecontenttype","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","summary":"Retrieve a content type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-types/contenttypebyidentifier","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","summary":"Partially update a content type","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/content-types/patchcontenttype","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","summary":"Create a new version of a content type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-types/addnewversioncontenttype","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}","summary":"Update a content type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-types/updatecontenttype","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types","summary":"Retrieve a list of content types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-types/contenttypeslist","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types","summary":"Create a content type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-types/addcontenttype","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/versions","summary":"Retrieve the versions and statuses of a content type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-types/contenttypeversionsstatusesbyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/content-types/{contentTypeId}/copy","summary":"Create a new version of a content type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-types/copycontenttype","deprecated":false}]}]}]}]}},{"type":"group","label":"Taxonomies","link":"/sai/xm-cloud-content/content-management-api/taxonomies","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies","items":[{"label":"Delete a taxonomy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/deletetaxonomy","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/deletetaxonomy","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTaxonomy","name":"Delete a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a taxonomy with a specific ID. You cannot delete a taxonomy if it is being used by a content type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taxonomyId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taxonomyId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","href":"taxonomies/deletetaxonomy","openApiOperationId":"DeleteTaxonomy","summary":"Delete a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion."},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/deletetaxonomy"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}"},{"label":"Retrieve a taxonomy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/taxonomybyid","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/taxonomybyid","metadata":{"seo":{"title":"Retrieve a taxonomy","description":"Retrieves a taxonomy with a specific ID for example color."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TaxonomyById","name":"Retrieve a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a taxonomy with a specific ID for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taxonomyId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":"The version of the taxonomy."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taxonomyId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","href":"taxonomies/taxonomybyid","openApiOperationId":"TaxonomyById","summary":"Retrieve a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}},"schemaId":"components/schemas/TaxonomyResponse"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxonomyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/taxonomybyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}"},{"label":"Create a new version of a taxonomy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/addnewversiontaxonomy","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/addnewversiontaxonomy","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddNewVersionTaxonomy","name":"Create a new version of a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new version of a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a copy of a taxonomy with the same ID as the original, but the version number is updated (for example, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You can work on the versions independently."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taxonomyId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"}},"schemaId":"components/schemas/TaxonomyUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/post/requestBody","description":"Parameter containing the taxonomy request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taxonomyId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","href":"taxonomies/addnewversiontaxonomy","openApiOperationId":"AddNewVersionTaxonomy","summary":"Create a new version of a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/TaxonomyUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"New version created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}},"schemaId":"components/schemas/TaxonomyResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaxonomyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/addnewversiontaxonomy"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}"},{"label":"Update a taxonomy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/updatetaxonomy","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/updatetaxonomy","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTaxonomy","name":"Update a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a taxonomy. You can, for example, add new taxonomy terms, delete existing terms, or change properties associated with the taxonomy or its terms."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taxonomyId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"}},"schemaId":"components/schemas/TaxonomyUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/put/requestBody","description":"Parameter containing the taxonomy details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taxonomyId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","href":"taxonomies/updatetaxonomy","openApiOperationId":"UpdateTaxonomy","summary":"Update a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/TaxonomyUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/updatetaxonomy"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}"},{"label":"Retrieve the versions and statuses of a taxonomy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/taxonomyversionsstatusesbyid","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/taxonomyversionsstatusesbyid","metadata":{"seo":{"title":"Retrieve the versions and statuses of a taxonomy","description":"Lists the versions and statuses of a specific taxonomy, in a specific branch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TaxonomyVersionsStatusesById","name":"Retrieve the versions and statuses of a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the versions and statuses of a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the versions and statuses of a specific taxonomy, in a specific branch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taxonomyId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/versions","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taxonomyId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/versions","href":"taxonomies/taxonomyversionsstatusesbyid","openApiOperationId":"TaxonomyVersionsStatusesById","summary":"Retrieve the versions and statuses of a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionsStatusesListResponse"}},"schemaId":"components/schemas/VersionsStatusesListResponse"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VersionsStatusesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionsStatusesListResponse"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/taxonomyversionsstatusesbyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/versions"},{"label":"Retrieve a list of taxonomies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/gettaxonomies","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/gettaxonomies","metadata":{"seo":{"title":"Retrieve a list of taxonomies","description":"Lists all defined taxonomies. If you don't specify any filtering parameters, you will retrieve all available taxonomies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTaxonomies","name":"Retrieve a list of taxonomies","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of taxonomies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all defined taxonomies. If you don't specify  any filtering parameters, you will retrieve all available taxonomies."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"id","in":"query","schemaId":"schema_1585"},{"name":"system.status","in":"query","schemaId":"schema_1585"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.endDate","in":"query","schemaId":"schema_1585"},{"name":"latestVersion","in":"query","schemaId":"schema_1585"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/taxonomies","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"id","in":"query","schemaId":"schema_1585"},{"name":"system.status","in":"query","schemaId":"schema_1585"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.createdAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.updatedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedBy.id","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.publishedAt.endDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.startDate","in":"query","schemaId":"schema_1585"},{"name":"system.availabilityDate.endDate","in":"query","schemaId":"schema_1585"},{"name":"latestVersion","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies","href":"taxonomies/gettaxonomies","openApiOperationId":"GetTaxonomies","summary":"Retrieve a list of taxonomies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyListResponse"}},"schemaId":"components/schemas/TaxonomyListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxonomyListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/gettaxonomies"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies"},{"label":"Create a taxonomy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/addtaxonomy","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/addtaxonomy","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddTaxonomy","name":"Create a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyCreateRequest"}},"schemaId":"components/schemas/TaxonomyCreateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/post/requestBody","description":"Parameter containing the taxonomy request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/taxonomies","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyCreateRequest"}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies","href":"taxonomies/addtaxonomy","openApiOperationId":"AddTaxonomy","summary":"Create a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/TaxonomyCreateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"application/json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"text/json":{"schemaId":"components/schemas/TaxonomyCreateRequest"},"application/*+json":{"schemaId":"components/schemas/TaxonomyCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}},"schemaId":"components/schemas/TaxonomyResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaxonomyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/addtaxonomy"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies"},{"label":"Copy a taxonomy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/taxonomies/copytaxonomy","routeSlug":"/sai/xm-cloud-content/content-management-api/taxonomies/copytaxonomy","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CopyTaxonomy","name":"Copy a taxonomy","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1copy/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a taxonomy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a copy of a taxonomy with the same ID as the original, but the version number is updated (for example, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You can work on the versions independently."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taxonomyId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_1586","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the taxonomy, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1copy/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/copy","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taxonomyId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"version","in":"query","schemaId":"schema_1586"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["201","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/copy","href":"taxonomies/copytaxonomy","openApiOperationId":"CopyTaxonomy","summary":"Copy a taxonomy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}},"schemaId":"components/schemas/TaxonomyResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1taxonomies~1{taxonomyId}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaxonomyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxonomyResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxonomies/copytaxonomy"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/copy"}],"content":{"contentType":"group","meta":{"name":"Taxonomies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Taxonomies","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","summary":"Delete a taxonomy","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/taxonomies/deletetaxonomy","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","summary":"Retrieve a taxonomy","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxonomies/taxonomybyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","summary":"Create a new version of a taxonomy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxonomies/addnewversiontaxonomy","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}","summary":"Update a taxonomy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/taxonomies/updatetaxonomy","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/versions","summary":"Retrieve the versions and statuses of a taxonomy","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxonomies/taxonomyversionsstatusesbyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies","summary":"Retrieve a list of taxonomies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxonomies/gettaxonomies","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies","summary":"Create a taxonomy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxonomies/addtaxonomy","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}/copy","summary":"Copy a taxonomy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxonomies/copytaxonomy","deprecated":false}]}]}]}]}},{"type":"separator","label":"Branch endpoints","content":null},{"type":"group","label":"Branches","link":"/sai/xm-cloud-content/content-management-api/branches","routeSlug":"/sai/xm-cloud-content/content-management-api/branches","items":[{"label":"Delete a branch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/branches/branchdelete","routeSlug":"/sai/xm-cloud-content/content-management-api/branches/branchdelete","metadata":{"seo":{"title":"Delete a branch","description":"Deletes a branch with a specific ID. Deleting a branch does not affect the main branch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BranchDelete","name":"Delete a branch","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a branch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a branch with a specific ID. Deleting a branch does not affect the main branch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/branches/{branchId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["202","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}","href":"branches/branchdelete","openApiOperationId":"BranchDelete","summary":"Delete a branch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branches/branchdelete"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}"},{"label":"Retrieve a branch by its ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/branches/environmentbyid","routeSlug":"/sai/xm-cloud-content/content-management-api/branches/environmentbyid","metadata":{"seo":{"title":"Retrieve a branch by its ID","description":"Retrieves a branch using its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"EnvironmentById","name":"Retrieve a branch by its ID","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a branch by its ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a branch using its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}","href":"branches/environmentbyid","openApiOperationId":"EnvironmentById","summary":"Retrieve a branch by its ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchResource"}},"schemaId":"components/schemas/BranchResource"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BranchResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchResource"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branches/environmentbyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}"},{"label":"Update a branch","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/branches/environmentupdate","routeSlug":"/sai/xm-cloud-content/content-management-api/branches/environmentupdate","metadata":{"seo":{"title":"Update a branch","description":"Updates the details associated with a branch with a specific ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"EnvironmentUpdate","name":"Update a branch","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a branch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the details associated with a branch with a specific ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch to update, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/BranchUpdateResource"},"application/json":{"schemaId":"components/schemas/BranchUpdateResource"},"text/json":{"schemaId":"components/schemas/BranchUpdateResource"},"application/*+json":{"schemaId":"components/schemas/BranchUpdateResource"}},"schemaId":"components/schemas/BranchUpdateResource","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/put/requestBody","description":"The branch to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/branches/{branchId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/BranchUpdateResource"},"application/json":{"schemaId":"components/schemas/BranchUpdateResource"},"text/json":{"schemaId":"components/schemas/BranchUpdateResource"},"application/*+json":{"schemaId":"components/schemas/BranchUpdateResource"}},"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}","href":"branches/environmentupdate","openApiOperationId":"EnvironmentUpdate","summary":"Update a branch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/BranchUpdateResource","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/BranchUpdateResource"},"application/json":{"schemaId":"components/schemas/BranchUpdateResource"},"text/json":{"schemaId":"components/schemas/BranchUpdateResource"},"application/*+json":{"schemaId":"components/schemas/BranchUpdateResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchResource"}},"schemaId":"components/schemas/BranchResource"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BranchResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchResource"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branches/environmentupdate"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}"},{"label":"Retrieve all branches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/branches/allenvironments","routeSlug":"/sai/xm-cloud-content/content-management-api/branches/allenvironments","metadata":{"seo":{"title":"Retrieve all branches","description":"Lists all available branches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AllEnvironments","name":"Retrieve all branches","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all branches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all available branches."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/api/v2/cm/branches","href":"branches/allenvironments","openApiOperationId":"AllEnvironments","summary":"Retrieve all branches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchListResult"}},"schemaId":"components/schemas/BranchListResult"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BranchListResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchListResult"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branches/allenvironments"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches"},{"label":"Create a branch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/branches/addenvironment","routeSlug":"/sai/xm-cloud-content/content-management-api/branches/addenvironment","metadata":{"seo":{"title":"Create a branch","description":"Creates a new branch. Branch names must be unique. A maximum of five branches per tenant is supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddEnvironment","name":"Create a branch","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a branch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new branch. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch names must be unique. A maximum of five branches per tenant is supported."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/BranchCreateResource"},"application/json":{"schemaId":"components/schemas/BranchCreateResource"},"text/json":{"schemaId":"components/schemas/BranchCreateResource"},"application/*+json":{"schemaId":"components/schemas/BranchCreateResource"}},"schemaId":"components/schemas/BranchCreateResource","pointer":"/paths/~1api~1v2~1cm~1branches/post/requestBody","description":"The branch to add."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/BranchCreateResource"},"application/json":{"schemaId":"components/schemas/BranchCreateResource"},"text/json":{"schemaId":"components/schemas/BranchCreateResource"},"application/*+json":{"schemaId":"components/schemas/BranchCreateResource"}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches","href":"branches/addenvironment","openApiOperationId":"AddEnvironment","summary":"Create a branch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/BranchCreateResource","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/BranchCreateResource"},"application/json":{"schemaId":"components/schemas/BranchCreateResource"},"text/json":{"schemaId":"components/schemas/BranchCreateResource"},"application/*+json":{"schemaId":"components/schemas/BranchCreateResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Branch successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchResource"}},"schemaId":"components/schemas/BranchResource"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/BranchResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BranchResource"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branches/addenvironment"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches"}],"content":{"contentType":"group","meta":{"name":"Branches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Branches","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A branch is an isolated workspace that contains its own set of content types, content items, and media. Every branch is created from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" branch."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}","summary":"Delete a branch","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/branches/branchdelete","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}","summary":"Retrieve a branch by its ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/branches/environmentbyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}","summary":"Update a branch","prefix":{"name":"put","color":"put"},"badges":[],"link":"/branches/environmentupdate","deprecated":false},{"title":"/api/v2/cm/branches","summary":"Retrieve all branches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/branches/allenvironments","deprecated":false},{"title":"/api/v2/cm/branches","summary":"Create a branch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/branches/addenvironment","deprecated":false}]}]}]}]}},{"type":"separator","label":"Localization endpoints","content":null},{"type":"group","label":"Locales","link":"/sai/xm-cloud-content/content-management-api/locales","routeSlug":"/sai/xm-cloud-content/content-management-api/locales","items":[{"label":"Delete a locale","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/locales/deletelocale","routeSlug":"/sai/xm-cloud-content/content-management-api/locales/deletelocale","metadata":{"seo":{"title":"Delete a locale","description":"Deletes a locale with a specific ID (for example, en-US). You cannot deletea locale if it is being used by a content item or if it is the default locale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteLocale","name":"Delete a locale","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a locale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a locale with a specific ID (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot delete"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a locale if it is being used by a content item or if it is the default locale."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"localeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/branches/{branchId}/locales/{localeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"localeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/locales/{localeId}","href":"locales/deletelocale","openApiOperationId":"DeleteLocale","summary":"Delete a locale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion."},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locales/deletelocale"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/locales/{localeId}"},{"label":"Retrieve a locale","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/locales/localebyid","routeSlug":"/sai/xm-cloud-content/content-management-api/locales/localebyid","metadata":{"seo":{"title":"Retrieve a locale","description":"Retrieves a locale with a specific ID, for example sv-SE."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocaleById","name":"Retrieve a locale","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a locale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a locale with a specific ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sv-SE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"localeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale identifier, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sv-SE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/locales/{localeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"localeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/locales/{localeId}","href":"locales/localebyid","openApiOperationId":"LocaleById","summary":"Retrieve a locale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocaleResponse"}},"schemaId":"components/schemas/LocaleResponse"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocaleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocaleResponse"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locales/localebyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/locales/{localeId}"},{"label":"Update a locale","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/locales/updatelocale","routeSlug":"/sai/xm-cloud-content/content-management-api/locales/updatelocale","metadata":{"seo":{"title":"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateLocale","name":"Update a locale","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a locale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a locale. For example, to update the name of a locale that is being changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"French(France)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"French(fr-FR)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"localeId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the locale, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"da-DK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"application/json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"text/json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/LocaleUpdateRequest"}},"schemaId":"components/schemas/LocaleUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/put/requestBody","description":"Parameter containing the locale details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/branches/{branchId}/locales/{localeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"localeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"application/json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"text/json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/LocaleUpdateRequest"}},"responseCodes":["204","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/locales/{localeId}","href":"locales/updatelocale","openApiOperationId":"UpdateLocale","summary":"Update a locale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/LocaleUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"application/json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"text/json":{"schemaId":"components/schemas/LocaleUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/LocaleUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales~1{localeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locales/updatelocale"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/locales/{localeId}"},{"label":"Retrieve a list of locales","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/locales/getlocales","routeSlug":"/sai/xm-cloud-content/content-management-api/locales/getlocales","metadata":{"seo":{"title":"Retrieve a list of locales","description":"Lists all defined locales. If you don't specify any filtering parameters, you will retrieve all available locales."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetLocales","name":"Retrieve a list of locales","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of locales","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all defined locales. If you don't specify any filtering parameters, you will retrieve all available locales."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/locales","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/locales","href":"locales/getlocales","openApiOperationId":"GetLocales","summary":"Retrieve a list of locales"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocaleListResponse"}},"schemaId":"components/schemas/LocaleListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocaleListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocaleListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locales/getlocales"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/locales"},{"label":"Create a locale","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/locales/addlocale","routeSlug":"/sai/xm-cloud-content/content-management-api/locales/addlocale","metadata":{"seo":{"title":"Create a locale","description":"Creates a locale (for example, create a locale called es-CL forSpanish(Chile) and set it as the default locale). A locale consists of atwo- or three-letter language code and a two- or three-letter region code.The region code is optional (for example, English can be defined as en or eng)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddLocale","name":"Create a locale","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a locale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a locale (for example, create a locale called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es-CL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spanish(Chile) and set it as the default locale). A locale consists of a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two- or three-letter language code and a two- or three-letter region code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The region code is optional (for example, English can be defined as en or eng)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1*+json/example"]}},"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example"],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody","description":"Parameter containing the locale details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/locales","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1*+json/example"]}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v2/cm/branches/{branchId}/locales","href":"locales/addlocale","openApiOperationId":"AddLocale","summary":"Create a locale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example"],"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example"]},"application/json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json/example"]},"text/json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/text~1json/example"]},"application/*+json":{"schemaId":"components/schemas/LocaleCreateRequest","exampleIds":["paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1*+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Locale successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocaleResponse"}},"schemaId":"components/schemas/LocaleResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/LocaleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocaleResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locales/addlocale"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/locales"}],"content":{"contentType":"group","meta":{"name":"Locales"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locales","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A locale is an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/IETF_language_tag"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IETF language tag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, the locale for American English is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and for British English is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The region code is optional."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/locales/{localeId}","summary":"Delete a locale","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/locales/deletelocale","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/locales/{localeId}","summary":"Retrieve a locale","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locales/localebyid","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/locales/{localeId}","summary":"Update a locale","prefix":{"name":"put","color":"put"},"badges":[],"link":"/locales/updatelocale","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/locales","summary":"Retrieve a list of locales","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locales/getlocales","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/locales","summary":"Create a locale","prefix":{"name":"post","color":"post"},"badges":[],"link":"/locales/addlocale","deprecated":false}]}]}]}]}},{"type":"separator","label":"Workset endpoints","content":null},{"type":"group","label":"Worksets","link":"/sai/xm-cloud-content/content-management-api/worksets","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets","items":[{"label":"Delete a workset","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/deleteworkset","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/deleteworkset","metadata":{"seo":{"title":"Delete a workset","description":"Deletes a workset. This does not delete the individual content items, content types, or taxonomies it contains  You can only delete worksets that have not been used by a process. Worksets expire after 30 days. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteWorkset","name":"Delete a workset","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a workset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a workset. This does not delete the individual content items, content types, or taxonomies it contains "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can only delete worksets that have not been used by a process. Worksets expire after 30 days. "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"worksetId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the workset.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"worksetId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","href":"worksets/deleteworkset","openApiOperationId":"DeleteWorkset","summary":"Delete a workset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/deleteworkset"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}"},{"label":"Retrieve a workset using its ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/getworkset","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/getworkset","metadata":{"seo":{"title":"Retrieve a workset using its ID","description":"Lists the items, options, and so on that are in a workset with a specific ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetWorkset","name":"Retrieve a workset using its ID","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a workset using its ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the items, options, and so on that are in a workset with a specific ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"worksetId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the workset.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"worksetId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","href":"worksets/getworkset","openApiOperationId":"GetWorkset","summary":"Retrieve a workset using its ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetResponse"}},"schemaId":"components/schemas/WorksetResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorksetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/getworkset"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}"},{"label":"Partially update a workset","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/partialupdateworkset","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/partialupdateworkset","metadata":{"seo":{"title":"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 operations: add, remove, replace, move, copy, and test."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartialUpdateWorkSet","name":"Partially update a workset","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a workset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates the content items, content types, and taxonomies that make up a particular workset using the following "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc6902"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Patch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations: add, remove, replace, move, copy, and test."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TThe ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"worksetId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the workset.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_1589"},"application/json":{"schemaId":"schema_1589"},"text/json":{"schemaId":"schema_1589"},"application/*+json":{"schemaId":"schema_1589"}},"schemaId":"schema_1589","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/patch/requestBody","description":"The request containing the details of the workset to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"worksetId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_1589"},"application/json":{"schemaId":"schema_1589"},"text/json":{"schemaId":"schema_1589"},"application/*+json":{"schemaId":"schema_1589"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","href":"worksets/partialupdateworkset","openApiOperationId":"PartialUpdateWorkSet","summary":"Partially update a workset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"schema_1589","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_1589"},"application/json":{"schemaId":"schema_1589"},"text/json":{"schemaId":"schema_1589"},"application/*+json":{"schemaId":"schema_1589"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/partialupdateworkset"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}"},{"label":"Update a workset","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/updateworkset","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/updateworkset","metadata":{"seo":{"title":"Update a workset","description":"Updates a particular workset, including the content items, content types, taxonomies and so on."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateWorkset","name":"Update a workset","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a workset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a particular workset, including the content items, content types, taxonomies and so on."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TThe ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"worksetId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the workset.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"application/json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"text/json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/WorksetUpdateRequest"}},"schemaId":"components/schemas/WorksetUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/put/requestBody","description":"The request containing the details of the workset to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"worksetId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"application/json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"text/json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/WorksetUpdateRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","href":"worksets/updateworkset","openApiOperationId":"UpdateWorkset","summary":"Update a workset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/WorksetUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"application/json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"text/json":{"schemaId":"components/schemas/WorksetUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/WorksetUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update."},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/updateworkset"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}"},{"label":"Retrieve a list of worksets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/getlistworkset","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/getlistworkset","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetListWorkset","name":"Retrieve a list of worksets","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of worksets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists worksets that have been created. If you don't specify any filtering parameters, you will retrieve all available worksets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/worksets","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets","href":"worksets/getlistworkset","openApiOperationId":"GetListWorkset","summary":"Retrieve a list of worksets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetListResponse"}},"schemaId":"components/schemas/WorksetListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorksetListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/getlistworkset"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets"},{"label":"Create a workset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/createworkset","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/createworkset","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateWorkset","name":"Create a workset","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a workset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a workset to hold a group of content items, content types, or taxonomies. This allows you to run tasks for the workset."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/WorksetRequest"},"application/json":{"schemaId":"components/schemas/WorksetRequest"},"text/json":{"schemaId":"components/schemas/WorksetRequest"},"application/*+json":{"schemaId":"components/schemas/WorksetRequest"}},"schemaId":"components/schemas/WorksetRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/post/requestBody","description":"The request containing the details of the workset to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/worksets","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/WorksetRequest"},"application/json":{"schemaId":"components/schemas/WorksetRequest"},"text/json":{"schemaId":"components/schemas/WorksetRequest"},"application/*+json":{"schemaId":"components/schemas/WorksetRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets","href":"worksets/createworkset","openApiOperationId":"CreateWorkset","summary":"Create a workset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/WorksetRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/WorksetRequest"},"application/json":{"schemaId":"components/schemas/WorksetRequest"},"text/json":{"schemaId":"components/schemas/WorksetRequest"},"application/*+json":{"schemaId":"components/schemas/WorksetRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetResponse"}},"schemaId":"components/schemas/WorksetResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WorksetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/createworkset"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets"},{"label":"Retrieve all the items in a workset with a specific ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/worksets/getworksetitems","routeSlug":"/sai/xm-cloud-content/content-management-api/worksets/getworksetitems","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetWorksetItems","name":"Retrieve all the items in a workset with a specific ID","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all the items in a workset with a specific ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the content items, content types, and taxonomies that are in a particular workset using its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"worksetId","in":"path","schemaId":"schema_1585","description":"The workset identifier.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}/items","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"worksetId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}/items","href":"worksets/getworksetitems","openApiOperationId":"GetWorksetItems","summary":"Retrieve all the items in a workset with a specific ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetItemListResponse"}},"schemaId":"components/schemas/WorksetItemListResponse"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1worksets~1{worksetId}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorksetItemListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorksetItemListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksets/getworksetitems"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}/items"}],"content":{"contentType":"group","meta":{"name":"Worksets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Worksets","showPageActions":true},{"nodeType":"markdoc","content":"A workset brings content items, content types, and taxonomies together in a group and allows you to execute tasks on it."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","summary":"Delete a workset","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/worksets/deleteworkset","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","summary":"Retrieve a workset using its ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/worksets/getworkset","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","summary":"Partially update a workset","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/worksets/partialupdateworkset","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}","summary":"Update a workset","prefix":{"name":"put","color":"put"},"badges":[],"link":"/worksets/updateworkset","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/worksets","summary":"Retrieve a list of worksets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/worksets/getlistworkset","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/worksets","summary":"Create a workset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/worksets/createworkset","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/worksets/{worksetId}/items","summary":"Retrieve all the items in a workset with a specific ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/worksets/getworksetitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Job types","link":"/sai/xm-cloud-content/content-management-api/job-types","routeSlug":"/sai/xm-cloud-content/content-management-api/job-types","items":[{"label":"Delete a job type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/job-types/deletejobtype","routeSlug":"/sai/xm-cloud-content/content-management-api/job-types/deletejobtype","metadata":{"seo":{"title":"Delete a job type","description":"Deletes all the processes in the job type using its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteJobType","name":"Delete a job type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a job type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes all the processes in the job type using its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobTypeId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the job.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/job-types/{jobTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"jobTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/job-types/{jobTypeId}","href":"job-types/deletejobtype","openApiOperationId":"DeleteJobType","summary":"Delete a job type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion"},{"code":"400","description":"Request not valid or error during operation","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Job type not found","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-types/deletejobtype"}],"panels":[]}]},"httpPath":"/api/v2/cm/job-types/{jobTypeId}"},{"label":"Retrieve a job type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/job-types/getjobtype","routeSlug":"/sai/xm-cloud-content/content-management-api/job-types/getjobtype","metadata":{"seo":{"title":"Retrieve a job type","description":"Retrieves a specific job type using its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetJobType","name":"Retrieve a job type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a job type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific job type using its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobTypeId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the job.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/job-types/{jobTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"jobTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/job-types/{jobTypeId}","href":"job-types/getjobtype","openApiOperationId":"GetJobType","summary":"Retrieve a job type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobTypeResponse"}},"schemaId":"components/schemas/JobTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Job type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-types/getjobtype"}],"panels":[]}]},"httpPath":"/api/v2/cm/job-types/{jobTypeId}"},{"label":"Update a job type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/job-types/updatejobtype","routeSlug":"/sai/xm-cloud-content/content-management-api/job-types/updatejobtype","metadata":{"seo":{"title":"Update a job type","description":"Updates a job type using its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateJobType","name":"Update a job type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a job type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a job type using its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobTypeId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the job type.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/JobTypeRequest"},"application/json":{"schemaId":"components/schemas/JobTypeRequest"},"text/json":{"schemaId":"components/schemas/JobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/JobTypeRequest"}},"schemaId":"components/schemas/JobTypeRequest","pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/put/requestBody","description":"The request containing the updated details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/job-types/{jobTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"jobTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/JobTypeRequest"},"application/json":{"schemaId":"components/schemas/JobTypeRequest"},"text/json":{"schemaId":"components/schemas/JobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/JobTypeRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/job-types/{jobTypeId}","href":"job-types/updatejobtype","openApiOperationId":"UpdateJobType","summary":"Update a job type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/JobTypeRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/JobTypeRequest"},"application/json":{"schemaId":"components/schemas/JobTypeRequest"},"text/json":{"schemaId":"components/schemas/JobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/JobTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Job type not found","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1job-types~1{jobTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"},"text/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-types/updatejobtype"}],"panels":[]}]},"httpPath":"/api/v2/cm/job-types/{jobTypeId}"},{"label":"Retrieve a list of job types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/job-types/getlistjobtype","routeSlug":"/sai/xm-cloud-content/content-management-api/job-types/getlistjobtype","metadata":{"seo":{"title":"Retrieve a list of job types","description":"Lists job types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetListJobType","name":"Retrieve a list of job types","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1job-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of job types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists job types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"}],"pointer":"/paths/~1api~1v2~1cm~1job-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/job-types","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/job-types","href":"job-types/getlistjobtype","openApiOperationId":"GetListJobType","summary":"Retrieve a list of job types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1590"}},"schemaId":"schema_1590"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Job type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1job-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1590","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1590"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-types/getlistjobtype"}],"panels":[]}]},"httpPath":"/api/v2/cm/job-types"},{"label":"Create a job type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/job-types/createjobtype","routeSlug":"/sai/xm-cloud-content/content-management-api/job-types/createjobtype","metadata":{"seo":{"title":"Create a job type","description":"Creates a job type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateJobType","name":"Create a job type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1job-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a job type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a job type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/JobTypeRequest"},"application/json":{"schemaId":"components/schemas/JobTypeRequest"},"text/json":{"schemaId":"components/schemas/JobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/JobTypeRequest"}},"schemaId":"components/schemas/JobTypeRequest","pointer":"/paths/~1api~1v2~1cm~1job-types/post/requestBody","description":"The request containing the details of the job type to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/job-types","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/JobTypeRequest"},"application/json":{"schemaId":"components/schemas/JobTypeRequest"},"text/json":{"schemaId":"components/schemas/JobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/JobTypeRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/api/v2/cm/job-types","href":"job-types/createjobtype","openApiOperationId":"CreateJobType","summary":"Create a job type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/JobTypeRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/JobTypeRequest"},"application/json":{"schemaId":"components/schemas/JobTypeRequest"},"text/json":{"schemaId":"components/schemas/JobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/JobTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobTypeResponse"}},"schemaId":"components/schemas/JobTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1job-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/JobTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-types/createjobtype"}],"panels":[]}]},"httpPath":"/api/v2/cm/job-types"}],"content":{"contentType":"group","meta":{"name":"Job types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job types","showPageActions":true},{"nodeType":"markdoc","content":"A job type is a sequence of processes to execute on a workset."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/job-types/{jobTypeId}","summary":"Delete a job type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/job-types/deletejobtype","deprecated":false},{"title":"/api/v2/cm/job-types/{jobTypeId}","summary":"Retrieve a job type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/job-types/getjobtype","deprecated":false},{"title":"/api/v2/cm/job-types/{jobTypeId}","summary":"Update a job type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/job-types/updatejobtype","deprecated":false},{"title":"/api/v2/cm/job-types","summary":"Retrieve a list of job types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/job-types/getlistjobtype","deprecated":false},{"title":"/api/v2/cm/job-types","summary":"Create a job type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/job-types/createjobtype","deprecated":false}]}]}]}]}},{"type":"group","label":"Jobs","link":"/sai/xm-cloud-content/content-management-api/jobs","routeSlug":"/sai/xm-cloud-content/content-management-api/jobs","items":[{"label":"Retrieve job details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/jobs/getjob","routeSlug":"/sai/xm-cloud-content/content-management-api/jobs/getjob","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetJob","name":"Retrieve job details","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve job details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists information about a specific job. This is useful, for example, when you want to get the provisioning status using the task identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"jobId","in":"path","schemaId":"schema_1585","description":"The unique identifier of job details.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/jobs/{jobId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"jobId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/jobs/{jobId}","href":"jobs/getjob","openApiOperationId":"GetJob","summary":"Retrieve job details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobGetResponse"}},"schemaId":"components/schemas/JobGetResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobGetResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjob"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/jobs/{jobId}"},{"label":"Retrieve a list of job details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/jobs/getlistjob","routeSlug":"/sai/xm-cloud-content/content-management-api/jobs/getlistjob","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetListJob","name":"Retrieve a list of job details","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of job details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists job details and associated information. If you don't specify any filtering parameters, you will retrieve all workset chain execution details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/jobs","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/jobs","href":"jobs/getlistjob","openApiOperationId":"GetListJob","summary":"Retrieve a list of job details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobListResponse"}},"schemaId":"components/schemas/JobListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getlistjob"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/jobs"},{"label":"Create chain execution details for a workset and job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/jobs/createjob","routeSlug":"/sai/xm-cloud-content/content-management-api/jobs/createjob","metadata":{"seo":{"title":"Create chain execution details for a workset and job","description":"Creates execution details for a specific workset and job using their IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateJob","name":"Create chain execution details for a workset and job","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create chain execution details for a workset and job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates execution details for a specific workset and job using their IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/JobCreateRequest"},"application/json":{"schemaId":"components/schemas/JobCreateRequest"},"text/json":{"schemaId":"components/schemas/JobCreateRequest"},"application/*+json":{"schemaId":"components/schemas/JobCreateRequest"}},"schemaId":"components/schemas/JobCreateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/post/requestBody","description":"The request containing the details of the job to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/jobs","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/JobCreateRequest"},"application/json":{"schemaId":"components/schemas/JobCreateRequest"},"text/json":{"schemaId":"components/schemas/JobCreateRequest"},"application/*+json":{"schemaId":"components/schemas/JobCreateRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/jobs","href":"jobs/createjob","openApiOperationId":"CreateJob","summary":"Create chain execution details for a workset and job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/JobCreateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/JobCreateRequest"},"application/json":{"schemaId":"components/schemas/JobCreateRequest"},"text/json":{"schemaId":"components/schemas/JobCreateRequest"},"application/*+json":{"schemaId":"components/schemas/JobCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobCreateResponse"}},"schemaId":"components/schemas/JobCreateResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/JobCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobCreateResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/createjob"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/jobs"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"A job consists of tasks that are to be executed on a workset."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/jobs/{jobId}","summary":"Retrieve job details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjob","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/jobs","summary":"Retrieve a list of job details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getlistjob","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/jobs","summary":"Create chain execution details for a workset and job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/createjob","deprecated":false}]}]}]}]}},{"type":"group","label":"Task types","link":"/sai/xm-cloud-content/content-management-api/task-types","routeSlug":"/sai/xm-cloud-content/content-management-api/task-types","items":[{"label":"Delete a task type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/task-types/deletetasktype","routeSlug":"/sai/xm-cloud-content/content-management-api/task-types/deletetasktype","metadata":{"seo":{"title":"Delete a task type","description":"Deletes a task type using its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTaskType","name":"Delete a task type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a task type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a task type using its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskTypeId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the task type.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v2/cm/task-types/{taskTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"taskTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/task-types/{taskTypeId}","href":"task-types/deletetasktype","openApiOperationId":"DeleteTaskType","summary":"Delete a task type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Task type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-types/deletetasktype"}],"panels":[]}]},"httpPath":"/api/v2/cm/task-types/{taskTypeId}"},{"label":"Retrieve a task type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/task-types/gettasktype","routeSlug":"/sai/xm-cloud-content/content-management-api/task-types/gettasktype","metadata":{"seo":{"title":"Retrieve a task type","description":"Retrieves a specific task type using its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTaskType","name":"Retrieve a task type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a task type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific task type using its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskTypeId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the workset.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/task-types/{taskTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"taskTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/task-types/{taskTypeId}","href":"task-types/gettasktype","openApiOperationId":"GetTaskType","summary":"Retrieve a task type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskTypeResponse"}},"schemaId":"components/schemas/TaskTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Task not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-types/gettasktype"}],"panels":[]}]},"httpPath":"/api/v2/cm/task-types/{taskTypeId}"},{"label":"Update a task type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/task-types/updatetasktype","routeSlug":"/sai/xm-cloud-content/content-management-api/task-types/updatetasktype","metadata":{"seo":{"title":"Update a task type","description":"Updates a task type using its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTaskType","name":"Update a task type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a task type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a task type using its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"taskTypeId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the task type.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"text/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/*+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"}},"schemaId":"components/schemas/Tasks.TaskTypeRequest","pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/put/requestBody","description":"The request containing the details of the task type to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/task-types/{taskTypeId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"taskTypeId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"text/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/*+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/task-types/{taskTypeId}","href":"task-types/updatetasktype","openApiOperationId":"UpdateTaskType","summary":"Update a task type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/Tasks.TaskTypeRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"text/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/*+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Task type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1task-types~1{taskTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-types/updatetasktype"}],"panels":[]}]},"httpPath":"/api/v2/cm/task-types/{taskTypeId}"},{"label":"Retrieve a list of task types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/task-types/getlisttasktype","routeSlug":"/sai/xm-cloud-content/content-management-api/task-types/getlisttasktype","metadata":{"seo":{"title":"Retrieve a list of task types","description":"Lists task types. If you don't specify any filtering parameters, you will retrieve all task types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetListTaskType","name":"Retrieve a list of task types","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1task-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of task types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists task types. If you don't specify any filtering parameters, \nyou will retrieve all task types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/task-types","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/task-types","href":"task-types/getlisttasktype","openApiOperationId":"GetListTaskType","summary":"Retrieve a list of task types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1591"}},"schemaId":"schema_1591"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Task type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1task-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1591"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-types/getlisttasktype"}],"panels":[]}]},"httpPath":"/api/v2/cm/task-types"},{"label":"Create a task type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/task-types/addtasktype","routeSlug":"/sai/xm-cloud-content/content-management-api/task-types/addtasktype","metadata":{"seo":{"title":"Create a task type","description":"Creates a new task type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddTaskType","name":"Create a task type","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1task-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a task type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new task type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"text/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/*+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"}},"schemaId":"components/schemas/Tasks.TaskTypeRequest","pointer":"/paths/~1api~1v2~1cm~1task-types/post/requestBody","description":"The request containing the details of the task type to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/task-types","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"text/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/*+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/api/v2/cm/task-types","href":"task-types/addtasktype","openApiOperationId":"AddTaskType","summary":"Create a task type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/Tasks.TaskTypeRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"text/json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"},"application/*+json":{"schemaId":"components/schemas/Tasks.TaskTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeResponse"}},"schemaId":"components/schemas/Tasks.TaskTypeResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}},"schemaId":"components/schemas/Mvc.ValidationProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1task-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Tasks.TaskTypeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tasks.TaskTypeResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ValidationProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-types/addtasktype"}],"panels":[]}]},"httpPath":"/api/v2/cm/task-types"}],"content":{"contentType":"group","meta":{"name":"Task types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task types","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A task type defines a process that can be executed as a task on a workset. An example of a task type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Publishing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". There are two types of external tasks:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Those that are actions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAction: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") associated with a content type or fragment and executed on a single item in a workset."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Those executed on an entire workset ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAction: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). These external tasks can issue callback requests to send tasks."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/task-types/{taskTypeId}","summary":"Delete a task type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/task-types/deletetasktype","deprecated":false},{"title":"/api/v2/cm/task-types/{taskTypeId}","summary":"Retrieve a task type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-types/gettasktype","deprecated":false},{"title":"/api/v2/cm/task-types/{taskTypeId}","summary":"Update a task type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task-types/updatetasktype","deprecated":false},{"title":"/api/v2/cm/task-types","summary":"Retrieve a list of task types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-types/getlisttasktype","deprecated":false},{"title":"/api/v2/cm/task-types","summary":"Create a task type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task-types/addtasktype","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/sai/xm-cloud-content/content-management-api/tasks","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks","items":[{"label":"Retrieve task details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/tasks/gettask","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks/gettask","metadata":{"seo":{"title":"Retrieve task details","description":"Lists information about a specific task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTask","name":"Retrieve task details","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve task details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists information about a specific task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taskId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the task details.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/tasks/{taskId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taskId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/tasks/{taskId}","href":"tasks/gettask","openApiOperationId":"GetTask","summary":"Retrieve task details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskGetResponse"}},"schemaId":"components/schemas/TaskGetResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskGetResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/gettask"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/tasks/{taskId}"},{"label":"Retrieve a list of tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/tasks/getlisttask","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks/getlisttask","metadata":{"seo":{"title":"Retrieve a list of tasks","description":"Lists tasks and associated details. If you don't specify any filtering parameters, you will retrieve all tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetListTask","name":"Retrieve a list of tasks","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists tasks and associated details. If you don't specify any filtering parameters, you will retrieve all tasks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/tasks","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"Search","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/tasks","href":"tasks/getlisttask","openApiOperationId":"GetListTask","summary":"Retrieve a list of tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskListResponse"}},"schemaId":"components/schemas/TaskListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/getlisttask"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/tasks"},{"label":"Create execution details for specific workset and task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/tasks/createtask","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks/createtask","metadata":{"seo":{"title":"Create execution details for specific workset and task","description":"Creates new execution details for a specific workset and task using their IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateTask","name":"Create execution details for specific workset and task","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create execution details for specific workset and task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates new execution details for a specific workset and task using their IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaskCreateRequest"},"application/json":{"schemaId":"components/schemas/TaskCreateRequest"},"text/json":{"schemaId":"components/schemas/TaskCreateRequest"},"application/*+json":{"schemaId":"components/schemas/TaskCreateRequest"}},"schemaId":"components/schemas/TaskCreateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/post/requestBody","description":"The request containing the details of the task to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/tasks","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/TaskCreateRequest"},"application/json":{"schemaId":"components/schemas/TaskCreateRequest"},"text/json":{"schemaId":"components/schemas/TaskCreateRequest"},"application/*+json":{"schemaId":"components/schemas/TaskCreateRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/api/v2/cm/branches/{branchId}/tasks","href":"tasks/createtask","openApiOperationId":"CreateTask","summary":"Create execution details for specific workset and task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/TaskCreateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaskCreateRequest"},"application/json":{"schemaId":"components/schemas/TaskCreateRequest"},"text/json":{"schemaId":"components/schemas/TaskCreateRequest"},"application/*+json":{"schemaId":"components/schemas/TaskCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskCreateResponse"}},"schemaId":"components/schemas/TaskCreateResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaskCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskCreateResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/createtask"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/tasks"},{"label":"Retrieve details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/tasks/gettaskitems","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks/gettaskitems","metadata":{"seo":{"title":"Retrieve details","description":"Lists task details for a specific workset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTaskItems","name":"Retrieve details","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists task details for a specific workset."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taskId","in":"path","schemaId":"schema_1585","description":"The task identifier.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/items","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taskId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/items","href":"tasks/gettaskitems","openApiOperationId":"GetTaskItems","summary":"Retrieve details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskItemListResponse"}},"schemaId":"components/schemas/TaskItemListResponse"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskItemListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskItemListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/gettaskitems"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/items"},{"label":"Update task details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/tasks/callbackupdatetask","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks/callbackupdatetask","metadata":{"seo":{"title":"Update task details","description":"Updates the process status or statistics of a task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CallbackUpdateTask","name":"Update task details","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update task details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the process status or statistics of a task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taskId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the task details.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaskUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaskUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaskUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaskUpdateRequest"}},"schemaId":"components/schemas/TaskUpdateRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback/post/requestBody","description":"The request containing the details of the task to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taskId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/TaskUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaskUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaskUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaskUpdateRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback","href":"tasks/callbackupdatetask","openApiOperationId":"CallbackUpdateTask","summary":"Update task details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/TaskUpdateRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaskUpdateRequest"},"application/json":{"schemaId":"components/schemas/TaskUpdateRequest"},"text/json":{"schemaId":"components/schemas/TaskUpdateRequest"},"application/*+json":{"schemaId":"components/schemas/TaskUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful update"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token"},{"code":"403","description":"Request does not contain required scopes"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/callbackupdatetask"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback"},{"label":"Log item failures for a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/tasks/callbacklogitemfailures","routeSlug":"/sai/xm-cloud-content/content-management-api/tasks/callbacklogitemfailures","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CallbackLogItemFailures","name":"Log item failures for a task","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback~1log/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Log item failures for a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint can be used by external tasks to report an error while processing a specific workset item as part of a workset execution."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"branchId","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the branch, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"taskId","in":"path","schemaId":"schema_1585","description":"The unique identifier of the task.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback~1log/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"application/json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"text/json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"application/*+json":{"schemaId":"components/schemas/TaskLogFailuresRequest"}},"schemaId":"components/schemas/TaskLogFailuresRequest","pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback~1log/post/requestBody","description":"The request containing the item failures to log."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback/log","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"branchId","in":"path","required":true,"schemaId":"schema_1585"},{"name":"taskId","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"application/json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"text/json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"application/*+json":{"schemaId":"components/schemas/TaskLogFailuresRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback/log","href":"tasks/callbacklogitemfailures","openApiOperationId":"CallbackLogItemFailures","summary":"Log item failures for a task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"schemaId":"components/schemas/TaskLogFailuresRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"application/json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"text/json":{"schemaId":"components/schemas/TaskLogFailuresRequest"},"application/*+json":{"schemaId":"components/schemas/TaskLogFailuresRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workset Item Execution Failure was successfully registered."},{"code":"400","description":"Invalid object in request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token."},{"code":"403","description":"Request does not contain required scopes."},{"code":"404","description":"Task details not found using specified ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server side exception during request execution."}],"pointer":"/paths/~1api~1v2~1cm~1branches~1{branchId}~1tasks~1{taskId}~1callback~1log/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/callbacklogitemfailures"}],"panels":[]}]},"httpPath":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback/log"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":"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)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/branches/{branchId}/tasks/{taskId}","summary":"Retrieve task details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/gettask","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/tasks","summary":"Retrieve a list of tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/getlisttask","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/tasks","summary":"Create execution details for specific workset and task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/createtask","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/items","summary":"Retrieve details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/gettaskitems","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback","summary":"Update task details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/callbackupdatetask","deprecated":false},{"title":"/api/v2/cm/branches/{branchId}/tasks/{taskId}/callback/log","summary":"Log item failures for a task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/callbacklogitemfailures","deprecated":false}]}]}]}]}},{"type":"separator","label":"Security endpoints","content":null},{"type":"group","label":"Users","link":"/sai/xm-cloud-content/content-management-api/users","routeSlug":"/sai/xm-cloud-content/content-management-api/users","items":[{"label":"Retrieve a user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/users/getuserbyid","routeSlug":"/sai/xm-cloud-content/content-management-api/users/getuserbyid","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserById","name":"Retrieve a user by ID","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the first and last name of a user using their ID along with their authId, organization ID, and type of user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the user, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6Ioy0AbFz5Xv5C6mWJXgoF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/users/{id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/users/{id}","href":"users/getuserbyid","openApiOperationId":"GetUserById","summary":"Retrieve a user by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuserbyid"}],"panels":[]}]},"httpPath":"/api/v2/cm/users/{id}"},{"label":"Update a user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/users/updateuser","routeSlug":"/sai/xm-cloud-content/content-management-api/users/updateuser","metadata":{"seo":{"title":"Update a user","description":"Updates the first or last name of a user with a specific ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateUser","name":"Update a user","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1users~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the first or last name of a user with a specific ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1585","description":"The ID of the user.","required":true}],"pointer":"/paths/~1api~1v2~1cm~1users~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v2/cm/users/{id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/api/v2/cm/users/{id}","href":"users/updateuser","openApiOperationId":"UpdateUser","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Nothing to update"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"User not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1users~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuser"}],"panels":[]}]},"httpPath":"/api/v2/cm/users/{id}"},{"label":"Retrieve a user using their authorization ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/users/getuserbyauthid","routeSlug":"/sai/xm-cloud-content/content-management-api/users/getuserbyauthid","metadata":{"seo":{"title":"Retrieve a user using their authorization ID","description":"Retrieves the first and last name of a user based on their email address.The email address is a unique identifier for the user.This request retrieves the first and last name of a specific Content Hub ONE user using the User ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserByAuthId","name":"Retrieve a user using their authorization ID","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1users~1auth~1{auth0Id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user using their authorization ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"auth0Id","in":"path","schemaId":"schema_1585","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The auth ID of the user, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth0|30a022c29056d6663266bdg0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1cm~1users~1auth~1{auth0Id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/users/auth/{auth0Id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[{"name":"auth0Id","in":"path","required":true,"schemaId":"schema_1585"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v2/cm/users/auth/{auth0Id}","href":"users/getuserbyauthid","openApiOperationId":"GetUserByAuthId","summary":"Retrieve a user using their authorization ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"404","description":"Item or entity not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1users~1auth~1{auth0Id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuserbyauthid"}],"panels":[]}]},"httpPath":"/api/v2/cm/users/auth/{auth0Id}"},{"label":"Retrieve a list of users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/xm-cloud-content/content-management-api/users/getusers","routeSlug":"/sai/xm-cloud-content/content-management-api/users/getusers","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUsers","name":"Retrieve a list of users","isWebhook":false,"pointer":"/paths/~1api~1v2~1cm~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"Type","in":"query","schemaId":"schema_1585"}],"pointer":"/paths/~1api~1v2~1cm~1users/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585","description":"The continuation token for next results."}],"pointer":"/paths/~1api~1v2~1cm~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/cm/users","servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"parameters":{"path":[],"query":[{"name":"SortBy","in":"query","schemaId":"schema_1585"},{"name":"MinimumPageSize","in":"query","schemaId":"schema_1588"},{"name":"Type","in":"query","schemaId":"schema_1585"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1585"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/api/v2/cm/users","href":"users/getusers","openApiOperationId":"GetUsers","summary":"Retrieve a list of users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}},"schemaId":"components/schemas/UserListResponse"},{"code":"400","description":"Request not valid or error during operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}},"schemaId":"components/schemas/Mvc.ProblemDetails"},{"code":"500","description":"Server-side exception during request execution"}],"pointer":"/paths/~1api~1v2~1cm~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}}},{"code":"400","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/Mvc.ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mvc.ProblemDetails"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getusers"}],"panels":[]}]},"httpPath":"/api/v2/cm/users"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/cm/users/{id}","summary":"Retrieve a user by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuserbyid","deprecated":false},{"title":"/api/v2/cm/users/{id}","summary":"Update a user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/updateuser","deprecated":false},{"title":"/api/v2/cm/users/auth/{auth0Id}","summary":"Retrieve a user using their authorization ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuserbyauthid","deprecated":false},{"title":"/api/v2/cm/users","summary":"Retrieve a list of users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getusers","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/BaseTaskMessageLogDTO":{"id":"components/schemas/BaseTaskMessageLogDTO","kind":"json-schema","title":"BaseTaskMessageLogDTO","data":{"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}},"components/schemas/BooleanFieldType":{"id":"components/schemas/BooleanFieldType","kind":"json-schema","title":"BooleanFieldType","data":{"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}},"components/schemas/ContentItemCreateRequest":{"id":"components/schemas/ContentItemCreateRequest","kind":"json-schema","title":"ContentItemCreateRequest","data":{"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}},"components/schemas/ContentItemNoFieldsResponse":{"id":"components/schemas/ContentItemNoFieldsResponse","kind":"json-schema","title":"ContentItemNoFieldsResponse","data":{"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}},"components/schemas/ContentItemNoFieldsResponseContentItemListResponse":{"id":"components/schemas/ContentItemNoFieldsResponseContentItemListResponse","kind":"json-schema","title":"ContentItemNoFieldsResponseContentItemListResponse","data":{"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}},"components/schemas/ContentItemPatchRequest":{"id":"components/schemas/ContentItemPatchRequest","kind":"json-schema","title":"ContentItemPatchRequest","data":{"type":"object","additionalProperties":false}},"components/schemas/ContentItemResource":{"id":"components/schemas/ContentItemResource","kind":"json-schema","title":"ContentItemResource","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"versionTags":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"components/schemas/ContentItemResourceContentItemListResponse":{"id":"components/schemas/ContentItemResourceContentItemListResponse","kind":"json-schema","title":"ContentItemResourceContentItemListResponse","data":{"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}},"components/schemas/ContentItemResponse":{"id":"components/schemas/ContentItemResponse","kind":"json-schema","title":"ContentItemResponse","data":{"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}},"components/schemas/ContentItemResponseContentItemListResponse":{"id":"components/schemas/ContentItemResponseContentItemListResponse","kind":"json-schema","title":"ContentItemResponseContentItemListResponse","data":{"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}},"components/schemas/ContentItemSystemResource":{"id":"components/schemas/ContentItemSystemResource","kind":"json-schema","title":"ContentItemSystemResource","data":{"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}},"components/schemas/ContentItemUpdateRequest":{"id":"components/schemas/ContentItemUpdateRequest","kind":"json-schema","title":"ContentItemUpdateRequest","data":{"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}},"components/schemas/ContentTypeCreateRequest":{"id":"components/schemas/ContentTypeCreateRequest","kind":"json-schema","title":"ContentTypeCreateRequest","data":{"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}},"components/schemas/ContentTypePatchRequest":{"id":"components/schemas/ContentTypePatchRequest","kind":"json-schema","title":"ContentTypePatchRequest","data":{"type":"object","additionalProperties":false}},"components/schemas/ContentTypeResponse":{"id":"components/schemas/ContentTypeResponse","kind":"json-schema","title":"ContentTypeResponse","data":{"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}},"components/schemas/ContentTypeResponseListResult":{"id":"components/schemas/ContentTypeResponseListResult","kind":"json-schema","title":"ContentTypeResponseListResult","data":{"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}},"components/schemas/ContentTypeUpdateRequest":{"id":"components/schemas/ContentTypeUpdateRequest","kind":"json-schema","title":"ContentTypeUpdateRequest","data":{"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}},"components/schemas/DateTimeFieldType":{"id":"components/schemas/DateTimeFieldType","kind":"json-schema","title":"DateTimeFieldType","data":{"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}},"components/schemas/DateTimeFieldTypeRules":{"id":"components/schemas/DateTimeFieldTypeRules","kind":"json-schema","title":"DateTimeFieldTypeRules","data":{"type":"object","properties":{"dateTimeRange":{"$ref":"#/components/schemas/DateTimeRangeRule"},"isFutureDate":{"$ref":"#/components/schemas/IsFutureDateRule"}},"additionalProperties":false}},"components/schemas/DateTimeRangeRule":{"id":"components/schemas/DateTimeRangeRule","kind":"json-schema","title":"DateTimeRangeRule","data":{"type":"object","properties":{"min":{"type":"string","nullable":true},"max":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/DecimalPlacesRule":{"id":"components/schemas/DecimalPlacesRule","kind":"json-schema","title":"DecimalPlacesRule","data":{"type":"object","properties":{"value":{"type":"integer","format":"int32"}},"additionalProperties":false}},"components/schemas/BranchCreateResource":{"id":"components/schemas/BranchCreateResource","kind":"json-schema","title":"BranchCreateResource","data":{"required":["id","name","source"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"source":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"}},"additionalProperties":false}},"components/schemas/BranchListResult":{"id":"components/schemas/BranchListResult","kind":"json-schema","title":"BranchListResult","data":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BranchResource"},"nullable":true}},"additionalProperties":false}},"components/schemas/BranchResource":{"id":"components/schemas/BranchResource","kind":"json-schema","title":"BranchResource","data":{"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}},"components/schemas/BranchResourceResponse":{"id":"components/schemas/BranchResourceResponse","kind":"json-schema","title":"BranchResourceResponse","data":{"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}},"components/schemas/BranchSystemResource":{"id":"components/schemas/BranchSystemResource","kind":"json-schema","title":"BranchSystemResource","data":{"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}},"components/schemas/BranchUpdateResource":{"id":"components/schemas/BranchUpdateResource","kind":"json-schema","title":"BranchUpdateResource","data":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"}},"additionalProperties":false}},"components/schemas/Common.SystemResource":{"id":"components/schemas/Common.SystemResource","kind":"json-schema","title":"Common.SystemResource","data":{"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}},"components/schemas/FieldReferenceRequest":{"id":"components/schemas/FieldReferenceRequest","kind":"json-schema","title":"FieldReferenceRequest","data":{"type":"object","properties":{"id":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/FieldReferenceTypesRule":{"id":"components/schemas/FieldReferenceTypesRule","kind":"json-schema","title":"FieldReferenceTypesRule","data":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"components/schemas/IsFutureDateRule":{"id":"components/schemas/IsFutureDateRule","kind":"json-schema","title":"IsFutureDateRule","data":{"type":"object","properties":{"value":{"type":"boolean","nullable":true}},"additionalProperties":false}},"components/schemas/ItemType":{"id":"components/schemas/ItemType","kind":"json-schema","title":"ItemType","data":{"enum":["ContentItem","ContentType","Taxonomy"],"type":"string"}},"components/schemas/JsonFieldType":{"id":"components/schemas/JsonFieldType","kind":"json-schema","title":"JsonFieldType","data":{"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}},"components/schemas/JsonFieldTypeRules":{"id":"components/schemas/JsonFieldTypeRules","kind":"json-schema","title":"JsonFieldTypeRules","data":{"type":"object","properties":{"length":{"$ref":"#/components/schemas/LengthRule"}},"additionalProperties":false}},"components/schemas/LengthRule":{"id":"components/schemas/LengthRule","kind":"json-schema","title":"LengthRule","data":{"type":"object","properties":{"min":{"type":"integer","format":"int32","nullable":true},"max":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}},"components/schemas/LimitNumberRule":{"id":"components/schemas/LimitNumberRule","kind":"json-schema","title":"LimitNumberRule","data":{"type":"object","properties":{"min":{"type":"number","format":"double","nullable":true},"max":{"type":"number","format":"double","nullable":true}},"additionalProperties":false}},"components/schemas/LimitRule":{"id":"components/schemas/LimitRule","kind":"json-schema","title":"LimitRule","data":{"type":"object","properties":{"min":{"type":"integer","format":"int64","nullable":true},"max":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false}},"components/schemas/LocaleCreateRequest":{"id":"components/schemas/LocaleCreateRequest","kind":"json-schema","title":"LocaleCreateRequest","data":{"required":["default","id","label"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"label":{"minLength":1,"type":"string"},"default":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/LocaleListResponse":{"id":"components/schemas/LocaleListResponse","kind":"json-schema","title":"LocaleListResponse","data":{"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}},"components/schemas/LocaleResponse":{"id":"components/schemas/LocaleResponse","kind":"json-schema","title":"LocaleResponse","data":{"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}},"components/schemas/Mvc.ProblemDetails":{"id":"components/schemas/Mvc.ProblemDetails","kind":"json-schema","title":"Mvc.ProblemDetails","data":{"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":{}}},"components/schemas/Mvc.ValidationProblemDetails":{"id":"components/schemas/Mvc.ValidationProblemDetails","kind":"json-schema","title":"Mvc.ValidationProblemDetails","data":{"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":{}}},"components/schemas/LocaleUpdateRequest":{"id":"components/schemas/LocaleUpdateRequest","kind":"json-schema","title":"LocaleUpdateRequest","data":{"required":["default","label"],"type":"object","properties":{"label":{"minLength":1,"type":"string"},"default":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/NumberFieldType":{"id":"components/schemas/NumberFieldType","kind":"json-schema","title":"NumberFieldType","data":{"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}},"components/schemas/NumberFieldTypeRules":{"id":"components/schemas/NumberFieldTypeRules","kind":"json-schema","title":"NumberFieldTypeRules","data":{"type":"object","properties":{"limit":{"$ref":"#/components/schemas/LimitNumberRule"},"decimalPlaces":{"$ref":"#/components/schemas/DecimalPlacesRule"}},"additionalProperties":false}},"components/schemas/Operation":{"id":"components/schemas/Operation","kind":"json-schema","title":"Operation","data":{"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}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"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":{}}},"components/schemas/PublishStatus":{"id":"components/schemas/PublishStatus","kind":"json-schema","title":"PublishStatus","data":{"enum":["Draft","Published","Archived"],"type":"string"}},"components/schemas/PublishSystemResource":{"id":"components/schemas/PublishSystemResource","kind":"json-schema","title":"PublishSystemResource","data":{"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}},"components/schemas/ReferenceFieldType":{"id":"components/schemas/ReferenceFieldType","kind":"json-schema","title":"ReferenceFieldType","data":{"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}},"components/schemas/ReferenceFieldTypeRules":{"id":"components/schemas/ReferenceFieldTypeRules","kind":"json-schema","title":"ReferenceFieldTypeRules","data":{"type":"object","properties":{"countLimit":{"$ref":"#/components/schemas/LimitRule"},"referencetypes":{"$ref":"#/components/schemas/FieldReferenceTypesRule"}},"additionalProperties":false}},"components/schemas/RegexpRule":{"id":"components/schemas/RegexpRule","kind":"json-schema","title":"RegexpRule","data":{"type":"object","properties":{"value":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/RichTextFieldType":{"id":"components/schemas/RichTextFieldType","kind":"json-schema","title":"RichTextFieldType","data":{"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}},"components/schemas/RichTextFieldTypeRules":{"id":"components/schemas/RichTextFieldTypeRules","kind":"json-schema","title":"RichTextFieldTypeRules","data":{"type":"object","properties":{"length":{"$ref":"#/components/schemas/LengthRule"}},"additionalProperties":false}},"components/schemas/SelectFieldTypeRequest":{"id":"components/schemas/SelectFieldTypeRequest","kind":"json-schema","title":"SelectFieldTypeRequest","data":{"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}},"components/schemas/SelectFieldTypeRules":{"id":"components/schemas/SelectFieldTypeRules","kind":"json-schema","title":"SelectFieldTypeRules","data":{"type":"object","properties":{"countLimit":{"$ref":"#/components/schemas/LimitRule"}},"additionalProperties":false}},"components/schemas/SystemResource":{"id":"components/schemas/SystemResource","kind":"json-schema","title":"SystemResource","data":{"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}},"components/schemas/TaxonomyCreateRequest":{"id":"components/schemas/TaxonomyCreateRequest","kind":"json-schema","title":"TaxonomyCreateRequest","data":{"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}},"components/schemas/TaxonomyListResponse":{"id":"components/schemas/TaxonomyListResponse","kind":"json-schema","title":"TaxonomyListResponse","data":{"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}},"components/schemas/TaxonomyResponse":{"id":"components/schemas/TaxonomyResponse","kind":"json-schema","title":"TaxonomyResponse","data":{"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}},"components/schemas/TaxonomyTermCreateRequest":{"id":"components/schemas/TaxonomyTermCreateRequest","kind":"json-schema","title":"TaxonomyTermCreateRequest","data":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"label":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/TaxonomyTermResponse":{"id":"components/schemas/TaxonomyTermResponse","kind":"json-schema","title":"TaxonomyTermResponse","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/TaxonomyTermUpdateRequest":{"id":"components/schemas/TaxonomyTermUpdateRequest","kind":"json-schema","title":"TaxonomyTermUpdateRequest","data":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/TaxonomyUpdateRequest":{"id":"components/schemas/TaxonomyUpdateRequest","kind":"json-schema","title":"TaxonomyUpdateRequest","data":{"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}},"components/schemas/TextFieldType":{"id":"components/schemas/TextFieldType","kind":"json-schema","title":"TextFieldType","data":{"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}},"components/schemas/TextFieldTypeRules":{"id":"components/schemas/TextFieldTypeRules","kind":"json-schema","title":"TextFieldTypeRules","data":{"type":"object","properties":{"length":{"$ref":"#/components/schemas/LengthRule"},"regexp":{"$ref":"#/components/schemas/RegexpRule"}},"additionalProperties":false}},"components/schemas/UserListResponse":{"id":"components/schemas/UserListResponse","kind":"json-schema","title":"UserListResponse","data":{"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}},"components/schemas/UserResponse":{"id":"components/schemas/UserResponse","kind":"json-schema","title":"UserResponse","data":{"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}},"components/schemas/UserType":{"id":"components/schemas/UserType","kind":"json-schema","title":"UserType","data":{"enum":["User","Client"],"type":"string"}},"components/schemas/ValidationProblemDetails":{"id":"components/schemas/ValidationProblemDetails","kind":"json-schema","title":"ValidationProblemDetails","data":{"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":{}}},"components/schemas/VersionsStatusesListResponse":{"id":"components/schemas/VersionsStatusesListResponse","kind":"json-schema","title":"VersionsStatusesListResponse","data":{"type":"object","properties":{"versionsStatuses":{"type":"array","items":{"$ref":"#/components/schemas/VersionsStatusesResponse"},"nullable":true}},"additionalProperties":false}},"components/schemas/VersionsStatusesResponse":{"id":"components/schemas/VersionsStatusesResponse","kind":"json-schema","title":"VersionsStatusesResponse","data":{"type":"object","properties":{"version":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/PublishStatus"}},"additionalProperties":false}},"components/schemas/JobCreateRequest":{"id":"components/schemas/JobCreateRequest","kind":"json-schema","title":"JobCreateRequest","data":{"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}},"components/schemas/JobCreateResponse":{"id":"components/schemas/JobCreateResponse","kind":"json-schema","title":"JobCreateResponse","data":{"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}},"components/schemas/JobGetResponse":{"id":"components/schemas/JobGetResponse","kind":"json-schema","title":"JobGetResponse","data":{"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}},"components/schemas/JobListResponse":{"id":"components/schemas/JobListResponse","kind":"json-schema","title":"JobListResponse","data":{"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}},"components/schemas/JobStep":{"id":"components/schemas/JobStep","kind":"json-schema","title":"JobStep","data":{"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}},"components/schemas/TaskCreateRequest":{"id":"components/schemas/TaskCreateRequest","kind":"json-schema","title":"TaskCreateRequest","data":{"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}},"components/schemas/TaskCreateResponse":{"id":"components/schemas/TaskCreateResponse","kind":"json-schema","title":"TaskCreateResponse","data":{"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}},"components/schemas/TaskGetResponse":{"id":"components/schemas/TaskGetResponse","kind":"json-schema","title":"TaskGetResponse","data":{"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}},"components/schemas/TaskItemListResponse":{"id":"components/schemas/TaskItemListResponse","kind":"json-schema","title":"TaskItemListResponse","data":{"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}},"components/schemas/TaskListResponse":{"id":"components/schemas/TaskListResponse","kind":"json-schema","title":"TaskListResponse","data":{"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}},"components/schemas/TaskLogFailuresRequest":{"id":"components/schemas/TaskLogFailuresRequest","kind":"json-schema","title":"TaskLogFailuresRequest","data":{"required":["failures"],"type":"object","properties":{"failures":{"type":"array","items":{"$ref":"#/components/schemas/WorksetItemExecutionFailure"}}},"additionalProperties":false}},"components/schemas/TaskStatistics":{"id":"components/schemas/TaskStatistics","kind":"json-schema","title":"TaskStatistics","data":{"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}},"components/schemas/TaskStatus":{"id":"components/schemas/TaskStatus","kind":"json-schema","title":"TaskStatus","data":{"required":["state"],"type":"object","properties":{"state":{"$ref":"#/components/schemas/TaskStateCallbackRequest"},"description":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/TaskStatusDTO":{"id":"components/schemas/TaskStatusDTO","kind":"json-schema","title":"TaskStatusDTO","data":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/TaskState"},"description":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/TaskSystemResponse":{"id":"components/schemas/TaskSystemResponse","kind":"json-schema","title":"TaskSystemResponse","data":{"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}},"components/schemas/Tasks.TaskTypeOptions":{"id":"components/schemas/Tasks.TaskTypeOptions","kind":"json-schema","title":"Tasks.TaskTypeOptions","data":{"type":"object","properties":{"canBeStopped":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/Tasks.TaskTypeSettings":{"id":"components/schemas/Tasks.TaskTypeSettings","kind":"json-schema","title":"Tasks.TaskTypeSettings","data":{"required":["url"],"type":"object","properties":{"url":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/Tasks.TaskTypeVariableDefinition":{"id":"components/schemas/Tasks.TaskTypeVariableDefinition","kind":"json-schema","title":"Tasks.TaskTypeVariableDefinition","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","nullable":true},"required":{"type":"boolean"},"type":{"$ref":"#/components/schemas/Task.TaskTypeVariableType"}},"additionalProperties":false}},"components/schemas/Tasks.TaskTypeRequest":{"id":"components/schemas/Tasks.TaskTypeRequest","kind":"json-schema","title":"Tasks.TaskTypeRequest","data":{"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}},"components/schemas/Tasks.TaskTypeResponse":{"id":"components/schemas/Tasks.TaskTypeResponse","kind":"json-schema","title":"Tasks.TaskTypeResponse","data":{"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}},"components/schemas/TaskUpdateRequest":{"id":"components/schemas/TaskUpdateRequest","kind":"json-schema","title":"TaskUpdateRequest","data":{"required":["statistics","status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/TaskStatus"},"statistics":{"$ref":"#/components/schemas/TaskStatistics"}},"additionalProperties":false}},"components/schemas/WorksetExecutionOptions":{"id":"components/schemas/WorksetExecutionOptions","kind":"json-schema","title":"WorksetExecutionOptions","data":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{},"nullable":true}},"additionalProperties":false}},"components/schemas/TaskState":{"id":"components/schemas/TaskState","kind":"json-schema","title":"TaskState","data":{"enum":["Created","Pending","InProgress","Completed","Failed","Stopped","Waiting"],"type":"string"}},"components/schemas/Task.TaskTypeVariableType":{"id":"components/schemas/Task.TaskTypeVariableType","kind":"json-schema","title":"Task.TaskTypeVariableType","data":{"enum":["String","Number","Integer","Boolean","DateTime","Collection","List"],"type":"string"}},"components/schemas/TaskStateCallbackRequest":{"id":"components/schemas/TaskStateCallbackRequest","kind":"json-schema","title":"TaskStateCallbackRequest","data":{"enum":["InProgress","Completed","Failed","Stopped","Waiting"],"type":"string"}},"components/schemas/WorksetGetListResponse":{"id":"components/schemas/WorksetGetListResponse","kind":"json-schema","title":"WorksetGetListResponse","data":{"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}},"components/schemas/WorksetItem":{"id":"components/schemas/WorksetItem","kind":"json-schema","title":"WorksetItem","data":{"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}},"components/schemas/WorksetItemExecutionFailure":{"id":"components/schemas/WorksetItemExecutionFailure","kind":"json-schema","title":"WorksetItemExecutionFailure","data":{"required":["item"],"type":"object","properties":{"item":{"$ref":"#/components/schemas/WorksetItem"},"messages":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true}},"additionalProperties":false}},"components/schemas/WorksetItemListResponse":{"id":"components/schemas/WorksetItemListResponse","kind":"json-schema","title":"WorksetItemListResponse","data":{"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}},"components/schemas/WorksetListResponse":{"id":"components/schemas/WorksetListResponse","kind":"json-schema","title":"WorksetListResponse","data":{"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}},"components/schemas/WorksetOptions":{"id":"components/schemas/WorksetOptions","kind":"json-schema","title":"WorksetOptions","data":{"required":["source"],"type":"object","properties":{"source":{"$ref":"#/components/schemas/WorksetSource"}},"additionalProperties":false}},"components/schemas/JobTypeRequest":{"id":"components/schemas/JobTypeRequest","kind":"json-schema","title":"JobTypeRequest","data":{"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}},"components/schemas/JobTypeResponse":{"id":"components/schemas/JobTypeResponse","kind":"json-schema","title":"JobTypeResponse","data":{"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}},"components/schemas/JobStepMode":{"id":"components/schemas/JobStepMode","kind":"json-schema","title":"JobStepMode","data":{"enum":["Strict","Lenient","Selective"],"type":"string"}},"components/schemas/TaskTypeOptions":{"id":"components/schemas/TaskTypeOptions","kind":"json-schema","title":"TaskTypeOptions","data":{"type":"object","properties":{"canBeStopped":{"type":"boolean"},"canCallback":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/TaskTypeResponse":{"id":"components/schemas/TaskTypeResponse","kind":"json-schema","title":"TaskTypeResponse","data":{"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}},"components/schemas/TaskTypeVariableDefinition":{"id":"components/schemas/TaskTypeVariableDefinition","kind":"json-schema","title":"TaskTypeVariableDefinition","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","nullable":true},"required":{"type":"boolean"},"type":{"$ref":"#/components/schemas/TaskTypeVariableType"}},"additionalProperties":false}},"components/schemas/TaskTypeVariableType":{"id":"components/schemas/TaskTypeVariableType","kind":"json-schema","title":"TaskTypeVariableType","data":{"enum":["String","Number","Integer","Boolean","DateTime","Collection","List"],"type":"string"}},"components/schemas/WorksetRequest":{"id":"components/schemas/WorksetRequest","kind":"json-schema","title":"WorksetRequest","data":{"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}},"components/schemas/WorksetResponse":{"id":"components/schemas/WorksetResponse","kind":"json-schema","title":"WorksetResponse","data":{"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}},"components/schemas/WorksetSource":{"id":"components/schemas/WorksetSource","kind":"json-schema","title":"WorksetSource","data":{"required":["sourceId"],"type":"object","properties":{"sourceId":{"minLength":1,"type":"string"}},"additionalProperties":false}},"components/schemas/WorksetSystemResource":{"id":"components/schemas/WorksetSystemResource","kind":"json-schema","title":"WorksetSystemResource","data":{"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}},"components/schemas/WorksetUpdateRequest":{"id":"components/schemas/WorksetUpdateRequest","kind":"json-schema","title":"WorksetUpdateRequest","data":{"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}},"schema_1585":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1585"},"schema_1586":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_1586"},"schema_1587":{"kind":"json-schema","data":{"pattern":"includeFieldsData","type":"string"},"id":"schema_1587"},"schema_1588":{"kind":"json-schema","data":{"maximum":100,"minimum":1,"type":"integer","format":"int32"},"id":"schema_1588"},"schema_1589":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}},"id":"schema_1589"},"schema_1590":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/JobTypeResponse"}},"id":"schema_1590"},"schema_1591":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TaskTypeResponse"}},"id":"schema_1591"}},"exampleStore":{"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/text~1json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1*+json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items~1{contentItemId}/patch/requestBody/content/application~1*+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example":{"value":{"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":"<p>This is an example of a rich text field. It can include HTML tags for formatting.</p>"},"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json/example":{"value":{"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":"<p>This is an example of a rich text field. It can include HTML tags for formatting.</p>"},"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/text~1json/example":{"value":{"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":"<p>This is an example of a <strong>rich text</strong> field. It can include HTML tags for formatting.</p>"},"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1*+json/example":{"value":{"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":"<p>This is an example of a <strong>rich text</strong> field. It can include HTML tags for formatting.</p>"},"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-items/post/requestBody/content/application~1*+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/text~1json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1*+json/example":{"value":{"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"]}},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/patch/requestBody/content/application~1*+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/text~1json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1*+json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/post/requestBody/content/application~1*+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/text~1json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1*+json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types~1{contentTypeId}/put/requestBody/content/application~1*+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/text~1json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1*+json/example":{"value":{"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},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1content-types/post/requestBody/content/application~1*+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example":{"value":{"id":"en-US","label":"English","default":false},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json-patch+json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json/example":{"value":{"id":"en-US","label":"English","default":false},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/text~1json/example":{"value":{"id":"en-US","label":"English","default":false},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/text~1json/example"},"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1*+json/example":{"value":{"id":"en-US","label":"English","default":false},"id":"paths/~1api~1v2~1cm~1branches~1{branchId}~1locales/post/requestBody/content/application~1*+json/example"}},"securitySchemeStore":{"OAuth2.0":{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"edge-platform.sitecorecloud.io/cs","description":"The base server URL."}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/sai/xm-cloud-content/content-management-api/index.json?download"},{"url":"/_bundle/sai/xm-cloud-content/content-management-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"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 <b>Try it</b> feature, enter this information on the <b>Environments</b> tab, by hovering your mouse over the variable and then clicking <b>Edit</b>.\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 <b>Settings</b> menu is only\nvisible if you have the <i>Admin</i> role.{%\n  /admonition %}\n\nTo create an OAuth client bearer token:\n\n 1. In XM Cloud Content, on the menu bar, click <b>Settings</b>.\n 2. In the left pane, click <b>Content management API</b>.\n 3. On the <b>Content management API</b> page, in the <b>Grant type</b> section, click <b>Client credentials</b>.\n 4. Copy the following credentials and paste them into your development tool, and then execute the <b>Generate token</b> method:\n\n    - <b>Client ID</b> - The client ID for XM Cloud Content.\n    - <b>Client secret</b> - The client secret for the XM Cloud Content.\n    - <b>Audience</b> - The audience for your tenant. This will be in the form `https://api.sitecorecloud.io`.\n    - <b>Authority</b> - The authority for your tenant. This is the POST URL, in the form `https://auth.sitecorecloud.io/oauth/token`.","product":"SitecoreAI Content"}},"baseSlug":"/sai/xm-cloud-content/content-management-api","routesMapping":{}}