Retrieve data for publishing job filters

Request

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.

Note

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.

Security

Bearer

Query

sourceArray of strings

The source value to use when filtering jobs. Use a pipe to specify multiple values (for example, ?source=Pages|Sites). Wildcards are not supported.

system.createdBy.idArray of strings

The ID of the creator to use when filtering jobs. Use a pipe to specify multiple values (for example, ?system.createdBy.id=Qbu3QmWtnQoU0my5jX9MFxBYIeQrFhd2|auth0|000b2fc5fa6b9e5883b6245b). Wildcards are not supported.

system.createdBy.nameArray of strings

The name of the creator to use when filtering jobs. Use a pipe to specify multiple values (for example, ?system.createdBy.name=John+Doe|John+Smith). Wildcards are not supported.

system.statusArray of strings

The status value to use when filtering jobs. Use a pipe to specify multiple values (for example, ?system.status=Queued|Running).

system.queuedTimeArray of strings

The job queued time to filter entries by. Use & to include more than one filter (for example, ?system.queuedTime=>2024-10-14T00:00:00.000Z&system.queuedTime=<2024-12-31T00:00:00.000Z). Only =>DATE and =<DATE filters are supported.

system.startTimeArray of strings

The job start time to filter entries by. Use & to include more than one filter (for example, ?system.startTime=>2024-10-14T00:00:00.000Z&system.startTime=<2024-12-31T00:00:00.000Z). Only =>DATE and =<DATE filters are supported.

system.finishTimeArray of strings

The job finish time to filter entries by. Use & to include more than one filter (for example, ?system.finishTime=>2024-10-14T00:00:00.000Z&system.finishTime=<2024-12-31T00:00:00.000Z. Only =>DATE and =<DATE filters are supported.

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/publishing/v1/jobs/filters?source=string&system.createdBy.id=string&system.createdBy.name=string&system.status=Queued&system.queuedTime=string&system.startTime=string&system.finishTime=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Job filters successfully retrieved

Bodyapplication/json

createdByArray of objects(CreatedByDataItem)required

The unique list of jobs creators.

sourcesArray of objects(SourceDataItem)required

The unique list of available sources.

statusesArray of objects(PublishJobStatusDataItem)required

The available statuses for filtering.

Response

{
  "statuses": [
    { … }
  ],
  "sources": [
    { … }
  ],
  "createdBy": [
    { … }
  ]
}