Create a download order

Request

Creates a download order for the specified assets using the defined download options.

Security

OAuth2

Body

required

A download order request that contains the order details.

orderobject(OrderRequestResource)required

The configuration to create an order.

target_selectionobject(SelectionResource)

Describes what selection pool to use for an order. The selection pool contains the list of entities to download.

culturestring or null

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

namestring or null

The name of the download order.

download_order_typestring(DownloadOrderType)

The type of order, for example, Standard or Custom.

Enum:"Standard""Custom"

item_name_resolver_idstring or nulldeprecated

The ID of the item name resolver.

curl -i -X POST \
  https://your-server/api/downloadorders \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "target_selection": {
      "selectionPool": "string",
      "subPoolId": 0,
      "definitionName": "string"
    },
    "item_name_resolver_id": "string",
    "culture": "string",
    "name": "string",
    "order": {
      "zip_filename": "string",
      "global": {
        "property1": {
          "renditions": [
            "string"
          ],
          "conversions": [
            [
              {
                "type": "fileExtension",
                "value": {}
              }
            ]
          ],
          "user_rendition_configuration": {
            "label": "string",
            "culture": "string",
            "description": "string"
          },
          "presets": [
            "string"
          ]
        },
        "property2": {
          "renditions": [
            "string"
          ],
          "conversions": [
            [
              {
                "type": "fileExtension",
                "value": {}
              }
            ]
          ],
          "user_rendition_configuration": {
            "label": "string",
            "culture": "string",
            "description": "string"
          },
          "presets": [
            "string"
          ]
        }
      },
      "individual": {
        "property1": {
          "renditions": [
            "string"
          ],
          "conversions": [
            [
              {
                "type": "fileExtension",
                "value": {}
              }
            ]
          ],
          "user_rendition_configuration": {
            "label": "string",
            "culture": "string",
            "description": "string"
          },
          "presets": [
            "string"
          ]
        },
        "property2": {
          "renditions": [
            "string"
          ],
          "conversions": [
            [
              {
                "type": "fileExtension",
                "value": {}
              }
            ]
          ],
          "user_rendition_configuration": {
            "label": "string",
            "culture": "string",
            "description": "string"
          },
          "presets": [
            "string"
          ]
        }
      }
    },
    "download_order_type": "Standard"
  }'

Responses

Created

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)