Sitecore API catalog/Download orders API/Download orders

Download orders

A download order is a compressed file that contains media files along with the download order configuration.

Operations

Retrieve a download order with a specific ID

Request

Retrieves a download order with a specific ID along with download details, such as the target count, whether the order has conversions, who created the order and when, as well as the download status.

Security
OAuth2
Path
idinteger, (int64)required

The identifier of the download order.

Headers
If-Modified-Sincestring, (date-time)

Optional. The date after which to verify if the download order was modified. If the order was modified, a 304 response code is returned.

curl -i -X GET \
  'https://your-server/api/downloadorders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'If-Modified-Since: 2019-08-24T14:15:22Z'

Responses

Successful operation

Bodyapplication/json
order_idinteger, (int64)

The ID of the download order.

namestring or null

The name of the download order.

target_countinteger, (int64)

The number of targets contained in the download order.

has_conversionsboolean

Whether the order contains converted files or not.

created_byobject(Link)

Represents a link to a resource.

created_onstring or null, (date-time)

The date the download order was created.

modified_byobject(Link)

Represents a link to a resource.

statusstring or null

The status of the download order, for example, Completed.

download_locationobject(Link)

Represents a link to a resource.

additional_infostring or null

Additional information about the download order.

external_job_referenceobject(Link)

Represents a link to a resource.

targetsobject(Link)

Represents a link to a resource.

culturestring or null

The culture code of the download order, for example en-US.

selfobject(Link)

Represents a link to a resource.

Response
{
  "order_id": 0,
  "name": "string",
  "target_count": 0,
  "has_conversions": true,
  "created_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "created_on": "2019-08-24T14:15:22Z",
  "modified_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "status": "string",
  "download_location": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "additional_info": "string",
  "external_job_reference": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "targets": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "culture": "string",
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}