{"items":[{"type":"link","label":"Publishing API","link":"/sai/publishing-api","routeSlug":"/sai/publishing-api","content":{"contentType":"overview","meta":{"name":"Publishing API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/sai/publishing-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/sai/publishing-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Publishing API (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the XM Cloud Publishing API to manage publishing jobs for a specific XM Cloud tenant. This API lets you create new publishing jobs, list both running and completed publishing jobs, and retrieve statistics about the publishing jobs of an XM Cloud tenant."},"children":[]}]}]}]}],"sectionId":"/sai/publishing-api"}],"sectionId":"/sai/publishing-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the Publishing API, you need a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/request-a-jwt-for-experience-edge.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requested using an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/xmc/en/developers/xm-cloud/manage-client-credentials-for-an-xm-cloud-organization-or-environment.html#create-an-automation-client-for-an-xm-cloud-environment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automation client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is sent with every request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use publishing endpoints, your token must include the required scopes. "},"children":[]}]}]}]}]}],"sectionId":"/sai/publishing-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/sai/publishing-api/section/authentication","routeSlug":"/sai/publishing-api/section/authentication","content":null},{"type":"group","label":"Jobs","link":"/sai/publishing-api/jobs","routeSlug":"/sai/publishing-api/jobs","items":[{"label":"Retrieve a publishing job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/getjob","routeSlug":"/sai/publishing-api/jobs/getjob","metadata":{"seo":{"title":"Retrieve a publishing job","description":"Retrieves a specific publishing job with the specified ID, for example, job_41B25.  To retrieve a job, your token must include one of the following scopes  xmcpub.jobs.a:r, xmcpub.jobs.t:r, or xmcpub.jobs.t:rl. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetJob","name":"Retrieve a publishing job","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a publishing job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a specific publishing job with the specified ID, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_41B25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a job, your token must include one of the following scopes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" xmcpub.jobs.a:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:rl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1356","description":"ID of the job to retrieve.","required":true}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authoring/publishing/v1/jobs/{id}","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1356"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/authoring/publishing/v1/jobs/{id}","href":"jobs/getjob","openApiOperationId":"GetJob","summary":"Retrieve a publishing job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobResponse"}},"schemaId":"components/schemas/PublishJobResponse"},{"code":"400","description":"Invalid job ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Possible reasons:"},"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":"Authorization failed (required scopes and/or roles are missing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context tenant cannot be resolved from the access token"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Job not found with the specified job ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublishJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjob"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs/{id}"},{"label":"Retrieve a list of jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/getjobs","routeSlug":"/sai/publishing-api/jobs/getjobs","metadata":{"seo":{"title":"Retrieve a list of jobs","description":"Lists all publishing jobs for a specific tenant, including jobs that are in progress, completed, failed, and so on. This endpoint supports two types of pagination:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetJobs","name":"Retrieve a list of jobs","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all publishing jobs for a specific tenant, including jobs that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on. This endpoint supports two types of pagination:"},"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":"Offset pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkpoint pagination"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use offset pagination, only the first 1000 records are returned. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a list of jobs, your token must include one of the following scopes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" xmcpub.jobs.a:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:rl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_1357","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number of the results to return. The first page is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This parameter must be used only in offset pagination requests as it indicates that offset pagination should be used."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_1358","description":"The number of results per page."},{"name":"source","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source value to use when filtering jobs. Use a pipe to specify multiple values  (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?source=Pages|Sites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Wildcards are not supported."},"children":[]}]}]}]},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the creator to use when filtering jobs. Use a pipe to specify multiple values  (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.createdBy.id=Qbu3QmWtnQoU0my5jX9MFxBYIeQrFhd2|auth0|000b2fc5fa6b9e5883b6245b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Wildcards are not supported."},"children":[]}]}]}]},{"name":"system.createdBy.name","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the creator to use when filtering jobs. Use a pipe to specify multiple values  (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.createdBy.name=John+Doe|John+Smith"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Wildcards are not supported."},"children":[]}]}]}]},{"name":"system.status","in":"query","schemaId":"schema_1360","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status value to use when filtering jobs. Use a pipe to specify multiple values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.status=Queued|Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"system.queuedTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job queued time to filter entries by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.queuedTime=>2024-10-14T00:00:00.000Z&system.queuedTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":").  Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]},{"name":"system.startTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job start time to filter entries by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.startTime=>2024-10-14T00:00:00.000Z&system.startTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]},{"name":"system.finishTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job finish time to filter entries by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.finishTime=>2024-10-14T00:00:00.000Z&system.finishTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_1356","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort jobs by. You can specify whether to sort by ascending or descending order, using the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field:order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where order can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ascending or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name:1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The following fields are supported: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system.queuedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system.startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system.finishTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1361","description":"Continuation token value from which to start the selection (checkpoint pagination). The first time you call this endpoint using checkpoint pagination, omit this header."}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authoring/publishing/v1/jobs","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","schemaId":"schema_1357"},{"name":"pageSize","in":"query","schemaId":"schema_1358"},{"name":"source","in":"query","schemaId":"schema_1359"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1359"},{"name":"system.createdBy.name","in":"query","schemaId":"schema_1359"},{"name":"system.status","in":"query","schemaId":"schema_1360","style":"pipeDelimited"},{"name":"system.queuedTime","in":"query","schemaId":"schema_1359"},{"name":"system.startTime","in":"query","schemaId":"schema_1359"},{"name":"system.finishTime","in":"query","schemaId":"schema_1359"},{"name":"sortBy","in":"query","schemaId":"schema_1356"}],"querystring":[],"header":[{"name":"x-sc-continuation","in":"header","schemaId":"schema_1361"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/authoring/publishing/v1/jobs","href":"jobs/getjobs","openApiOperationId":"GetJobs","summary":"Retrieve a list of jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Jobs successfully retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1362"}},"schemaId":"schema_1362"},{"code":"400","description":"Invalid parameters in request query string","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Possible reasons:"},"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":"Authorization failed (required scopes and/or roles are missing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context tenant cannot be resolved from the access token"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1362"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjobs"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs"},{"label":"Create a publishing job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/create","routeSlug":"/sai/publishing-api/jobs/create","metadata":{"seo":{"title":"Create a publishing job","description":"Creates a new publishing job. To create a publishing job, your token must include one of the following scopes  xmcpub.jobs.a:w, xmcpub.jobs.t:w, or xmcpub.jobs.t:wl. Users with a scope of xmcpub.jobs.t:wl  (limited write) must also have Sitecore Client Advanced Publishing or Sitecore Client Publishing  roles or have the admin flag set in XM Cloud.    Client token of applications must have the xmcloud.cm:admin scope. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create","name":"Create a publishing job","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a publishing job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new publishing job. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishing job, your token must include one of the following scopes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" xmcpub.jobs.a:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:wl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Users with a scope of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:wl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (limited write) must also have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sitecore Client Advanced Publishing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sitecore Client Publishing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  roles or have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set in XM Cloud.  "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Client token of applications must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcloud.cm:admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope. "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateJobRequest"},"text/json":{"schemaId":"components/schemas/CreateJobRequest"},"application/*+json":{"schemaId":"components/schemas/CreateJobRequest"}},"schemaId":"components/schemas/CreateJobRequest","pointer":"/paths/~1authoring~1publishing~1v1~1jobs/post/requestBody","description":"The request for creating the job."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authoring/publishing/v1/jobs","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateJobRequest"},"text/json":{"schemaId":"components/schemas/CreateJobRequest"},"application/*+json":{"schemaId":"components/schemas/CreateJobRequest"}},"responseCodes":["201","400","401","403"],"pointer":"/authoring/publishing/v1/jobs","href":"jobs/create","openApiOperationId":"Create","summary":"Create a publishing job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"schemaId":"components/schemas/CreateJobRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateJobRequest"},"text/json":{"schemaId":"components/schemas/CreateJobRequest"},"application/*+json":{"schemaId":"components/schemas/CreateJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Job successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobResponse"}},"schemaId":"components/schemas/PublishJobResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Possible reasons: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid name "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid description "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid items "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid mode "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid locales"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid source "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid tenant"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":"Request does not contain required scopes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PublishJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/create"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs"},{"label":"Retrieve permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/getuserpermissions","routeSlug":"/sai/publishing-api/jobs/getuserpermissions","metadata":{"seo":{"title":"Retrieve permissions","description":"Lists all permissions assigned to the current user.To retrieve permissions, the token must be valid, but no scope is required. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserPermissions","name":"Retrieve permissions","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all permissions assigned to the current user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve permissions, the token must be valid, but no scope is required. "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authoring/publishing/v1/jobs/permissions","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/authoring/publishing/v1/jobs/permissions","href":"jobs/getuserpermissions","openApiOperationId":"GetUserPermissions","summary":"Retrieve permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPermissions"}},"schemaId":"components/schemas/UserPermissions"},{"code":"400","description":"Invalid job ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Possible reasons: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Authorization failed (required scopes and/or roles are missing)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Context tenant cannot be resolved from the access token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserPermissions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPermissions"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getuserpermissions"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs/permissions"},{"label":"Retrieve data for publishing job filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/getjobsfilters","routeSlug":"/sai/publishing-api/jobs/getjobsfilters","metadata":{"seo":{"title":"Retrieve data for publishing job filters","description":"Returns data to populate filters for publishing jobs. Returned data is  dynamic and depends on the filters already selected. This operation finds all publishing jobs that match the selected filters and returns distinct values for the source, system.createdBy, and system.status fields of these jobs.To retrieve publishing jobs that match the selected filters, your token must include one of the following scopes xmcpub.jobs.a:r, xmcpub.jobs.t:r, or xmcpub.jobs.t:rl. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetJobsFilters","name":"Retrieve data for publishing job filters","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve data for publishing job filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data to populate filters for publishing jobs. Returned data is  dynamic and depends on the filters already selected. This operation finds all publishing jobs that match the selected filters and returns distinct values for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system.createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields of these jobs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve publishing jobs that match the selected filters, your token must include one of the following scopes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.a:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:rl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"source","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source value to use when filtering jobs. Use a pipe to specify multiple values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?source=Pages|Sites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Wildcards are not supported."},"children":[]}]}]}]},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the creator to use when filtering jobs. Use a pipe to specify multiple values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.createdBy.id=Qbu3QmWtnQoU0my5jX9MFxBYIeQrFhd2|auth0|000b2fc5fa6b9e5883b6245b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Wildcards are not supported."},"children":[]}]}]}]},{"name":"system.createdBy.name","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the creator to use when filtering jobs. Use a pipe to specify multiple values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.createdBy.name=John+Doe|John+Smith"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Wildcards are not supported."},"children":[]}]}]}]},{"name":"system.status","in":"query","schemaId":"schema_1360","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status value to use when filtering jobs. Use a pipe to specify multiple values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.status=Queued|Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"system.queuedTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job queued time to filter entries by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.queuedTime=>2024-10-14T00:00:00.000Z&system.queuedTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]},{"name":"system.startTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job start time to filter entries by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.startTime=>2024-10-14T00:00:00.000Z&system.startTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]},{"name":"system.finishTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job finish time to filter entries by. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.finishTime=>2024-10-14T00:00:00.000Z&system.finishTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1filters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authoring/publishing/v1/jobs/filters","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[],"query":[{"name":"source","in":"query","schemaId":"schema_1359"},{"name":"system.createdBy.id","in":"query","schemaId":"schema_1359"},{"name":"system.createdBy.name","in":"query","schemaId":"schema_1359"},{"name":"system.status","in":"query","schemaId":"schema_1360","style":"pipeDelimited"},{"name":"system.queuedTime","in":"query","schemaId":"schema_1359"},{"name":"system.startTime","in":"query","schemaId":"schema_1359"},{"name":"system.finishTime","in":"query","schemaId":"schema_1359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/authoring/publishing/v1/jobs/filters","href":"jobs/getjobsfilters","openApiOperationId":"GetJobsFilters","summary":"Retrieve data for publishing job filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job filters successfully retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobFiltersResponse"}},"schemaId":"components/schemas/PublishJobFiltersResponse"},{"code":"400","description":"Invalid parameters in request query string","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Possible reasons:"},"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":"Authorization failed (required scopes and/or roles are missing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context tenant cannot be resolved from the access token"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1filters/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublishJobFiltersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobFiltersResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjobsfilters"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs/filters"},{"label":"Retrieve a summary of publishing jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/getjobsstatistics","routeSlug":"/sai/publishing-api/jobs/getjobsstatistics","metadata":{"seo":{"title":"Retrieve a summary of publishing jobs","description":"Retrieves statistics about publishing jobs, including how many jobs are queued, how many are running or have failed or been canceled, and how many have been completed.To retrieve job statistics, your token must include one of the following scopes xmcpub.jobs.a:r, xmcpub.jobs.t:r, or xmcpub.jobs.t:rl. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetJobsStatistics","name":"Retrieve a summary of publishing jobs","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a summary of publishing jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves statistics about publishing jobs, including how many jobs are queued, how many are running or have failed or been canceled, and how many have been completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve job statistics, your token must include one of the following scopes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.a:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:rl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"system.queuedTime","in":"query","schemaId":"schema_1359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Queued time to use to filter entries. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include more than one filter (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?system.queuedTime=>2024-10-14T00:00:00.000Z&system.queuedTime=<2024-12-31T00:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=>DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"=<DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are supported."},"children":[]}]}]}]}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authoring/publishing/v1/jobs/summary","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[],"query":[{"name":"system.queuedTime","in":"query","schemaId":"schema_1359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/authoring/publishing/v1/jobs/summary","href":"jobs/getjobsstatistics","openApiOperationId":"GetJobsStatistics","summary":"Retrieve a summary of publishing jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobsSummaryResponse"}},"schemaId":"components/schemas/PublishJobsSummaryResponse"},{"code":"400","description":"Invalid parameters in request query string","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Possible reasons:"},"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":"Authorization failed (required scopes and/or roles are missing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context tenant cannot be resolved from the access token"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublishJobsSummaryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublishJobsSummaryResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjobsstatistics"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs/summary"},{"label":"Cancel a publishing job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sai/publishing-api/jobs/canceljob","routeSlug":"/sai/publishing-api/jobs/canceljob","metadata":{"seo":{"title":"Cancel a publishing job","description":"Cancels a publishing job with a specific ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelJob","name":"Cancel a publishing job","isWebhook":false,"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1{jobId}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a publishing job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a publishing job with a specific ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a publishing job, your token must include one of the following"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scopes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.a:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:wl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users with a scope of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:wl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (limited write) must also have a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sitecore Client Advanced Publishing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sitecore Client Publishing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"roles or have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set in the XM Cloud instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If access token includes only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcpub.jobs.t:wl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope, callers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be able to cancel only those publishing job which they started."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client tokens of applications must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmcloud.cm:admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_1356","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the publishing job to cancel, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_AE86B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1{jobId}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authoring/publishing/v1/jobs/{jobId}/cancel","servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_1356"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","403","404","409","501"],"pointer":"/authoring/publishing/v1/jobs/{jobId}/cancel","href":"jobs/canceljob","openApiOperationId":"CancelJob","summary":"Cancel a publishing job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Job cancellation successfully requested."},{"code":"400","description":"Invalid job ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Possible reasons: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Authorization failed (required scopes and/or roles are missing)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Context tenant cannot be resolved from the access token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Job not found with the specified job ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job does not have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"501","description":"Job cancellation is not supported for XM Cloud Content"}],"pointer":"/paths/~1authoring~1publishing~1v1~1jobs~1{jobId}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/canceljob"}],"panels":[]}]},"httpPath":"/authoring/publishing/v1/jobs/{jobId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"The jobs endpoint is used to manage publishing jobs of the context tenant."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authoring/publishing/v1/jobs/{id}","summary":"Retrieve a publishing job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjob","deprecated":false},{"title":"/authoring/publishing/v1/jobs","summary":"Retrieve a list of jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjobs","deprecated":false},{"title":"/authoring/publishing/v1/jobs","summary":"Create a publishing job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/create","deprecated":false},{"title":"/authoring/publishing/v1/jobs/permissions","summary":"Retrieve permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getuserpermissions","deprecated":false},{"title":"/authoring/publishing/v1/jobs/filters","summary":"Retrieve data for publishing job filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjobsfilters","deprecated":false},{"title":"/authoring/publishing/v1/jobs/summary","summary":"Retrieve a summary of publishing jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjobsstatistics","deprecated":false},{"title":"/authoring/publishing/v1/jobs/{jobId}/cancel","summary":"Cancel a publishing job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/canceljob","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CheckpointPagingPublishJobsResponse":{"id":"components/schemas/CheckpointPagingPublishJobsResponse","kind":"json-schema","title":"CheckpointPagingPublishJobsResponse","data":{"required":["data","next"],"type":"object","properties":{"next":{"type":"string","description":"Continuation token for the next page.","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublishJobResponse"},"description":"The collection of data for response.","nullable":true}},"additionalProperties":false,"description":"Represented batch data response."}},"components/schemas/CreateJobRequest":{"id":"components/schemas/CreateJobRequest","kind":"json-schema","title":"CreateJobRequest","data":{"required":["name","options","source"],"type":"object","properties":{"name":{"maxLength":256,"minLength":0,"type":"string","description":"Name of the job."},"source":{"maxLength":256,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of the job. This is typically the application name specified as the source (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on)."},"children":[]}]}]}]},"options":{"$ref":"#/components/schemas/PublishOptionsModel"},"description":{"maxLength":256,"minLength":0,"type":"string","description":"Description of the job.","nullable":true}},"additionalProperties":false,"description":"The request for creating a job."}},"components/schemas/CreatedByData":{"id":"components/schemas/CreatedByData","kind":"json-schema","title":"CreatedByData","data":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the creator.","nullable":true},"name":{"type":"string","description":"The name of the creator.","nullable":true},"type":{"enum":["Application","User"],"type":"string","description":"The type of the creator."}},"additionalProperties":false,"description":"Represents the data for the user who created the job."}},"components/schemas/CreatedByDataItem":{"id":"components/schemas/CreatedByDataItem","kind":"json-schema","title":"CreatedByDataItem","data":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreatedByData"}},"additionalProperties":false,"description":"The data item wrapper."}},"components/schemas/ItemModel":{"id":"components/schemas/ItemModel","kind":"json-schema","title":"ItemModel","data":{"required":["id","type"],"type":"object","properties":{"id":{"maxLength":50,"minLength":0,"type":"string","description":"ID of the item to publish."},"type":{"maxLength":256,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the item to publish (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Site"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Item"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on)."},"children":[]}]}]}]},"locale":{"maxLength":20,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locale of the item to publish. Items can have a locale"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which means that items must be published in all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"languages. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified for each item or as a list"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options.xmc.locales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A combination of locale in item and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options.xmc.locales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not allowed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xx-YY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ISO-639-1 language"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ISO 3166-1 country code."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Represents an item request."}},"components/schemas/Items":{"id":"components/schemas/Items","kind":"json-schema","title":"Items","data":{"required":["mode","publishChildren","publishRelatedItems"],"type":"object","allOf":[{"$ref":"#/components/schemas/XmcPublishingOptionsModel"}],"properties":{"mode":{"enum":["Republish","Smart"],"type":"string","description":"Mode of the items publish job."},"publishRelatedItems":{"type":"boolean","description":"Whether to publish related items."},"publishChildren":{"type":"boolean","description":"Whether to publish children items recursively."}},"additionalProperties":false,"description":"Represents XMC publishing items options model."}},"components/schemas/ItemsOptionsModel":{"id":"components/schemas/ItemsOptionsModel","kind":"json-schema","title":"ItemsOptionsModel","data":{"required":["mode"],"type":"object","properties":{"publishRelatedItems":{"type":"boolean","description":"Whether to publish related items.","default":false},"publishChildren":{"type":"boolean","description":"Whether to publish children items recursively.","default":false},"mode":{"enum":["Republish","Smart"],"type":"string","description":"Mode of the items publish job."}},"additionalProperties":false,"description":"Represents the items options for publishing."}},"components/schemas/JobStatistics":{"id":"components/schemas/JobStatistics","kind":"json-schema","title":"JobStatistics","data":{"type":"object","properties":{"lastReportTime":{"type":"string","description":"The last time the statistics were updated.","format":"date-time"},"itemsSent":{"type":"integer","description":"The number of items sent.","format":"int32"},"itemsProcessed":{"type":"integer","description":"The number of items processed.","format":"int32"},"itemsFailed":{"type":"integer","description":"The number of items failed.","format":"int32"},"xmc":{"$ref":"#/components/schemas/XmcStatistics"}},"additionalProperties":false,"description":"The job statistics."}},"components/schemas/OffsetPagingPublishJobsResponse":{"id":"components/schemas/OffsetPagingPublishJobsResponse","kind":"json-schema","title":"OffsetPagingPublishJobsResponse","data":{"required":["data","pageNumber","pageSize","totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","description":"The total count of items.","format":"int32"},"pageNumber":{"type":"integer","description":"The page number.","format":"int32"},"pageSize":{"type":"integer","description":"The page size.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublishJobResponse"},"description":"The collection of data for response.","nullable":true}},"additionalProperties":false,"description":"Represented batch data response."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}},"components/schemas/PublishJobFiltersResponse":{"id":"components/schemas/PublishJobFiltersResponse","kind":"json-schema","title":"PublishJobFiltersResponse","data":{"required":["createdBy","sources","statuses"],"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/PublishJobStatusDataItem"},"description":"The available statuses for filtering."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceDataItem"},"description":"The unique list of available sources."},"createdBy":{"type":"array","items":{"$ref":"#/components/schemas/CreatedByDataItem"},"description":"The unique list of jobs creators."}},"additionalProperties":false,"description":"The response for publishing job filters."}},"components/schemas/PublishJobResponse":{"id":"components/schemas/PublishJobResponse","kind":"json-schema","title":"PublishJobResponse","data":{"required":["id","name","options","permissions","source"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the job.","nullable":true},"description":{"type":"string","description":"The description of the job.","nullable":true},"name":{"type":"string","description":"The name of the job.","nullable":true},"options":{"$ref":"#/components/schemas/ResponsePublishOptionsModel"},"source":{"type":"string","description":"The source of the job.","nullable":true},"statistics":{"$ref":"#/components/schemas/JobStatistics"},"system":{"$ref":"#/components/schemas/SystemData"},"permissions":{"$ref":"#/components/schemas/PublishingJobPermissions"}},"additionalProperties":false,"description":"The response for creating a job."}},"components/schemas/PublishJobStatusData":{"id":"components/schemas/PublishJobStatusData","kind":"json-schema","title":"PublishJobStatusData","data":{"required":["status"],"type":"object","properties":{"status":{"enum":["Queued","Running","Completed","Failed","Canceled","Canceling"],"type":"string","description":"The job status."}},"additionalProperties":false,"description":"The publish job status data."}},"components/schemas/PublishJobStatusDataItem":{"id":"components/schemas/PublishJobStatusDataItem","kind":"json-schema","title":"PublishJobStatusDataItem","data":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PublishJobStatusData"}},"additionalProperties":false,"description":"The data item wrapper."}},"components/schemas/PublishJobsSummaryResponse":{"id":"components/schemas/PublishJobsSummaryResponse","kind":"json-schema","title":"PublishJobsSummaryResponse","data":{"required":["counts"],"type":"object","properties":{"counts":{"$ref":"#/components/schemas/StatisticsCounts"}},"additionalProperties":false,"description":"The response for publishing job summary."}},"components/schemas/PublishOptionsModel":{"id":"components/schemas/PublishOptionsModel","kind":"json-schema","title":"PublishOptionsModel","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemModel"},"description":"Root items to start publishing from.","nullable":true},"xmc":{"$ref":"#/components/schemas/XmcPublishingModel"}},"additionalProperties":false,"description":"The publish job options."}},"components/schemas/PublishingJobPermissions":{"id":"components/schemas/PublishingJobPermissions","kind":"json-schema","title":"PublishingJobPermissions","data":{"type":"object","properties":{"canViewDetails":{"type":"boolean","description":"Whether details of the publishing job can be viewed."},"canCancel":{"type":"boolean","description":"Whether the publishing job can be canceled."}},"additionalProperties":false,"description":"The permissions of the current user or application to work with the job."}},"components/schemas/ResponsePublishOptionsModel":{"id":"components/schemas/ResponsePublishOptionsModel","kind":"json-schema","title":"ResponsePublishOptionsModel","data":{"type":"object","properties":{"xmc":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Items"},{"$ref":"#/components/schemas/Site"}],"description":"XMC publishing options.","nullable":true}},"additionalProperties":false,"description":"The options the publishing job was created with."}},"components/schemas/Site":{"id":"components/schemas/Site","kind":"json-schema","title":"Site","data":{"required":["mode"],"type":"object","allOf":[{"$ref":"#/components/schemas/XmcPublishingOptionsModel"}],"properties":{"mode":{"enum":["Republish","Incremental","Smart"],"type":"string","description":"Mode of the site publish job."}},"additionalProperties":false,"description":"Represents XmcPublishingSiteOptionsModel."}},"components/schemas/SiteOptionsModel":{"id":"components/schemas/SiteOptionsModel","kind":"json-schema","title":"SiteOptionsModel","data":{"required":["mode"],"type":"object","properties":{"mode":{"enum":["Republish","Incremental","Smart"],"type":"string","description":"Mode of the items publish job."}},"additionalProperties":false,"description":"Site options for publishing."}},"components/schemas/SourceData":{"id":"components/schemas/SourceData","kind":"json-schema","title":"SourceData","data":{"required":["source"],"type":"object","properties":{"source":{"type":"string","description":"The source value.","nullable":true}},"additionalProperties":false,"description":"The source data."}},"components/schemas/SourceDataItem":{"id":"components/schemas/SourceDataItem","kind":"json-schema","title":"SourceDataItem","data":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SourceData"}},"additionalProperties":false,"description":"The data item wrapper."}},"components/schemas/StatisticsCounts":{"id":"components/schemas/StatisticsCounts","kind":"json-schema","title":"StatisticsCounts","data":{"required":["canceled","canceling","completed","failed","queued","running"],"type":"object","properties":{"queued":{"type":"integer","description":"The total number of jobs queued.","format":"int32"},"running":{"type":"integer","description":"The total number of jobs running.","format":"int32"},"canceled":{"type":"integer","description":"The total number of jobs canceled.","format":"int32"},"failed":{"type":"integer","description":"The total number of failed jobs.","format":"int32"},"completed":{"type":"integer","description":"The number of completed jobs.","format":"int32"},"canceling":{"type":"integer","description":"The number of jobs currently being canceled.","format":"int32"}},"additionalProperties":false,"description":"The job count for every status."}},"components/schemas/SystemData":{"id":"components/schemas/SystemData","kind":"json-schema","title":"SystemData","data":{"required":["organizationId","status","tenantId"],"type":"object","properties":{"organizationId":{"type":"string","description":"The ID of the organization that the job belongs to.","nullable":true},"tenantId":{"type":"string","description":"The ID of the tenant that the job belongs to.","format":"uuid"},"tenantJobId":{"type":"string","description":"The job ID on the tenant side.","nullable":true},"status":{"enum":["Queued","Running","Completed","Failed","Canceled","Canceling"],"type":"string","description":"The status of the job."},"queuedTime":{"type":"string","description":"The time when the job was queued.","format":"date-time","nullable":true},"startTime":{"type":"string","description":"The time when the job was started.","format":"date-time","nullable":true},"finishTime":{"type":"string","description":"The time when the job was finished.","format":"date-time","nullable":true},"createdBy":{"$ref":"#/components/schemas/User"},"canceledBy":{"$ref":"#/components/schemas/User"}},"additionalProperties":false,"description":"The system data of a job."}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string","description":"The ID of service client.","nullable":true},"name":{"type":"string","description":"The name of service client.","nullable":true},"type":{"enum":["Application","User"],"type":"string","description":"The type of service client."}},"additionalProperties":false,"description":"The service client description."}},"components/schemas/UserPermissions":{"id":"components/schemas/UserPermissions","kind":"json-schema","title":"UserPermissions","data":{"type":"object","properties":{"canReadAll":{"type":"boolean","description":"Whether the user can read all jobs."},"canReadOwn":{"type":"boolean","description":"Whether the user can read their own jobs."},"canViewDetailsOfAll":{"type":"boolean","description":"Whether the user can view details of all jobs."},"canViewDetailsOfOwn":{"type":"boolean","description":"Whether the user can view details of their own jobs."},"canCreate":{"type":"boolean","description":"Whether the user can create jobs."}},"additionalProperties":false,"description":"The permissions assigned to a user."}},"components/schemas/XmcPublishingModel":{"id":"components/schemas/XmcPublishingModel","kind":"json-schema","title":"XmcPublishingModel","data":{"type":"object","properties":{"locales":{"maxItems":256,"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":"Locales in which content is to be published. This field is required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for XM Cloud site publishing jobs (when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options.xmc.site"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and is optional for XM Cloud items publishing jobs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When it is specified for items publishing none of the items should have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of each element in array must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xx-YY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ISO-639-1 language code and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ISO 3166-1 country code."},"children":[]}]}]}],"nullable":true},"site":{"$ref":"#/components/schemas/SiteOptionsModel"},"items":{"$ref":"#/components/schemas/ItemsOptionsModel"}},"additionalProperties":false,"description":"Represents a model for XMC publishing."}},"components/schemas/XmcPublishingOptionsModel":{"id":"components/schemas/XmcPublishingOptionsModel","kind":"json-schema","title":"XmcPublishingOptionsModel","data":{"required":["locales"],"type":"object","properties":{"locales":{"type":"array","items":{"type":"string"},"description":"Locales in which content is to be published."}},"additionalProperties":false,"description":"Base class for XmcPublishingOptionsModel."}},"components/schemas/XmcStatistics":{"id":"components/schemas/XmcStatistics","kind":"json-schema","title":"XmcStatistics","data":{"type":"object","properties":{"additionalItemsSent":{"type":"integer","description":"The number of additional items sent.","format":"int32"},"itemsAcknowledged":{"type":"integer","description":"The number of items acknowledged.","format":"int32"},"itemsDeleted":{"type":"integer","description":"The number of items deleted.","format":"int32"},"itemsSkipped":{"type":"integer","description":"The number of items skipped.","format":"int32"},"itemsSendingComplete":{"type":"boolean","description":"Indicates whether the sending of items is complete."}},"additionalProperties":false,"description":"Additional fields of the XMC statistics."}},"schema_1356":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1356"},"schema_1357":{"kind":"json-schema","data":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"id":"schema_1357"},"schema_1358":{"kind":"json-schema","data":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":50},"id":"schema_1358"},"schema_1359":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_1359"},"schema_1360":{"kind":"json-schema","data":{"type":"array","items":{"enum":["Queued","Running","Completed","Failed","Canceled","Canceling"],"type":"string","description":"The status of a publish job."}},"id":"schema_1360"},"schema_1361":{"kind":"json-schema","data":{"maxLength":16384,"type":"string"},"id":"schema_1361"},"schema_1362":{"kind":"json-schema","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OffsetPagingPublishJobsResponse"},{"$ref":"#/components/schemas/CheckpointPagingPublishJobsResponse"}],"description":"Represented batch data response."},"id":"schema_1362"}},"exampleStore":{},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Example: \"abcdef12345\" (w/o Bearer prefix)"}},"servers":[{"url":"https://edge-platform.sitecorecloud.io"}],"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/publishing-api/index.json?download"},{"url":"/_bundle/sai/publishing-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Publishing API","description":"Use the XM Cloud Publishing API to manage publishing jobs for a specific XM Cloud tenant. This API lets you create new publishing jobs, list both running and completed publishing jobs, and retrieve statistics about the publishing jobs of an XM Cloud tenant.\n## Authentication\nTo use the Publishing API, you need a [JWT token](https://doc.sitecore.com/xmc/en/developers/xm-cloud/request-a-jwt-for-experience-edge.html) requested using an [automation client](https://doc.sitecore.com/xmc/en/developers/xm-cloud/manage-client-credentials-for-an-xm-cloud-organization-or-environment.html#create-an-automation-client-for-an-xm-cloud-environment). This is sent with every request. <br> {% admonition type=\"info\" name=\"Note\" %}To use publishing endpoints, your token must include the required scopes. {% /admonition %}\n","product":"SitecoreAI"}},"baseSlug":"/sai/publishing-api","routesMapping":{}}