{"items":[{"type":"link","label":"Pages API","link":"/sai/pages-api","routeSlug":"/sai/pages-api","content":{"contentType":"overview","meta":{"name":"Pages API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/sai/pages-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/sai/pages-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"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://xmapps-api.sitecorecloud.io","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Pages API (v1)","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 Pages API for managing your site pages in SitecoreAI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API lets you interact with your pages, including:"},"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":"Creating, updating, retrieving, and deleting pages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving versions and variants."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update layouts."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following:"},"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":"All API requests are made in your production environment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/getting-started-with-xm-cloud.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"official SitecoreAI developer documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/sai/pages-api"}],"sectionId":"/sai/pages-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authorization"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authorize your requests, use environment automation client credentials and generate a JSON Web Token (JWT)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: To create client credentials, you must be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/roles.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization Admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or Organization Owner."},"children":[]}]}]}]}],"sectionId":"/sai/pages-api/section/authorization"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorization/create-an-automation-client"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an automation client"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Sitecore Cloud Portal, open SitecoreAI Deploy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation"},"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":"Fill out the automation client details, then click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create"},"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":"Copy the client ID and the client secret because you won't be able to view them again in SitecoreAI Deploy. You'll use them to request a JWT."},"children":[]}]}]}]}]}],"sectionId":"/sai/pages-api/section/authorization/create-an-automation-client"}],"sectionId":"/sai/pages-api/section/authorization/create-an-automation-client"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorization/request-a-jwt"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request a JWT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run the following cURL command to request a JWT. Replace the placeholder values with your client ID and client secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_CLIENT_ID}' \\\n  --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_CLIENT_ID}' \\\n  --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key contains the JWT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  {\n    \"access_token\": \"{YOUR_JWT}\",\n    \"scope\": \"xmcloud.cm:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  {\n    \"access_token\": \"{YOUR_JWT}\",\n    \"scope\": \"xmcloud.cm:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JWT expires in 24 hours. If your requests unexpectedly return a response with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", request a new JWT by repeating this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend that you cache the JWT for 24 hours to avoid repeating this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request while the JWT is still valid."},"children":[]}]}]}]}],"sectionId":"/sai/pages-api/section/authorization/request-a-jwt"}],"sectionId":"/sai/pages-api/section/authorization/request-a-jwt"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorization/include-the-jwt-in-the-request-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the JWT in the request header"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can now start making REST API requests. You must include the JWT in the request header of every request. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET '{YOUR_BASE_URL}/...' \\\n-H 'Authorization: Bearer {YOUR_JWT}' \\\n-H 'Accept: application/json'\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET '{YOUR_BASE_URL}/...' \\\n-H 'Authorization: Bearer {YOUR_JWT}' \\\n-H 'Accept: application/json'\n"},"children":[]}]}]}],"sectionId":"/sai/pages-api/section/authorization/include-the-jwt-in-the-request-header"}],"sectionId":"/sai/pages-api/section/authorization/include-the-jwt-in-the-request-header"}]}]}},{"type":"group","label":"Authorization","link":"/sai/pages-api/section/authorization","routeSlug":"/sai/pages-api/section/authorization","items":[{"type":"link","label":"Create an automation client","link":"/sai/pages-api/section/authorization/create-an-automation-client","routeSlug":"/sai/pages-api/section/authorization/create-an-automation-client","content":null},{"type":"link","label":"Request a JWT","link":"/sai/pages-api/section/authorization/request-a-jwt","routeSlug":"/sai/pages-api/section/authorization/request-a-jwt","content":null},{"type":"link","label":"Include the JWT in the request header","link":"/sai/pages-api/section/authorization/include-the-jwt-in-the-request-header","routeSlug":"/sai/pages-api/section/authorization/include-the-jwt-in-the-request-header","content":null}],"content":null},{"type":"group","label":"Aggregation","link":"/sai/pages-api/aggregation","routeSlug":"/sai/pages-api/aggregation","items":[{"label":"Aggregate personalization variants for multiple pages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/aggregation/aggregatelivepagevariants","routeSlug":"/sai/pages-api/aggregation/aggregatelivepagevariants","metadata":{"seo":{"title":"Aggregate personalization variants for multiple pages","description":"Returns currently active personalization variants for the requested pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AggregateLivePageVariants","name":"Aggregate personalization variants for multiple pages","isWebhook":false,"pointer":"/paths/~1api~1v1~1aggregation~1pages~1live~1variants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregate personalization variants for multiple pages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns currently active personalization variants for the requested pages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1339"},"text/json":{"schemaId":"schema_1339"},"application/*+json":{"schemaId":"schema_1339"}},"schemaId":"schema_1339","pointer":"/paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/requestBody","description":"The collection of pages, by their identifier and language, for which to get personalization variants."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/aggregation/pages/live/variants","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1339"},"text/json":{"schemaId":"schema_1339"},"application/*+json":{"schemaId":"schema_1339"}},"responseCodes":["200","400"],"pointer":"/api/v1/aggregation/pages/live/variants","href":"aggregation/aggregatelivepagevariants","openApiOperationId":"AggregateLivePageVariants","summary":"Aggregate personalization variants for multiple pages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"schema_1339","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1339"},"text/json":{"schemaId":"schema_1339"},"application/*+json":{"schemaId":"schema_1339"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageVariantsAggregationResponse"}},"schemaId":"components/schemas/PageVariantsAggregationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageVariantsAggregationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageVariantsAggregationResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aggregation/aggregatelivepagevariants"}],"panels":[]}]},"httpPath":"/api/v1/aggregation/pages/live/variants"},{"label":"Aggregate page data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/aggregation/aggregatepagedata","routeSlug":"/sai/pages-api/aggregation/aggregatepagedata","metadata":{"seo":{"title":"Aggregate page data","description":"Aggregates data about multiple pages and their components."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AggregatePageData","name":"Aggregate page data","isWebhook":false,"pointer":"/paths/~1api~1v1~1aggregation~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregate page data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Aggregates data about multiple pages and their components."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1339"},"text/json":{"schemaId":"schema_1339"},"application/*+json":{"schemaId":"schema_1339"}},"schemaId":"schema_1339","pointer":"/paths/~1api~1v1~1aggregation~1pages/post/requestBody","description":"The collection of pages, by their identifier and language, for which to get data."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/aggregation/pages","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1339"},"text/json":{"schemaId":"schema_1339"},"application/*+json":{"schemaId":"schema_1339"}},"responseCodes":["200","400"],"pointer":"/api/v1/aggregation/pages","href":"aggregation/aggregatepagedata","openApiOperationId":"AggregatePageData","summary":"Aggregate page data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"schema_1339","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1339"},"text/json":{"schemaId":"schema_1339"},"application/*+json":{"schemaId":"schema_1339"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagesAggregationResponse"}},"schemaId":"components/schemas/PagesAggregationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1aggregation~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagesAggregationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagesAggregationResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1aggregation~1pages/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aggregation/aggregatepagedata"}],"panels":[]}]},"httpPath":"/api/v1/aggregation/pages"}],"content":{"contentType":"group","meta":{"name":"Aggregation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregation","showPageActions":true},{"nodeType":"markdoc","content":"The Aggregation API lets you fetch aggregated page data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/aggregation/pages/live/variants","summary":"Aggregate personalization variants for multiple pages","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aggregation/aggregatelivepagevariants","deprecated":false},{"title":"/api/v1/aggregation/pages","summary":"Aggregate page data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aggregation/aggregatepagedata","deprecated":false}]}]}]}]}},{"type":"group","label":"Pages","link":"/sai/pages-api/pages","routeSlug":"/sai/pages-api/pages","items":[{"label":"Retrieve a page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/retrievepage","routeSlug":"/sai/pages-api/pages/retrievepage","metadata":{"seo":{"title":"Retrieve a page","description":"Fetches information about a page (including statistics, template, layout, publishing and workflow information)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrievePage","name":"Retrieve a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches information about a page (including statistics, template, layout, publishing and workflow information)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"site","in":"query","schemaId":"schema_1340","description":"The site identifier.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"},{"name":"language","in":"query","schemaId":"schema_1340","description":"The page language.","required":true,"example":"en-US"},{"name":"version","in":"query","schemaId":"schema_1341","description":"The page version number.","example":2},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/{pageId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"site","in":"query","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1340"},{"name":"language","in":"query","required":true,"example":"en-US","schemaId":"schema_1340"},{"name":"version","in":"query","example":2,"schemaId":"schema_1341"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}","href":"pages/retrievepage","openApiOperationId":"RetrievePage","summary":"Retrieve a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Page"}},"schemaId":"components/schemas/Page"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Page","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Page"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/retrievepage"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}"},{"label":"Update field values","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/updatefields","routeSlug":"/sai/pages-api/pages/updatefields","metadata":{"seo":{"title":"Update field values","description":"Updates values of existing fields for a specific page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateFields","name":"Update field values","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update field values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates values of existing fields for a specific page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePageInput"},"text/json":{"schemaId":"components/schemas/UpdatePageInput"},"application/*+json":{"schemaId":"components/schemas/UpdatePageInput"}},"schemaId":"components/schemas/UpdatePageInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}/patch/requestBody","description":"Input data containing page field values"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/pages/{pageId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePageInput"},"text/json":{"schemaId":"components/schemas/UpdatePageInput"},"application/*+json":{"schemaId":"components/schemas/UpdatePageInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}","href":"pages/updatefields","openApiOperationId":"UpdateFields","summary":"Update field values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/UpdatePageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePageInput"},"text/json":{"schemaId":"components/schemas/UpdatePageInput"},"application/*+json":{"schemaId":"components/schemas/UpdatePageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}},"schemaId":"components/schemas/PageOperationResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOperationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/updatefields"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}"},{"label":"Delete a page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/deletepage","routeSlug":"/sai/pages-api/pages/deletepage","metadata":{"seo":{"title":"Delete a page","description":"Deletes a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePage","name":"Delete a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeletePageInput"},"text/json":{"schemaId":"components/schemas/DeletePageInput"},"application/*+json":{"schemaId":"components/schemas/DeletePageInput"}},"schemaId":"components/schemas/DeletePageInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/pages/{pageId}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeletePageInput"},"text/json":{"schemaId":"components/schemas/DeletePageInput"},"application/*+json":{"schemaId":"components/schemas/DeletePageInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}","href":"pages/deletepage","openApiOperationId":"DeletePage","summary":"Delete a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/DeletePageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeletePageInput"},"text/json":{"schemaId":"components/schemas/DeletePageInput"},"application/*+json":{"schemaId":"components/schemas/DeletePageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1342"}},"schemaId":"schema_1342"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1342","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1342"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/deletepage"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}"},{"label":"Retrieve a page state","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/retrievepagestate","routeSlug":"/sai/pages-api/pages/retrievepagestate","metadata":{"seo":{"title":"Retrieve a page state","description":"Fetches basic information about a page (identifier, display name and revision) and optionally workflow, layout and version data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrievePageState","name":"Retrieve a page state","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1state/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a page state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches basic information about a page (identifier, display name and revision) and optionally workflow, layout and version data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1state/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Site","in":"query","schemaId":"schema_1343","description":"The site name.","required":true,"example":"my-site"},{"name":"Language","in":"query","schemaId":"schema_1344","description":"The language of the page.","required":true,"example":"en-US"},{"name":"Version","in":"query","schemaId":"schema_1345","description":"The version number of the page.","example":2},{"name":"WithWorkflow","in":"query","schemaId":"schema_1346","description":"Whether to include workflow information.","example":true},{"name":"WithVersions","in":"query","schemaId":"schema_1346","description":"Whether to include page versions.","example":true},{"name":"WithLayout","in":"query","schemaId":"schema_1346","description":"Whether to include layout information.","example":true},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1state/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/{pageId}/state","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"Site","in":"query","required":true,"example":"my-site","schemaId":"schema_1343"},{"name":"Language","in":"query","required":true,"example":"en-US","schemaId":"schema_1344"},{"name":"Version","in":"query","example":2,"schemaId":"schema_1345"},{"name":"WithWorkflow","in":"query","example":true,"schemaId":"schema_1346"},{"name":"WithVersions","in":"query","example":true,"schemaId":"schema_1346"},{"name":"WithLayout","in":"query","example":true,"schemaId":"schema_1346"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/state","href":"pages/retrievepagestate","openApiOperationId":"RetrievePageState","summary":"Retrieve a page state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageState"}},"schemaId":"components/schemas/PageState"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1state/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageState","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageState"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/retrievepagestate"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/state"},{"label":"Search for pages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/search","routeSlug":"/sai/pages-api/pages/search","metadata":{"seo":{"title":"Search for pages","description":"Fetches a list of pages and folders whose name or display name match the search criteria, while applying filters and language options."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Search","name":"Search for pages","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for pages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a list of pages and folders whose name or display name match the search criteria, while applying filters and language options."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchText","in":"query","schemaId":"schema_1347","description":"The text by which to search for the name or display name.","example":"Home"},{"name":"rootIds","in":"query","schemaId":"schema_1348","description":"If you want to limit the search to pages or folders under a specific parent, the list of identifiers to search under.","example":["758852c6488045cca3947d83ff2f56e7","888852c6488045cca3947d83ff2f56e7"]},{"name":"filter","in":"query","schemaId":"schema_1349","description":"The search filter. Possible values are \"Pages\" (items that have a presentation layout and can be rendered), \"Folders\" (items that use 'folder' as their base template), \"All\" (both pages and folders).","example":"\"Pages\""},{"name":"language","in":"query","schemaId":"schema_1350","description":"If you want to limit the search to items in a specific language, the language code of those items.","example":"en"},{"name":"pageSize","in":"query","schemaId":"schema_1351","description":"The page size of the results to return.","example":10},{"name":"pageNumber","in":"query","schemaId":"schema_1352","description":"The page number used to paginate the results.","example":1},{"name":"continuationToken","in":"query","schemaId":"schema_1340","description":"Continuation token for pagination."},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1pages~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/search","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchText","in":"query","example":"Home","schemaId":"schema_1347"},{"name":"rootIds","in":"query","example":["758852c6488045cca3947d83ff2f56e7","888852c6488045cca3947d83ff2f56e7"],"schemaId":"schema_1348"},{"name":"filter","in":"query","example":"\"Pages\"","schemaId":"components/schemas/TypeFilter"},{"name":"language","in":"query","example":"en","schemaId":"schema_1350"},{"name":"pageSize","in":"query","example":10,"schemaId":"schema_1351"},{"name":"pageNumber","in":"query","example":1,"schemaId":"schema_1352"},{"name":"continuationToken","in":"query","schemaId":"schema_1340"},{"name":"environmentId","in":"query","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404","503"],"pointer":"/api/v1/pages/search","href":"pages/search","openApiOperationId":"Search","summary":"Search for pages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagesSearchResult"}},"schemaId":"components/schemas/PagesSearchResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/404/content/application~1json/example"]},{"code":"503","description":"Search service unavailable"}],"pointer":"/paths/~1api~1v1~1pages~1search/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagesSearchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagesSearchResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1search/get/responses/404/content/application~1json/example"]}}},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/search"}],"panels":[]}]},"httpPath":"/api/v1/pages/search"},{"label":"Retrieve insert options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/retrieveinsertoptions","routeSlug":"/sai/pages-api/pages/retrieveinsertoptions","metadata":{"seo":{"title":"Retrieve insert options","description":"Fetches the list of possible templates which are compatible insert options for a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveInsertOptions","name":"Retrieve insert options","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve insert options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the list of possible templates which are compatible insert options for a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"site","in":"query","schemaId":"schema_1340","description":"The site identifier.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"},{"name":"language","in":"query","schemaId":"schema_1340","description":"The page language.","required":true,"example":"en-US"},{"name":"insertOptionKind","in":"query","schemaId":"schema_1340","description":"The type of object to retrieve (Page or Folder).","required":true,"example":"Page"},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/{pageId}/insertoptions","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"site","in":"query","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1340"},{"name":"language","in":"query","required":true,"example":"en-US","schemaId":"schema_1340"},{"name":"insertOptionKind","in":"query","required":true,"example":"Page","schemaId":"schema_1340"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/insertoptions","href":"pages/retrieveinsertoptions","openApiOperationId":"RetrieveInsertOptions","summary":"Retrieve insert options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1353"}},"schemaId":"schema_1353"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1353"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/retrieveinsertoptions"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/insertoptions"},{"label":"Retrieve page versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/retrievepageversions","routeSlug":"/sai/pages-api/pages/retrievepageversions","metadata":{"seo":{"title":"Retrieve page versions","description":"Fetches the list of page versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrievePageVersions","name":"Retrieve page versions","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve page versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the list of page versions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"site","in":"query","schemaId":"schema_1340","description":"The site identifier.","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE"},{"name":"language","in":"query","schemaId":"schema_1340","description":"The page language.","example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/{pageId}/versions","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"site","in":"query","required":true,"example":"3875AC96-8ECF-44AE-8E25-851068B373CE","schemaId":"schema_1340"},{"name":"language","in":"query","example":"en-US","schemaId":"schema_1340"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/versions","href":"pages/retrievepageversions","openApiOperationId":"RetrievePageVersions","summary":"Retrieve page versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1354"}},"schemaId":"schema_1354"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1354","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1354"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/retrievepageversions"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/versions"},{"label":"Add a version to a page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/addpageversions","routeSlug":"/sai/pages-api/pages/addpageversions","metadata":{"seo":{"title":"Add a version to a page","description":"Creates a new version of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPageVersions","name":"Add a version to a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a version to a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new version of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPageVersionInput"},"text/json":{"schemaId":"components/schemas/AddPageVersionInput"},"application/*+json":{"schemaId":"components/schemas/AddPageVersionInput"}},"schemaId":"components/schemas/AddPageVersionInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/post/requestBody","description":"Input data containing properties of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/versions","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddPageVersionInput"},"text/json":{"schemaId":"components/schemas/AddPageVersionInput"},"application/*+json":{"schemaId":"components/schemas/AddPageVersionInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/versions","href":"pages/addpageversions","openApiOperationId":"AddPageVersions","summary":"Add a version to a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/AddPageVersionInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPageVersionInput"},"text/json":{"schemaId":"components/schemas/AddPageVersionInput"},"application/*+json":{"schemaId":"components/schemas/AddPageVersionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1341"}},"schemaId":"schema_1341"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1341"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/addpageversions"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/versions"},{"label":"List live variant identifiers for a page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/listpagevariants","routeSlug":"/sai/pages-api/pages/listpagevariants","metadata":{"seo":{"title":"List live variant identifiers for a page","description":"Fetches the identifiers of currently active personalization variants for a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPageVariants","name":"List live variant identifiers for a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List live variant identifiers for a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the identifiers of currently active personalization variants for a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1340","description":"The page language.","required":true,"example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/{pageId}/live/variants","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"language","in":"query","required":true,"example":"en-US","schemaId":"schema_1340"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/v1/pages/{pageId}/live/variants","href":"pages/listpagevariants","openApiOperationId":"ListPageVariants","summary":"List live variant identifiers for a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1355"}},"schemaId":"schema_1355"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1355","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1355"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/listpagevariants"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/live/variants"},{"label":"Check if a page is published to Edge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/getlivepagestate","routeSlug":"/sai/pages-api/pages/getlivepagestate","metadata":{"seo":{"title":"Check if a page is published to Edge","description":"Checks if the requested page is published to Edge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetLivePageState","name":"Check if a page is published to Edge","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check if a page is published to Edge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Checks if the requested page is published to Edge."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_1340","description":"The page language.","required":true,"example":"en-US"},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pages/{pageId}/live","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"language","in":"query","required":true,"example":"en-US","schemaId":"schema_1340"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/live","href":"pages/getlivepagestate","openApiOperationId":"GetLivePageState","summary":"Check if a page is published to Edge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LivePage"}},"schemaId":"components/schemas/LivePage"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1live/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LivePage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LivePage"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/getlivepagestate"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/live"},{"label":"Create a page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/createpage","routeSlug":"/sai/pages-api/pages/createpage","metadata":{"seo":{"title":"Create a page","description":"Creates a new page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePage","name":"Create a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePageInput"},"text/json":{"schemaId":"components/schemas/CreatePageInput"},"application/*+json":{"schemaId":"components/schemas/CreatePageInput"}},"schemaId":"components/schemas/CreatePageInput","pointer":"/paths/~1api~1v1~1pages/post/requestBody","description":"Input data containing properties of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePageInput"},"text/json":{"schemaId":"components/schemas/CreatePageInput"},"application/*+json":{"schemaId":"components/schemas/CreatePageInput"}},"responseCodes":["200","400"],"pointer":"/api/v1/pages","href":"pages/createpage","openApiOperationId":"CreatePage","summary":"Create a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/CreatePageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePageInput"},"text/json":{"schemaId":"components/schemas/CreatePageInput"},"application/*+json":{"schemaId":"components/schemas/CreatePageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}},"schemaId":"components/schemas/PageOperationResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOperationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/createpage"}],"panels":[]}]},"httpPath":"/api/v1/pages"},{"label":"Create a page from blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/createblueprint","routeSlug":"/sai/pages-api/pages/createblueprint","metadata":{"seo":{"title":"Create a page from blueprint","description":"Creates a new page from an existing blueprint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateBlueprint","name":"Create a page from blueprint","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1blueprint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a page from blueprint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new page from an existing blueprint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1blueprint/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"},"text/json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"},"application/*+json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"}},"schemaId":"components/schemas/CreatePageFromBlueprintInput","pointer":"/paths/~1api~1v1~1pages~1blueprint/post/requestBody","description":"Input data containing properties of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/blueprint","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"},"text/json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"},"application/*+json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"}},"responseCodes":["200","400"],"pointer":"/api/v1/pages/blueprint","href":"pages/createblueprint","openApiOperationId":"CreateBlueprint","summary":"Create a page from blueprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/CreatePageFromBlueprintInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"},"text/json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"},"application/*+json":{"schemaId":"components/schemas/CreatePageFromBlueprintInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1blueprint/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1blueprint/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1blueprint/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1blueprint/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1blueprint/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/createblueprint"}],"panels":[]}]},"httpPath":"/api/v1/pages/blueprint"},{"label":"Save a page layout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/savelayout","routeSlug":"/sai/pages-api/pages/savelayout","metadata":{"seo":{"title":"Save a page layout","description":"Updates the layout of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SaveLayout","name":"Save a page layout","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1layout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a page layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the layout of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1layout/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1layout/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavePageLayoutInput"},"text/json":{"schemaId":"components/schemas/SavePageLayoutInput"},"application/*+json":{"schemaId":"components/schemas/SavePageLayoutInput"}},"schemaId":"components/schemas/SavePageLayoutInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1layout/post/requestBody","description":"Input data containing layout of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/layout","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavePageLayoutInput"},"text/json":{"schemaId":"components/schemas/SavePageLayoutInput"},"application/*+json":{"schemaId":"components/schemas/SavePageLayoutInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/layout","href":"pages/savelayout","openApiOperationId":"SaveLayout","summary":"Save a page layout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/SavePageLayoutInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavePageLayoutInput"},"text/json":{"schemaId":"components/schemas/SavePageLayoutInput"},"application/*+json":{"schemaId":"components/schemas/SavePageLayoutInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavePageResult"}},"schemaId":"components/schemas/SavePageResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavePageResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavePageResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/savelayout"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/layout"},{"label":"Save page fields","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/savefields","routeSlug":"/sai/pages-api/pages/savefields","metadata":{"seo":{"title":"Save page fields","description":"Updates the fields of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SaveFields","name":"Save page fields","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save page fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the fields of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1fields/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment."}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1fields/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavePageFieldsInput"},"text/json":{"schemaId":"components/schemas/SavePageFieldsInput"},"application/*+json":{"schemaId":"components/schemas/SavePageFieldsInput"}},"schemaId":"components/schemas/SavePageFieldsInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1fields/post/requestBody","description":"Input data containing fields of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/fields","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavePageFieldsInput"},"text/json":{"schemaId":"components/schemas/SavePageFieldsInput"},"application/*+json":{"schemaId":"components/schemas/SavePageFieldsInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/fields","href":"pages/savefields","openApiOperationId":"SaveFields","summary":"Save page fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/SavePageFieldsInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavePageFieldsInput"},"text/json":{"schemaId":"components/schemas/SavePageFieldsInput"},"application/*+json":{"schemaId":"components/schemas/SavePageFieldsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavePageResult"}},"schemaId":"components/schemas/SavePageResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavePageResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavePageResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/savefields"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/fields"},{"label":"Duplicate a page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/duplicatepage","routeSlug":"/sai/pages-api/pages/duplicatepage","metadata":{"seo":{"title":"Duplicate a page","description":"Creates a copy of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DuplicatePage","name":"Duplicate a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1duplicate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplicate a page","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 page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DuplicatePageInput"},"text/json":{"schemaId":"components/schemas/DuplicatePageInput"},"application/*+json":{"schemaId":"components/schemas/DuplicatePageInput"}},"schemaId":"components/schemas/DuplicatePageInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/requestBody","description":"Input data containing properties of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/duplicate","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DuplicatePageInput"},"text/json":{"schemaId":"components/schemas/DuplicatePageInput"},"application/*+json":{"schemaId":"components/schemas/DuplicatePageInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/duplicate","href":"pages/duplicatepage","openApiOperationId":"DuplicatePage","summary":"Duplicate a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/DuplicatePageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DuplicatePageInput"},"text/json":{"schemaId":"components/schemas/DuplicatePageInput"},"application/*+json":{"schemaId":"components/schemas/DuplicatePageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}},"schemaId":"components/schemas/PageOperationResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOperationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/duplicatepage"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/duplicate"},{"label":"Rename a page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/renamepage","routeSlug":"/sai/pages-api/pages/renamepage","metadata":{"seo":{"title":"Rename a page","description":"Changes the name of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RenamePage","name":"Rename a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1rename/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes the name of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1rename/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1rename/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenamePageInput"},"text/json":{"schemaId":"components/schemas/RenamePageInput"},"application/*+json":{"schemaId":"components/schemas/RenamePageInput"}},"schemaId":"components/schemas/RenamePageInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1rename/post/requestBody","description":"Input data containing properties of the page"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/rename","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RenamePageInput"},"text/json":{"schemaId":"components/schemas/RenamePageInput"},"application/*+json":{"schemaId":"components/schemas/RenamePageInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/rename","href":"pages/renamepage","openApiOperationId":"RenamePage","summary":"Rename a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/RenamePageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenamePageInput"},"text/json":{"schemaId":"components/schemas/RenamePageInput"},"application/*+json":{"schemaId":"components/schemas/RenamePageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}},"schemaId":"components/schemas/PageOperationResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOperationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOperationResult"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/renamepage"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/rename"},{"label":"Add a page version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/addpageversion","routeSlug":"/sai/pages-api/pages/addpageversion","metadata":{"seo":{"title":"Add a page version","description":"Creates a new version of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPageVersion","name":"Add a page version","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1version/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a page version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new version of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1version/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1version/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPageVersionInput"},"text/json":{"schemaId":"components/schemas/AddPageVersionInput"},"application/*+json":{"schemaId":"components/schemas/AddPageVersionInput"}},"schemaId":"components/schemas/AddPageVersionInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1version/post/requestBody","description":"Input data containing properties of the page for which to create a new version."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/version","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddPageVersionInput"},"text/json":{"schemaId":"components/schemas/AddPageVersionInput"},"application/*+json":{"schemaId":"components/schemas/AddPageVersionInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/version","href":"pages/addpageversion","openApiOperationId":"AddPageVersion","summary":"Add a page version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/AddPageVersionInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPageVersionInput"},"text/json":{"schemaId":"components/schemas/AddPageVersionInput"},"application/*+json":{"schemaId":"components/schemas/AddPageVersionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1341"}},"schemaId":"schema_1341"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1version/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1341"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/addpageversion"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/version"},{"label":"Translate a page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/translatepage","routeSlug":"/sai/pages-api/pages/translatepage","metadata":{"seo":{"title":"Translate a page","description":"Creates a new translated version of a single page using the Stream API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TranslatePage","name":"Translate a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1translate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Translate a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new translated version of a single page using the Stream API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The identifier of the page.","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1translate/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"siteId","in":"query","schemaId":"schema_1340","description":"The site identifier.","example":"872fdee4-23d7-4717-9c0b-4aea5670df7b"},{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1translate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TranslatePageInput"},"text/json":{"schemaId":"components/schemas/TranslatePageInput"},"application/*+json":{"schemaId":"components/schemas/TranslatePageInput"}},"schemaId":"components/schemas/TranslatePageInput","pointer":"/paths/~1api~1v1~1pages~1{pageId}~1translate/post/requestBody","description":"The input model."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pages/{pageId}/translate","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1340"}],"query":[{"name":"siteId","in":"query","example":"872fdee4-23d7-4717-9c0b-4aea5670df7b","schemaId":"schema_1340"},{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TranslatePageInput"},"text/json":{"schemaId":"components/schemas/TranslatePageInput"},"application/*+json":{"schemaId":"components/schemas/TranslatePageInput"}},"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/translate","href":"pages/translatepage","openApiOperationId":"TranslatePage","summary":"Translate a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"schemaId":"components/schemas/TranslatePageInput","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TranslatePageInput"},"text/json":{"schemaId":"components/schemas/TranslatePageInput"},"application/*+json":{"schemaId":"components/schemas/TranslatePageInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1340"}},"schemaId":"schema_1340"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1340"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/translatepage"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/translate"},{"label":"Delete a version of a page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/pages-api/pages/deletepageversions","routeSlug":"/sai/pages-api/pages/deletepageversions","metadata":{"seo":{"title":"Delete a version of a page","description":"Deletes the specified version of a page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePageVersions","name":"Delete a version of a page","isWebhook":false,"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a version of a page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the specified version of a page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_1340","description":"The page identifier.","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},{"name":"versionNumber","in":"path","schemaId":"schema_1341","description":"The number of the version to delete.","required":true,"example":2},{"name":"language","in":"path","schemaId":"schema_1340","description":"The language of the page version to delete.","required":true,"example":"en-US"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"environmentId","in":"query","schemaId":"schema_1340","description":"The identifier of the environment.","example":"main"}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/pages/{pageId}/versions/{versionNumber}/{language}","servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470","schemaId":"schema_1340"},{"name":"versionNumber","in":"path","required":true,"example":2,"schemaId":"schema_1341"},{"name":"language","in":"path","required":true,"example":"en-US","schemaId":"schema_1340"}],"query":[{"name":"environmentId","in":"query","example":"main","schemaId":"schema_1340"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"Bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/api/v1/pages/{pageId}/versions/{versionNumber}/{language}","href":"pages/deletepageversions","openApiOperationId":"DeletePageVersions","summary":"Delete a version of a page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1341"}},"schemaId":"schema_1341"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1341"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/deletepageversions"}],"panels":[]}]},"httpPath":"/api/v1/pages/{pageId}/versions/{versionNumber}/{language}"}],"content":{"contentType":"group","meta":{"name":"Pages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pages","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":"The Pages API lets you create and manage the pages of your sites."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/users/xm-cloud/pages.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/pages/{pageId}","summary":"Retrieve a page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/retrievepage","deprecated":false},{"title":"/api/v1/pages/{pageId}","summary":"Update field values","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pages/updatefields","deprecated":false},{"title":"/api/v1/pages/{pageId}","summary":"Delete a page","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pages/deletepage","deprecated":false},{"title":"/api/v1/pages/{pageId}/state","summary":"Retrieve a page state","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/retrievepagestate","deprecated":false},{"title":"/api/v1/pages/search","summary":"Search for pages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/search","deprecated":false},{"title":"/api/v1/pages/{pageId}/insertoptions","summary":"Retrieve insert options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/retrieveinsertoptions","deprecated":false},{"title":"/api/v1/pages/{pageId}/versions","summary":"Retrieve page versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/retrievepageversions","deprecated":false},{"title":"/api/v1/pages/{pageId}/versions","summary":"Add a version to a page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/addpageversions","deprecated":false},{"title":"/api/v1/pages/{pageId}/live/variants","summary":"List live variant identifiers for a page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/listpagevariants","deprecated":false},{"title":"/api/v1/pages/{pageId}/live","summary":"Check if a page is published to Edge","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/getlivepagestate","deprecated":false},{"title":"/api/v1/pages","summary":"Create a page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/createpage","deprecated":false},{"title":"/api/v1/pages/blueprint","summary":"Create a page from blueprint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/createblueprint","deprecated":false},{"title":"/api/v1/pages/{pageId}/layout","summary":"Save a page layout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/savelayout","deprecated":false},{"title":"/api/v1/pages/{pageId}/fields","summary":"Save page fields","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/savefields","deprecated":false},{"title":"/api/v1/pages/{pageId}/duplicate","summary":"Duplicate a page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/duplicatepage","deprecated":false},{"title":"/api/v1/pages/{pageId}/rename","summary":"Rename a page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/renamepage","deprecated":false},{"title":"/api/v1/pages/{pageId}/version","summary":"Add a page version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/addpageversion","deprecated":false},{"title":"/api/v1/pages/{pageId}/translate","summary":"Translate a page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/translatepage","deprecated":false},{"title":"/api/v1/pages/{pageId}/versions/{versionNumber}/{language}","summary":"Delete a version of a page","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pages/deletepageversions","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ComponentAggregationResponse":{"id":"components/schemas/ComponentAggregationResponse","kind":"json-schema","title":"ComponentAggregationResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The component identifier.\nExample value: 86a03271-dff4-470a-92bd-b68c67de2e25","nullable":true,"example":"86a03271-dff4-470a-92bd-b68c67de2e25"},"uid":{"type":"string","description":"The unique identifier of the component on this page. The UID is assigned to the component when it's added to the page.\nExample value: 3d42bec0-60ad-45f3-a8f7-ddb6a5543c34","nullable":true,"example":"3d42bec0-60ad-45f3-a8f7-ddb6a5543c34"},"name":{"type":"string","description":"The component name.\nExample value: RichText","nullable":true,"example":"RichText"},"displayName":{"type":"string","description":"The display name of the component for the specified language.\nExample value: Rich Text","nullable":true,"example":"Rich Text"}},"additionalProperties":false}},"components/schemas/PageAggregationResponse":{"id":"components/schemas/PageAggregationResponse","kind":"json-schema","title":"PageAggregationResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The page identifier.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"language":{"type":"string","description":"The language of the page.\nExample value: en-US","nullable":true,"example":"en-US"},"name":{"type":"string","description":"The page name.\nExample value: Home","nullable":true,"example":"Home"},"displayName":{"type":"string","description":"The display name of the page for the specified language.\nExample value: Home","nullable":true,"example":"Home"},"components":{"type":"array","items":{"$ref":"#/components/schemas/ComponentAggregationResponse"},"description":"A collection of the page components.","nullable":true}},"additionalProperties":false}},"components/schemas/PageRequest":{"id":"components/schemas/PageRequest","kind":"json-schema","title":"PageRequest","data":{"required":["id","language"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"The page identifier.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"language":{"minLength":1,"type":"string","description":"The language of the page.\nExample value: en-US","example":"en-US"}},"additionalProperties":false}},"components/schemas/PageVariantsAggregationResponse":{"id":"components/schemas/PageVariantsAggregationResponse","kind":"json-schema","title":"PageVariantsAggregationResponse","data":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/PageVariantsResponse"},"description":"Aggregated data of the currently active variants for this page.","nullable":true}},"additionalProperties":false}},"components/schemas/PageVariantsResponse":{"id":"components/schemas/PageVariantsResponse","kind":"json-schema","title":"PageVariantsResponse","data":{"type":"object","properties":{"pageId":{"type":"string","description":"The page identifier.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"language":{"type":"string","description":"The language of the page.\nExample value: en-US","nullable":true,"example":"en-US"},"variantIds":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of page personalization variant identifiers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"edc7cee9-14b5-4218-a7a8-13664c714bdb\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"5f457136-fd9f-4a5b-be3f-2d46709f01a4\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["edc7cee9-14b5-4218-a7a8-13664c714bdb","5f457136-fd9f-4a5b-be3f-2d46709f01a4"]}},"additionalProperties":false}},"components/schemas/PagesAggregationResponse":{"id":"components/schemas/PagesAggregationResponse","kind":"json-schema","title":"PagesAggregationResponse","data":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/PageAggregationResponse"},"nullable":true}},"additionalProperties":false}},"components/schemas/AddPageVersionInput":{"id":"components/schemas/AddPageVersionInput","kind":"json-schema","title":"AddPageVersionInput","data":{"type":"object","properties":{"language":{"type":"string","description":"The language of the new page version.\nExample value: en-US","nullable":true,"example":"en-US"},"site":{"type":"string","description":"The site name.\nExample value: my-site","nullable":true,"example":"my-site"},"baseVersion":{"type":"integer","description":"The base version number to create the new version from.\nExample value: 1","format":"int32","nullable":true,"example":1},"versionName":{"type":"string","description":"The name of the new version.\nExample value: Black Friday content update","nullable":true,"example":"Black Friday content update"}},"additionalProperties":false}},"components/schemas/CreatePageFromBlueprintInput":{"id":"components/schemas/CreatePageFromBlueprintInput","kind":"json-schema","title":"CreatePageFromBlueprintInput","data":{"required":["blueprintId","language","pageName","parentId"],"type":"object","properties":{"parentId":{"minLength":1,"type":"string","description":"The identifier of the parent page.\nExample value: 9100b830-c85b-459b-9c37-51da74fc9ecc","example":"9100b830-c85b-459b-9c37-51da74fc9ecc"},"pageName":{"minLength":1,"type":"string","description":"The system name of the new page.\nExample value: about-us","example":"about-us"},"blueprintId":{"minLength":1,"type":"string","description":"The identifier of the blueprint to be used for the new page.\nExample value: 2341ef32-42f4-4537-98d8-9ef741008eab","example":"2341ef32-42f4-4537-98d8-9ef741008eab"},"language":{"minLength":1,"type":"string","description":"The language of the new page.\nExample value: en-US","example":"en-US"},"displayName":{"type":"string","description":"The display name of the new page.\nExample value: About Us","nullable":true,"example":"About Us"}},"additionalProperties":false}},"components/schemas/CreatePageInput":{"id":"components/schemas/CreatePageInput","kind":"json-schema","title":"CreatePageInput","data":{"required":["language","pageName","parentId","templateId"],"type":"object","properties":{"parentId":{"minLength":1,"type":"string","description":"The identifier of the parent page.\nExample value: 9100b830-c85b-459b-9c37-51da74fc9ecc","example":"9100b830-c85b-459b-9c37-51da74fc9ecc"},"pageName":{"minLength":1,"type":"string","description":"The system name of the new page.\nExample value: about-us","example":"about-us"},"templateId":{"minLength":1,"type":"string","description":"The identifier of the template to be used for the new page.\nExample value: 2341ef32-42f4-4537-98d8-9ef741008eab","example":"2341ef32-42f4-4537-98d8-9ef741008eab"},"language":{"minLength":1,"type":"string","description":"The language of the new page.\nExample value: en-US","example":"en-US"},"displayName":{"type":"string","description":"The display name of the new page.\nExample value: About Us","nullable":true,"example":"About Us"}},"additionalProperties":false}},"components/schemas/DeletePageInput":{"id":"components/schemas/DeletePageInput","kind":"json-schema","title":"DeletePageInput","data":{"type":"object","properties":{"permanently":{"type":"boolean","description":"Whether the page should be permanently deleted (skipping the recycle bin).\nExample value: True","example":true},"forceDelete":{"type":"boolean","description":"Whether the page should be forcefully deleted (skipping the references check).\nExample value: True","example":true}},"additionalProperties":false}},"components/schemas/DuplicatePageInput":{"id":"components/schemas/DuplicatePageInput","kind":"json-schema","title":"DuplicatePageInput","data":{"required":["language","newName","site"],"type":"object","properties":{"newName":{"minLength":1,"type":"string","description":"The name for the new page.\nExample value: About Us Copy","example":"About Us Copy"},"site":{"minLength":1,"type":"string","description":"The site name.\nExample value: my-site","example":"my-site"},"language":{"minLength":1,"type":"string","description":"The language of the duplicated page.\nExample value: en-US","example":"en-US"},"displayName":{"type":"string","description":"The display name for the new page.\nExample value: About Us Copy","nullable":true,"example":"About Us Copy"}},"additionalProperties":false}},"components/schemas/JobResponse":{"id":"components/schemas/JobResponse","kind":"json-schema","title":"JobResponse","data":{"type":"object","properties":{"handle":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/LayoutKind":{"id":"components/schemas/LayoutKind","kind":"json-schema","title":"LayoutKind","data":{"enum":["Final","Shared"],"type":"string","description":"The type of layout (Final or Shared)."}},"components/schemas/LivePage":{"id":"components/schemas/LivePage","kind":"json-schema","title":"LivePage","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the page.\nExample value: 110d559f-dea5-42ea-9c1c-8a5df7e70ef9","nullable":true,"example":"110d559f-dea5-42ea-9c1c-8a5df7e70ef9"},"name":{"type":"string","description":"The name of the page.\nExample value: Home","nullable":true,"example":"Home"},"displayName":{"type":"string","description":"The display name of the page.\nExample value: Home Page","nullable":true,"example":"Home Page"},"path":{"type":"string","description":"The path of the page.\nExample value: /home","nullable":true,"example":"/home"},"language":{"type":"string","description":"The language of the page.\nExample value: en-US","nullable":true,"example":"en-US"},"version":{"type":"integer","description":"The version number of the page.\nExample value: 1","format":"int32","example":1},"personalization":{"$ref":"#/components/schemas/Personalization"},"url":{"$ref":"#/components/schemas/Url"}},"additionalProperties":false,"description":"Represents a published page."}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","properties":{"url":{"type":"string","description":"The page URL path.\nExample value: /about","nullable":true,"example":"/about"},"icon":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path to the icon associated with the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: Applications/32x32/document_heart.png"},"children":[]}]}]}],"nullable":true,"example":"Applications/32x32/document_heart.png"},"versionName":{"type":"string","description":"The name of the page version.\nExample value: Black Friday content update","nullable":true,"example":"Black Friday content update"},"revision":{"type":"string","description":"The revision of the page.\nExample value: f7d29433-001e-4a35-a744-876759dba468","nullable":true,"example":"f7d29433-001e-4a35-a744-876759dba468"},"createdAt":{"type":"string","description":"The date the page was created.\nExample value: 2025-01-27T10:33:33Z","nullable":true,"example":"2025-01-27T10:33:33Z"},"updatedAt":{"type":"string","description":"The date the page was last updated.\nExample value: 2025-01-27T10:39:02Z","nullable":true,"example":"2025-01-27T10:39:02Z"},"createdBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user who created the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: john.doe@sitecore.com"},"children":[]}]}]}],"nullable":true,"example":"john.doe@sitecore.com"},"updatedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user who last updated the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: john.doe@sitecore.com"},"children":[]}]}]}],"nullable":true,"example":"john.doe@sitecore.com"},"template":{"$ref":"#/components/schemas/PageTemplate"},"workflow":{"$ref":"#/components/schemas/PageWorkflow"},"publishing":{"$ref":"#/components/schemas/Publishing"},"finalLayout":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final layout of the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"devices\":[{\"id\":\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\",\"layoutId\":\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\",\"placeholders\":[],\"renderings\":[{\"id\":\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\",\"instanceId\":\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\",\"placeholderKey\":\"headless-main\",\"dataSource\":\"local:/Data/Text 1\",\"parameters\":{\"GridParameters\":\"{7465D855-992E-4DC2-9855-A03250DFA74B}\",\"FieldNames\":\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\",\"Styles\":\"\",\"RenderingIdentifier\":\"\",\"CSSStyles\":\"\",\"DynamicPlaceholderId\":\"1\"}}]}]}"},"children":[]}]}]}],"nullable":true,"example":"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[{\\\"id\\\":\\\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\\\",\\\"instanceId\\\":\\\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\\\",\\\"placeholderKey\\\":\\\"headless-main\\\",\\\"dataSource\\\":\\\"local:/Data/Text 1\\\",\\\"parameters\\\":{\\\"GridParameters\\\":\\\"{7465D855-992E-4DC2-9855-A03250DFA74B}\\\",\\\"FieldNames\\\":\\\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\\\",\\\"Styles\\\":\\\"\\\",\\\"RenderingIdentifier\\\":\\\"\\\",\\\"CSSStyles\\\":\\\"\\\",\\\"DynamicPlaceholderId\\\":\\\"1\\\"}}]}]}"},"sharedLayout":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shared layout of the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"devices\":[{\"id\":\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\",\"layoutId\":\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\",\"placeholders\":[],\"renderings\":[]}]}"},"children":[]}]}]}],"nullable":true,"example":"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[]}]}"},"layoutEditingKind":{"type":"string","description":"The type of layout for editing (Shared of Final).\nExample value: Final","nullable":true,"example":"Final"},"id":{"type":"string","description":"The page identifier.\nExample value: 68900348a3b84eb8ac7df4d179c25727","nullable":true,"example":"68900348a3b84eb8ac7df4d179c25727"},"name":{"type":"string","description":"The page's system name.\nExample value: Home","nullable":true,"example":"Home"},"displayName":{"type":"string","description":"The page's display name.\nExample value: Site Home","nullable":true,"example":"Site Home"},"language":{"type":"string","description":"The page language.\nExample value: en-US","nullable":true,"example":"en-US"},"version":{"type":"integer","description":"The current version of the page.\nExample value: 1","format":"int32","example":1},"templateId":{"type":"string","description":"The identifier of the template this page is based on.\nExample value: 6fe7d6551e3d4c2780105777f06c6c4f","nullable":true,"example":"6fe7d6551e3d4c2780105777f06c6c4f"},"parentId":{"type":"string","description":"The identifier of the page's parent.\nExample value: 4bc0c81a280b4b13890b7b074b9d68f4","nullable":true,"example":"4bc0c81a280b4b13890b7b074b9d68f4"},"hasPresentation":{"type":"boolean","description":"If set to true, this page can be rendered in the XM Cloud Pages application. This value is automatically set to false for the root item of the site, as well as for the folders if there are any.\nExample value: True","example":true},"hasChildren":{"type":"boolean","description":"Whether the page has any child pages.\nExample value: True","example":true},"isLatestPublishableVersion":{"type":"boolean","description":"Whether the page version is latest publishable version\nExample value: True","example":true},"permissions":{"$ref":"#/components/schemas/Permissions"},"locking":{"$ref":"#/components/schemas/PageLocking"},"path":{"type":"string","description":"The path for the page.\nExample value: Sitecore/Content/Home/Categories/Products/MyProduct","nullable":true,"example":"Sitecore/Content/Home/Categories/Products/MyProduct"},"route":{"type":"string","description":"The public-facing URL path relative to the site's root.\nExample value: /Aboutus","nullable":true,"example":"/Aboutus"}},"additionalProperties":false}},"components/schemas/PageField":{"id":"components/schemas/PageField","kind":"json-schema","title":"PageField","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field.\nExample value: Title","nullable":true,"example":"Title"},"value":{"type":"string","description":"The raw value of the field. While this is passed as a string, it can represent more complex values.\nExample value: Welcome to our site","nullable":true,"example":"Welcome to our site"}},"additionalProperties":false}},"components/schemas/PageFieldValue":{"id":"components/schemas/PageFieldValue","kind":"json-schema","title":"PageFieldValue","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the field.\nExample value: field-id-123","nullable":true,"example":"field-id-123"},"value":{"type":"string","description":"The current value of the field.\nExample value: Hello World","nullable":true,"example":"Hello World"},"originalValue":{"type":"string","description":"The original value of the field before any changes, useful for comparison or rollback scenarios.\nExample value: Original Text","nullable":true,"example":"Original Text"},"reset":{"type":"boolean","description":"Whether the field value should be reset to its default state.\nExample value: False","example":false}},"additionalProperties":false}},"components/schemas/PageFieldValueResult":{"id":"components/schemas/PageFieldValueResult","kind":"json-schema","title":"PageFieldValueResult","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the field.\nExample value: a73d057e-20e3-4ac3-9c06-5f34bfcb6847","nullable":true,"example":"a73d057e-20e3-4ac3-9c06-5f34bfcb6847"},"value":{"type":"string","description":"The new value of the field.\nExample value: Welcome to our site","nullable":true,"example":"Welcome to our site"},"originalValue":{"type":"string","description":"The original value of the field.\nExample value: Welcome","nullable":true,"example":"Welcome"},"reset":{"type":"boolean","description":"The field reset status.\nExample value: False","example":false}},"additionalProperties":false}},"components/schemas/PageInsertOption":{"id":"components/schemas/PageInsertOption","kind":"json-schema","title":"PageInsertOption","data":{"type":"object","properties":{"id":{"type":"string","description":"Template ID\nExample value: 6fe7d655-1e3d-4c27-8010-5777f06c6c4f","nullable":true,"example":"6fe7d655-1e3d-4c27-8010-5777f06c6c4f"},"displayName":{"type":"string","description":"Template display name\nExample value: Page","nullable":true,"example":"Page"},"templateType":{"$ref":"#/components/schemas/TemplateType"}},"additionalProperties":false}},"components/schemas/PageLayout":{"id":"components/schemas/PageLayout","kind":"json-schema","title":"PageLayout","data":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/LayoutKind"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the layout."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"devices\":[{\"id\":\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\",\"layoutId\":\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\",\"placeholders\":[],\"renderings\":[{\"id\":\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\",\"instanceId\":\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\",\"placeholderKey\":\"headless-main\",\"dataSource\":\"local:/Data/Text 1\",\"parameters\":{\"GridParameters\":\"{7465D855-992E-4DC2-9855-A03250DFA74B}\",\"FieldNames\":\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\",\"Styles\":\"\",\"RenderingIdentifier\":\"\",\"CSSStyles\":\"\",\"DynamicPlaceholderId\":\"1\"}}]}]}"},"children":[]}]}]}],"nullable":true,"example":"{\"devices\":[{\"id\":\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\",\"layoutId\":\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\",\"placeholders\":[],\"renderings\":[{\"id\":\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\",\"instanceId\":\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\",\"placeholderKey\":\"headless-main\",\"dataSource\":\"local:/Data/Text 1\",\"parameters\":{\"GridParameters\":\"{7465D855-992E-4DC2-9855-A03250DFA74B}\",\"FieldNames\":\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\",\"Styles\":\"\",\"RenderingIdentifier\":\"\",\"CSSStyles\":\"\",\"DynamicPlaceholderId\":\"1\"}}]}]}"}},"additionalProperties":false}},"components/schemas/PageLocking":{"id":"components/schemas/PageLocking","kind":"json-schema","title":"PageLocking","data":{"type":"object","properties":{"canUnlock":{"type":"boolean","description":"Whether the current user can unlock the page for editing.\nExample value: False","example":false},"isLocked":{"type":"boolean","description":"Whether the page is currently locked for editing.\nExample value: False","example":false},"lockedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the page is locked, the user who locked it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: john.smith@skate-park.com"},"children":[]}]}]}],"nullable":true,"example":"john.smith@skate-park.com"},"lockedByCurrentUser":{"type":"boolean","description":"Whether the page was locked by the current user.\nExample value: False","example":false}},"additionalProperties":false}},"components/schemas/PageOperationResult":{"id":"components/schemas/PageOperationResult","kind":"json-schema","title":"PageOperationResult","data":{"type":"object","properties":{"pageId":{"type":"string","description":"The page identifier.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"name":{"type":"string","description":"The system name of the page.\nExample value: Home","nullable":true,"example":"Home"},"displayName":{"type":"string","description":"The display name of the page.\nExample value: Site Home","nullable":true,"example":"Site Home"},"path":{"type":"string","description":"The path of the page.\nExample value: /sitecore/content/collection01/site01/Home/about","nullable":true,"example":"/sitecore/content/collection01/site01/Home/about"}},"additionalProperties":false}},"components/schemas/PageState":{"id":"components/schemas/PageState","kind":"json-schema","title":"PageState","data":{"type":"object","properties":{"id":{"type":"string","description":"The page identifier.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"displayName":{"type":"string","description":"The display name of the page.\nExample value: Site Home","nullable":true,"example":"Site Home"},"revision":{"type":"string","description":"The revision of the page.\nExample value: f7d29433-001e-4a35-a744-876759dba468","nullable":true,"example":"f7d29433-001e-4a35-a744-876759dba468"},"workflow":{"$ref":"#/components/schemas/PageWorkflow"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/Page"},"description":"The versions of the page.","nullable":true},"finalLayout":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final layout of the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"devices\":[{\"id\":\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\",\"layoutId\":\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\",\"placeholders\":[],\"renderings\":[{\"id\":\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\",\"instanceId\":\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\",\"placeholderKey\":\"headless-main\",\"dataSource\":\"local:/Data/Text 1\",\"parameters\":{\"GridParameters\":\"{7465D855-992E-4DC2-9855-A03250DFA74B}\",\"FieldNames\":\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\",\"Styles\":\"\",\"RenderingIdentifier\":\"\",\"CSSStyles\":\"\",\"DynamicPlaceholderId\":\"1\"}}]}]}"},"children":[]}]}]}],"nullable":true,"example":"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[{\\\"id\\\":\\\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\\\",\\\"instanceId\\\":\\\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\\\",\\\"placeholderKey\\\":\\\"headless-main\\\",\\\"dataSource\\\":\\\"local:/Data/Text 1\\\",\\\"parameters\\\":{\\\"GridParameters\\\":\\\"{7465D855-992E-4DC2-9855-A03250DFA74B}\\\",\\\"FieldNames\\\":\\\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\\\",\\\"Styles\\\":\\\"\\\",\\\"RenderingIdentifier\\\":\\\"\\\",\\\"CSSStyles\\\":\\\"\\\",\\\"DynamicPlaceholderId\\\":\\\"1\\\"}}]}]}"},"sharedLayout":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shared layout of the page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: {\"devices\":[{\"id\":\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\",\"layoutId\":\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\",\"placeholders\":[],\"renderings\":[]}]}"},"children":[]}]}]}],"nullable":true,"example":"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[]}]}"},"layoutEditingKind":{"type":"string","description":"The kind of layout for editing (Shared of Final).\nExample value: Final","nullable":true,"example":"Final"}},"additionalProperties":false}},"components/schemas/PageTemplate":{"id":"components/schemas/PageTemplate","kind":"json-schema","title":"PageTemplate","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the page template.\nExample value: 2341ef32-42f4-4537-98d8-9ef741008eab","nullable":true,"example":"2341ef32-42f4-4537-98d8-9ef741008eab"},"name":{"type":"string","description":"The name of the page template.\nExample value: MainPage","nullable":true,"example":"MainPage"},"path":{"type":"string","description":"The path of the page template.\nExample value: /sitecore/templates/Standard Template","nullable":true,"example":"/sitecore/templates/Standard Template"},"baseTemplateIds":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifiers of the base templates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"4cf51e95-ee7e-4ad6-a69f-e4d740b03616\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"d9584f11-07d3-4cda-8373-7f97ceedbc09\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["4cf51e95-ee7e-4ad6-a69f-e4d740b03616","d9584f11-07d3-4cda-8373-7f97ceedbc09"]},"displayName":{"type":"string","description":"The display name of the page template.\nExample value: Main Page","nullable":true,"example":"Main Page"},"isBranchTemplate":{"type":"boolean","description":"Whether the template is a branch template.\nExample value: True","example":true}},"additionalProperties":false}},"components/schemas/PageValidationError":{"id":"components/schemas/PageValidationError","kind":"json-schema","title":"PageValidationError","data":{"type":"object","properties":{"aborted":{"type":"string","description":"Whether the operation was aborted.\nExample value: true","nullable":true,"example":"true"},"errorLevel":{"type":"string","description":"The level of the error.\nExample value: High","nullable":true,"example":"High"},"errorMessage":{"type":"string","description":"The error message.\nExample value: Field value is required.","nullable":true,"example":"Field value is required."},"fieldId":{"type":"string","description":"The identifier of the field that caused the error.\nExample value: a73d057e-20e3-4ac3-9c06-5f34bfcb6847","nullable":true,"example":"a73d057e-20e3-4ac3-9c06-5f34bfcb6847"}},"additionalProperties":false}},"components/schemas/PageVersionInfo":{"id":"components/schemas/PageVersionInfo","kind":"json-schema","title":"PageVersionInfo","data":{"type":"object","properties":{"pageId":{"type":"string","description":"The identifier of the page.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"displayName":{"type":"string","description":"The display name of the page.\nExample value: Site Home","nullable":true,"example":"Site Home"},"versionNumber":{"type":"integer","description":"The version number of the page.\nExample value: 2","format":"int32","example":2}},"additionalProperties":false}},"components/schemas/PageWorkflow":{"id":"components/schemas/PageWorkflow","kind":"json-schema","title":"PageWorkflow","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the workflow state.\nExample value: 77ac7ce9-803a-42e3-bb05-f79fca73cbce","nullable":true,"example":"77ac7ce9-803a-42e3-bb05-f79fca73cbce"},"displayName":{"type":"string","description":"The display name of the workflow.\nExample value: Page Workflow","nullable":true,"example":"Page Workflow"},"finalState":{"type":"boolean","description":"Whether the page is in the final workflow state.\nExample value: True","example":true},"canEdit":{"type":"boolean","description":"Whether the page can be edited.\nExample value: True","example":true},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowWarning"},"description":"The list of warnings associated with the workflow.","nullable":true},"icon":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path to the icon associated with the workflow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: Applications/32x32/document_heart.png"},"children":[]}]}]}],"nullable":true,"example":"Applications/32x32/document_heart.png"},"commands":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowCommand"},"description":"The list of commands available in the current workflow state.","nullable":true}},"additionalProperties":false}},"components/schemas/PagesSearchResult":{"id":"components/schemas/PagesSearchResult","kind":"json-schema","title":"PagesSearchResult","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of pages found by the search.\nExample value: 25","format":"int32","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Page"},"description":"The collection of result pages returned by the search.","nullable":true}},"additionalProperties":false,"description":"The result of a page search, including the total count and a collection of result pages."}},"components/schemas/Permissions":{"id":"components/schemas/Permissions","kind":"json-schema","title":"Permissions","data":{"type":"object","properties":{"canAdmin":{"type":"boolean","description":"Whether the current user has admin rights. Being an admin means that you control access permissions for other users, and have full read and write rights.\nExample value: False","example":false},"canWrite":{"type":"boolean","description":"Whether the current user has permissions to edit values. Users with write access also have read access.\nExample value: False","example":false},"canCreate":{"type":"boolean","description":"Whether the current user has permission to create entities.\nExample value: False","example":false},"canDelete":{"type":"boolean","description":"Whether the current user has permission to delete entities.\nExample value: False","example":false},"canRename":{"type":"boolean","description":"Whether the current user has permission to rename entities.\nExample value: False","example":false},"canRead":{"type":"boolean","description":"Whether the current user has permission to see entities, including all their parameters.\nExample value: False","example":false},"canPublish":{"type":"boolean","description":"Whether the current user has permission to publish sites in this environment.\nExample value: False","example":false},"canDuplicate":{"type":"boolean","description":"Whether the current user has permission to duplicate entities.\nExample value: False","example":false},"canWriteLanguage":{"type":"boolean","description":"Whether the current user has permission to write item language entities.\nExample value: False","example":false}},"additionalProperties":false,"description":"The access rights of the current user to the site."}},"components/schemas/Personalization":{"id":"components/schemas/Personalization","kind":"json-schema","title":"Personalization","data":{"type":"object","properties":{"variantIds":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The collection of page variant identifiers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example value: ["},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"4cf51e95-ee7e-4ad6-a69f-e4d740b03616\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"d9584f11-07d3-4cda-8373-7f97ceedbc09\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"nullable":true,"example":["4cf51e95-ee7e-4ad6-a69f-e4d740b03616","d9584f11-07d3-4cda-8373-7f97ceedbc09"]}},"additionalProperties":false,"description":"Represents personalization settings for a page."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"type":{"type":"string","description":"The type of the error response entity.","nullable":true},"title":{"type":"string","description":"The title of the error response entity.","nullable":true},"status":{"type":"integer","description":"The response status code.","format":"int32","nullable":true},"detail":{"type":"string","description":"A detailed explanation, specific to this occurrence of the problem.","nullable":true},"instance":{"type":"string","description":"If available, a URI reference that identifies the specific occurrence of the problem.","nullable":true}},"additionalProperties":{"description":"Any additional optional properties that describe the error(s)."}}},"components/schemas/Publishing":{"id":"components/schemas/Publishing","kind":"json-schema","title":"Publishing","data":{"type":"object","properties":{"isPublishable":{"type":"boolean","description":"Whether the page is publishable.\nExample value: True","example":true},"hasPublishableVersion":{"type":"boolean","description":"Whether the page has a publishable version.\nExample value: True","example":true},"isAvailableToPublish":{"type":"boolean","description":"Whether the page version is available to publish (version is not hidden).\nExample value: True","example":true},"validFromDate":{"type":"string","description":"The date from which the page is available for publishing.\nExample value: 2023-10-01T00:00:00Z","nullable":true,"example":"2023-10-01T00:00:00Z"},"validToDate":{"type":"string","description":"The date until which the page is available for publishing.\nExample value: 2023-12-31T23:59:59Z","nullable":true,"example":"2023-12-31T23:59:59Z"}},"additionalProperties":false}},"components/schemas/RenamePageInput":{"id":"components/schemas/RenamePageInput","kind":"json-schema","title":"RenamePageInput","data":{"required":["newName"],"type":"object","properties":{"newName":{"minLength":1,"type":"string","description":"The new name for the page.\nExample value: About Us","example":"About Us"}},"additionalProperties":false}},"components/schemas/SavePageError":{"id":"components/schemas/SavePageError","kind":"json-schema","title":"SavePageError","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"The error code.\nExample value: ItemIsProtected","nullable":true,"example":"ItemIsProtected"},"message":{"type":"string","description":"The error message.\nExample value: The page item is protected.","nullable":true,"example":"The page item is protected."},"pageId":{"type":"string","description":"The identifier of the page that caused the error.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"}},"additionalProperties":false}},"components/schemas/SavePageFieldsInput":{"id":"components/schemas/SavePageFieldsInput","kind":"json-schema","title":"SavePageFieldsInput","data":{"required":["fields","language","site"],"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/PageFieldValue"},"description":"The field values for the page."},"language":{"minLength":1,"type":"string","description":"The language of the page to save.\nExample value: en-US","example":"en-US"},"site":{"minLength":1,"type":"string","description":"The site name.\nExample value: my-site","example":"my-site"},"pageVersion":{"type":"integer","description":"The version number of the page to save.\nExample value: 2","format":"int32","example":2},"revision":{"type":"string","description":"The revision identifier of the page to save.\nExample value: f7d29433-001e-4a35-a744-876759dba468","nullable":true,"example":"f7d29433-001e-4a35-a744-876759dba468"}},"additionalProperties":false}},"components/schemas/SavePageLayoutInput":{"id":"components/schemas/SavePageLayoutInput","kind":"json-schema","title":"SavePageLayoutInput","data":{"required":["language","layout","site"],"type":"object","properties":{"layout":{"$ref":"#/components/schemas/PageLayout"},"originalLayout":{"$ref":"#/components/schemas/PageLayout"},"language":{"minLength":1,"type":"string","description":"The language of the page to save.\nExample value: en-US","example":"en-US"},"site":{"minLength":1,"type":"string","description":"The site name.\nExample value: my-site","example":"my-site"},"pageVersion":{"type":"integer","description":"The version number of the page to save.\nExample value: 2","format":"int32","example":2},"revision":{"type":"string","description":"The revision identifier of the page to save.\nExample value: f7d29433-001e-4a35-a744-876759dba468","nullable":true,"example":"f7d29433-001e-4a35-a744-876759dba468"}},"additionalProperties":false}},"components/schemas/SavePageResult":{"id":"components/schemas/SavePageResult","kind":"json-schema","title":"SavePageResult","data":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/SavePageError"},"description":"The list of errors that occurred during the save operation.","nullable":true},"savedPage":{"$ref":"#/components/schemas/SavedPage"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/PageValidationError"},"description":"The list of validation errors that occurred during the save operation.","nullable":true},"warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings that occurred during the save operation.","nullable":true},"newCreatedVersion":{"$ref":"#/components/schemas/PageVersionInfo"}},"additionalProperties":false}},"components/schemas/SavedPage":{"id":"components/schemas/SavedPage","kind":"json-schema","title":"SavedPage","data":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/PageFieldValueResult"},"description":"The list of updated field values.","nullable":true},"id":{"type":"string","description":"The identifier of the saved page.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"language":{"type":"string","description":"The language of the saved page.\nExample value: en-US","nullable":true,"example":"en-US"},"revision":{"type":"string","description":"The revision identifier of the saved page.\nExample value: f7d29433-001e-4a35-a744-876759dba468","nullable":true,"example":"f7d29433-001e-4a35-a744-876759dba468"},"version":{"type":"integer","description":"The version number of the saved page.\nExample value: 2","format":"int32","example":2}},"additionalProperties":false}},"components/schemas/TemplateType":{"id":"components/schemas/TemplateType","kind":"json-schema","title":"TemplateType","data":{"enum":["ItemTemplate","BranchTemplate"],"type":"string","description":"The type of template."}},"components/schemas/TranslatePageInput":{"id":"components/schemas/TranslatePageInput","kind":"json-schema","title":"TranslatePageInput","data":{"required":["sourceLanguage","targetLanguage","translationStrategy"],"type":"object","properties":{"sourceLanguage":{"minLength":1,"type":"string","description":"Source language\nExample value: en","example":"en"},"targetLanguage":{"minLength":1,"type":"string","description":"Target language\nExample value: ja-JP","example":"ja-JP"},"translationStrategy":{"$ref":"#/components/schemas/TranslationStrategy"}},"additionalProperties":false,"description":"The translations options"}},"components/schemas/TranslationStrategy":{"id":"components/schemas/TranslationStrategy","kind":"json-schema","title":"TranslationStrategy","data":{"enum":["AddVersion","SkipIfExists"],"type":"string","description":"Specifies the strategy to use when translating: add a new version or skip if a version exists.","format":"int32"}},"components/schemas/TypeFilter":{"id":"components/schemas/TypeFilter","kind":"json-schema","title":"TypeFilter","data":{"enum":["Pages","Folders","All"],"type":"string","description":"The search filter type.","format":"int32"}},"components/schemas/UpdatePageInput":{"id":"components/schemas/UpdatePageInput","kind":"json-schema","title":"UpdatePageInput","data":{"required":["fields"],"type":"object","properties":{"versionNumber":{"type":"integer","description":"The version number of the page to update.\nExample value: 2","format":"int32","nullable":true,"example":2},"language":{"type":"string","description":"The language of the page to update.\nExample value: en-US","nullable":true,"example":"en-US"},"fields":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PageField"},"description":"The fields to update on the page."}},"additionalProperties":false}},"components/schemas/Url":{"id":"components/schemas/Url","kind":"json-schema","title":"Url","data":{"type":"object","properties":{"hostName":{"type":"string","description":"The host name of the URL.\nExample value: www.skate-park.com","nullable":true,"example":"www.skate-park.com"},"path":{"type":"string","description":"The path component of the URL.\nExample value: /products/item1","nullable":true,"example":"/products/item1"},"scheme":{"type":"string","description":"The scheme (protocol) of the URL.\nExample value: https","nullable":true,"example":"https"}},"additionalProperties":false,"description":"The URL information for a page."}},"components/schemas/WorkflowCommand":{"id":"components/schemas/WorkflowCommand","kind":"json-schema","title":"WorkflowCommand","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the workflow command.\nExample value: cf6a557d-0b86-4432-bf47-302a18238e74","nullable":true,"example":"cf6a557d-0b86-4432-bf47-302a18238e74"},"displayName":{"type":"string","description":"The display name of the workflow command.\nExample value: Submit","nullable":true,"example":"Submit"},"icon":{"type":"string","description":"The icon associated with the workflow command.\nExample value: office/16x16/submit.png","nullable":true,"example":"office/16x16/submit.png"},"suppressComment":{"type":"boolean","description":"Specifies whether to suppress the comment form when executing the workflow command."}},"additionalProperties":false}},"components/schemas/WorkflowWarning":{"id":"components/schemas/WorkflowWarning","kind":"json-schema","title":"WorkflowWarning","data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the page on which the warning occurred.\nExample value: 8f0b81bc-7388-46be-b109-6e73d1114470","nullable":true,"example":"8f0b81bc-7388-46be-b109-6e73d1114470"},"errorCode":{"type":"string","description":"The error code of the warning.\nExample value: SomeDatasourcesAreLocked","nullable":true,"example":"SomeDatasourcesAreLocked"},"message":{"type":"string","description":"The warning message.\nExample value: Some of the page datasources are locked.","nullable":true,"example":"Some of the page datasources are locked."}},"additionalProperties":false}},"schema_1339":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PageRequest"}},"id":"schema_1339"},"schema_1340":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1340"},"schema_1341":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_1341"},"schema_1342":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1342"},"schema_1343":{"kind":"json-schema","data":{"type":"string","example":"my-site"},"id":"schema_1343"},"schema_1344":{"kind":"json-schema","data":{"type":"string","example":"en-US"},"id":"schema_1344"},"schema_1345":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":2},"id":"schema_1345"},"schema_1346":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_1346"},"schema_1347":{"kind":"json-schema","data":{"type":"string","example":"Home"},"id":"schema_1347"},"schema_1348":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["758852c6488045cca3947d83ff2f56e7","888852c6488045cca3947d83ff2f56e7"]},"id":"schema_1348"},"schema_1349":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TypeFilter"},"id":"schema_1349"},"schema_1350":{"kind":"json-schema","data":{"type":"string","example":"en"},"id":"schema_1350"},"schema_1351":{"kind":"json-schema","data":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","example":10},"id":"schema_1351"},"schema_1352":{"kind":"json-schema","data":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","example":1},"id":"schema_1352"},"schema_1353":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PageInsertOption"}},"id":"schema_1353"},"schema_1354":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Page"}},"id":"schema_1354"},"schema_1355":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_1355"}},"exampleStore":{"paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1aggregation~1pages~1live~1variants/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1aggregation~1pages/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1aggregation~1pages/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}/patch/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}/patch/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1state/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1search/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1search/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1search/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1search/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1insertoptions/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1versions/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1versions/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1live~1variants/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1live/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1blueprint/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1blueprint/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1layout/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1fields/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1duplicate/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1rename/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1version/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1translate/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/400/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request","status":400,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem.","traceId":"00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00","errors":{"sampleProperty":["The sampleProperty field is required"]}},"id":"paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/404/content/application~1json/example":{"value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not Found","status":404,"detail":"A detailed explanation, specific to this occurrence of the problem.","instance":"If available, a URI reference that identifies the specific occurrence of the problem."},"id":"paths/~1api~1v1~1pages~1{pageId}~1versions~1{versionNumber}~1{language}/delete/responses/404/content/application~1json/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"Bearer","description":"Enter your bearer token in the text input below."}},"servers":[{"url":"https://xmapps-api.sitecorecloud.io","description":"Production server"}],"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/pages-api/index.json?download"},{"url":"/_bundle/sai/pages-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Pages API","description":"Use the Pages API for managing your site pages in SitecoreAI.\n\nThis API lets you interact with your pages, including:\n- Creating, updating, retrieving, and deleting pages.\n- Retrieving versions and variants.\n- Update layouts.\n\nNote the following:\n   - All API requests are made in your production environment.\n\n For more information, see the [official SitecoreAI developer documentation](https://doc.sitecore.com/xmc/en/developers/xm-cloud/getting-started-with-xm-cloud.html).\n\n# Authorization\nTo authorize your requests, use environment automation client credentials and generate a JSON Web Token (JWT).\n\nNote: To create client credentials, you must be an [Organization Admin](https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/roles.html) or Organization Owner.\n\n## Create an automation client\n 1. In the Sitecore Cloud Portal, open SitecoreAI Deploy.\n 2. Click **Credentials** > **Environment** > **Create credentials** > **Automation**.\n 3. Fill out the automation client details, then click **Create**.\n 4. Copy the client ID and the client secret because you won't be able to view them again in SitecoreAI Deploy. You'll use them to request a JWT.\n\n## Request a JWT\n\nRun the following cURL command to request a JWT. Replace the placeholder values with your client ID and client secret.\n```curl\n  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_CLIENT_ID}' \\\n  --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n```\n\nIn the response, the `access_token` key contains the JWT:\n\n```json\n  {\n    \"access_token\": \"{YOUR_JWT}\",\n    \"scope\": \"xmcloud.cm:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n```\n\nThe JWT expires in 24 hours. If your requests unexpectedly return a response with status `401 Unauthorized`, request a new JWT by repeating this `POST` request.\n\nWe recommend that you cache the JWT for 24 hours to avoid repeating this `POST` request while the JWT is still valid.\n\n## Include the JWT in the request header\n\nYou can now start making REST API requests. You must include the JWT in the request header of every request. For example:\n  ```curl\n  curl -X GET '{YOUR_BASE_URL}/...' \\\n  -H 'Authorization: Bearer {YOUR_JWT}' \\\n  -H 'Accept: application/json'\n  ```","product":"SitecoreAI"}},"baseSlug":"/sai/pages-api","routesMapping":{}}