Sitecore API catalog/Publishing API/Jobs

Retrieve a publishing job

Request

Retrieves a specific publishing job with the specified ID, for example, job_41B25.

Note
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.

Security
Bearer
Path
idstringrequired

ID of the job to retrieve.

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/publishing/v1/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

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
  }
}