Create a publishing job

Request

Creates a new publishing job.

Note

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.

Note

Client token of applications must have the xmcloud.cm:admin scope.

Security

Bearer

Body

The request for creating the job.

namestring, [ 0 .. 256 ] charactersrequired

Name of the job.

optionsobject(PublishOptionsModel)required

The publish job options.

sourcestring, [ 0 .. 256 ] charactersrequired

Source of the job. This is typically the application name specified as the source (for example, Pages, Sites, and so on).

descriptionstring or null, [ 0 .. 256 ] characters

Description of the job.

curl -i -X POST \
  https://edge-platform.sitecorecloud.io/authoring/publishing/v1/jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "source": "string",
    "options": {
      "items": [
        {
          "id": "string",
          "type": "string",
          "locale": "string"
        }
      ],
      "xmc": {
        "locales": [
          "string"
        ],
        "site": {
          "mode": "Republish"
        },
        "items": {
          "publishRelatedItems": false,
          "publishChildren": false,
          "mode": "Republish"
        }
      }
    },
    "description": "string"
  }'

Responses

Job successfully created.

Bodyapplication/json

idstring or nullrequired

The ID of the job.

namestring or nullrequired

The name of the job.

optionsobject(ResponsePublishOptionsModel)required

The options the publishing job was created with.

permissionsobject(PublishingJobPermissions)required

The permissions of the current user or application to work with the job.

sourcestring or nullrequired

The source of the job.

descriptionstring or null

The description of the job.

statisticsobject(JobStatistics)

The job statistics.

systemobject(SystemData)

The system data of a job.

Response

{
  "id": "string",
  "description": "string",
  "name": "string",
  "options": {
    "xmc": { … }
  },
  "source": "string",
  "statistics": {
    "lastReportTime": "2019-08-24T14:15:22Z",
    "itemsSent": 0,
    "itemsProcessed": 0,
    "itemsFailed": 0,
    "xmc": { … }
  },
  "system": {
    "organizationId": "string",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "tenantJobId": "string",
    "status": "Queued",
    "queuedTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "finishTime": "2019-08-24T14:15:22Z",
    "createdBy": { … },
    "canceledBy": { … }
  },
  "permissions": {
    "canViewDetails": true,
    "canCancel": true
  }
}