{"items":[{"type":"link","label":"Download orders API","link":"/ch/download-orders-api","routeSlug":"/ch/download-orders-api","content":{"contentType":"overview","meta":{"name":"Download orders API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ch/download-orders-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ch/download-orders-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Download orders API (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Download orders API to create and retrieve download orders. A download order is a compressed file that contains media files, such as images, vectors, or videos."},"children":[]}]}]}]}],"sectionId":"/ch/download-orders-api"}],"sectionId":"/ch/download-orders-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the Download orders API, you need:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{{server}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable by hovering your mouse  over the variable in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pane and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token and the client ID. Both are sent with every request. You can create a token through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Hub interface"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#making-requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting one using the API itself"},"children":[]}]}]}]}]}]}],"sectionId":"/ch/download-orders-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/ch/download-orders-api/section/authentication","routeSlug":"/ch/download-orders-api/section/authentication","content":null},{"type":"group","label":"Download orders","link":"/ch/download-orders-api/download-orders","routeSlug":"/ch/download-orders-api/download-orders","items":[{"label":"Retrieve a download order with a specific ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/download-orders-api/download-orders/downloadordersbyid","routeSlug":"/ch/download-orders-api/download-orders/downloadordersbyid","metadata":{"seo":{"title":"Retrieve a download order with a specific ID","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DownloadOrdersById","name":"Retrieve a download order with a specific ID","isWebhook":false,"pointer":"/paths/~1api~1downloadorders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a download order with a specific ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_914","description":"The identifier of the download order.","required":true}],"pointer":"/paths/~1api~1downloadorders~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Modified-Since","in":"header","schemaId":"schema_915","description":"Optional. The date after which to verify if the download order was modified. If the order was modified, a 304 response code is returned."}],"pointer":"/paths/~1api~1downloadorders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/downloadorders/{id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_914"}],"query":[],"querystring":[],"header":[{"name":"If-Modified-Since","in":"header","schemaId":"schema_915"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","304","401","404"],"pointer":"/api/downloadorders/{id}","href":"download-orders/downloadordersbyid","openApiOperationId":"DownloadOrdersById","summary":"Retrieve a download order with a specific ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderResource"}},"schemaId":"components/schemas/DownloadOrderResource"},{"code":"304","description":"Download order not modified"},{"code":"401","description":"Unauthorized request"},{"code":"404","description":"Download order not found or user not authorized"}],"pointer":"/paths/~1api~1downloadorders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadOrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderResource"}}},{"code":"304"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-orders/downloadordersbyid"}],"panels":[]}]},"httpPath":"/api/downloadorders/{id}"},{"label":"Retrieve multiple download orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/download-orders-api/download-orders/downloadorders","routeSlug":"/ch/download-orders-api/download-orders/downloadorders","metadata":{"seo":{"title":"Retrieve multiple download orders","description":"Lists the download orders that the current user has access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DownloadOrders","name":"Retrieve multiple download orders","isWebhook":false,"pointer":"/paths/~1api~1downloadorders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multiple download orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the download orders that the current user has access to."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_916","description":"The number of items to skip for pagination."}],"pointer":"/paths/~1api~1downloadorders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/downloadorders","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[{"name":"skip","in":"query","schemaId":"schema_916"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/downloadorders","href":"download-orders/downloadorders","openApiOperationId":"DownloadOrders","summary":"Retrieve multiple download orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderCollectionResource"}},"schemaId":"components/schemas/DownloadOrderCollectionResource"},{"code":"401","description":"Unauthorized request"},{"code":"404","description":"Download order not found or user not authorized"}],"pointer":"/paths/~1api~1downloadorders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadOrderCollectionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderCollectionResource"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-orders/downloadorders"}],"panels":[]}]},"httpPath":"/api/downloadorders"},{"label":"Create a download order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/download-orders-api/download-orders/adddownloadorders","routeSlug":"/ch/download-orders-api/download-orders/adddownloadorders","metadata":{"seo":{"title":"Create a download order","description":"Creates a download order for the specified assets using the defined download options."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddDownloadOrders","name":"Create a download order","isWebhook":false,"pointer":"/paths/~1api~1downloadorders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a download order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a download order for the specified assets using the defined download options."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"application/json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"text/json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"application/*+json":{"schemaId":"components/schemas/DownloadOrderRequestResource"}},"schemaId":"components/schemas/DownloadOrderRequestResource","pointer":"/paths/~1api~1downloadorders/post/requestBody","description":"A download order request that contains the order details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/downloadorders","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"application/json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"text/json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"application/*+json":{"schemaId":"components/schemas/DownloadOrderRequestResource"}},"responseCodes":["201","400","401"],"pointer":"/api/downloadorders","href":"download-orders/adddownloadorders","openApiOperationId":"AddDownloadOrders","summary":"Create a download order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/DownloadOrderRequestResource","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"application/json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"text/json":{"schemaId":"components/schemas/DownloadOrderRequestResource"},"application/*+json":{"schemaId":"components/schemas/DownloadOrderRequestResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderResource"}},"schemaId":"components/schemas/DownloadOrderResource"},{"code":"400","description":"Request not valid"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1downloadorders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/DownloadOrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderResource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-orders/adddownloadorders"}],"panels":[]}]},"httpPath":"/api/downloadorders"},{"label":"Retrieve a download order target","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/download-orders-api/download-orders/downloadordertargetsbyentityid","routeSlug":"/ch/download-orders-api/download-orders/downloadordertargetsbyentityid","metadata":{"seo":{"title":"Retrieve a download order target","description":"Retrieves a download order for the specified order and target ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DownloadOrderTargetsByEntityId","name":"Retrieve a download order target","isWebhook":false,"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets~1{entityId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a download order target","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a download order for the specified order and target ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_914","description":"The ID of the download order.","required":true},{"name":"entityId","in":"path","schemaId":"schema_914","description":"The ID of the target entity.","required":true}],"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets~1{entityId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/downloadorders/{orderId}/targets/{entityId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_914"},{"name":"entityId","in":"path","required":true,"schemaId":"schema_914"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/downloadorders/{orderId}/targets/{entityId}","href":"download-orders/downloadordertargetsbyentityid","openApiOperationId":"DownloadOrderTargetsByEntityId","summary":"Retrieve a download order target"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderTargetResource"}},"schemaId":"components/schemas/DownloadOrderTargetResource"},{"code":"401","description":"Unauthorized request"},{"code":"404","description":"Download order target not found or user not authorized"}],"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets~1{entityId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadOrderTargetResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderTargetResource"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-orders/downloadordertargetsbyentityid"}],"panels":[]}]},"httpPath":"/api/downloadorders/{orderId}/targets/{entityId}"},{"label":"Retrieve the download order targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/download-orders-api/download-orders/downloadordertargets","routeSlug":"/ch/download-orders-api/download-orders/downloadordertargets","metadata":{"seo":{"title":"Retrieve the download order targets","description":"Retrieves the download order targets for the specified order ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DownloadOrderTargets","name":"Retrieve the download order targets","isWebhook":false,"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the download order targets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the download order targets for the specified order ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_914","description":"The unique identifier of the order.","required":true}],"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_916","description":"The number of items to skip for pagination."}],"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/downloadorders/{orderId}/targets","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_914"}],"query":[{"name":"skip","in":"query","schemaId":"schema_916"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/downloadorders/{orderId}/targets","href":"download-orders/downloadordertargets","openApiOperationId":"DownloadOrderTargets","summary":"Retrieve the download order targets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderTargetCollectionResource"}},"schemaId":"components/schemas/DownloadOrderTargetCollectionResource"},{"code":"401","description":"Unauthorized request"},{"code":"404","description":"Download order targets not found or user not authorized"}],"pointer":"/paths/~1api~1downloadorders~1{orderId}~1targets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadOrderTargetCollectionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadOrderTargetCollectionResource"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-orders/downloadordertargets"}],"panels":[]}]},"httpPath":"/api/downloadorders/{orderId}/targets"}],"content":{"contentType":"group","meta":{"name":"Download orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download orders","showPageActions":true},{"nodeType":"markdoc","content":"A download order is a compressed file that contains media files along with the download order configuration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/downloadorders/{id}","summary":"Retrieve a download order with a specific ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-orders/downloadordersbyid","deprecated":false},{"title":"/api/downloadorders","summary":"Retrieve multiple download orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-orders/downloadorders","deprecated":false},{"title":"/api/downloadorders","summary":"Create a download order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/download-orders/adddownloadorders","deprecated":false},{"title":"/api/downloadorders/{orderId}/targets/{entityId}","summary":"Retrieve a download order target","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-orders/downloadordertargetsbyentityid","deprecated":false},{"title":"/api/downloadorders/{orderId}/targets","summary":"Retrieve the download order targets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-orders/downloadordertargets","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ConversionParameterResource":{"id":"components/schemas/ConversionParameterResource","kind":"json-schema","title":"ConversionParameterResource","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ProcessingParameter"},"value":{"$ref":"#/components/schemas/IProcessingParameterValue"}},"additionalProperties":false,"description":"Represents one processing option."}},"components/schemas/DownloadOrderCollectionResource":{"id":"components/schemas/DownloadOrderCollectionResource","kind":"json-schema","title":"DownloadOrderCollectionResource","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DownloadOrderResource"},"description":"Gets or sets the list of items.","nullable":true},"total_items":{"type":"integer","description":"Gets or sets the total number of items.","format":"int64","nullable":true},"returned_items":{"type":"integer","description":"Gets or sets the number of returned items.","format":"int64","nullable":true},"offset":{"type":"integer","description":"Gets or sets the offset of the items.","format":"int32","nullable":true},"next":{"$ref":"#/components/schemas/Link"},"previous":{"$ref":"#/components/schemas/Link"},"identifier":{"type":"string","description":"Gets or sets the identifier of the resource.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{},"description":"Represents a collection of download order resources."}},"components/schemas/DownloadOrderRequestResource":{"id":"components/schemas/DownloadOrderRequestResource","kind":"json-schema","title":"DownloadOrderRequestResource","data":{"required":["order"],"type":"object","properties":{"target_selection":{"$ref":"#/components/schemas/SelectionResource"},"item_name_resolver_id":{"type":"string","description":"The ID of the item name resolver.","nullable":true,"deprecated":true},"culture":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The culture code of the download order, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"name":{"type":"string","description":"The name of the download order.","nullable":true},"order":{"$ref":"#/components/schemas/OrderRequestResource"},"download_order_type":{"$ref":"#/components/schemas/DownloadOrderType"}},"additionalProperties":false}},"components/schemas/DownloadOrderResource":{"id":"components/schemas/DownloadOrderResource","kind":"json-schema","title":"DownloadOrderResource","data":{"type":"object","properties":{"order_id":{"type":"integer","description":"The ID of the download order.","format":"int64"},"name":{"type":"string","description":"The name of the download order.","nullable":true},"target_count":{"type":"integer","description":"The number of targets contained in the download order.","format":"int64"},"has_conversions":{"type":"boolean","description":"Whether the order contains converted files or not."},"created_by":{"$ref":"#/components/schemas/Link"},"created_on":{"type":"string","description":"The date the download order was created.","format":"date-time","nullable":true},"modified_by":{"$ref":"#/components/schemas/Link"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the download order, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"download_location":{"$ref":"#/components/schemas/Link"},"additional_info":{"type":"string","description":"Additional information about the download order.","nullable":true},"external_job_reference":{"$ref":"#/components/schemas/Link"},"targets":{"$ref":"#/components/schemas/Link"},"culture":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The culture code of the download order, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents a download order."}},"components/schemas/DownloadOrderTargetCollectionResource":{"id":"components/schemas/DownloadOrderTargetCollectionResource","kind":"json-schema","title":"DownloadOrderTargetCollectionResource","data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DownloadOrderTargetResource"},"description":"Gets or sets the list of items.","nullable":true},"total_items":{"type":"integer","description":"Gets or sets the total number of items.","format":"int64","nullable":true},"returned_items":{"type":"integer","description":"Gets or sets the number of returned items.","format":"int64","nullable":true},"offset":{"type":"integer","description":"Gets or sets the offset of the items.","format":"int32","nullable":true},"next":{"$ref":"#/components/schemas/Link"},"previous":{"$ref":"#/components/schemas/Link"},"identifier":{"type":"string","description":"Gets or sets the identifier of the resource.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{}}},"components/schemas/DownloadOrderTargetResource":{"id":"components/schemas/DownloadOrderTargetResource","kind":"json-schema","title":"DownloadOrderTargetResource","data":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/Link"},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false}},"components/schemas/DownloadOrderType":{"id":"components/schemas/DownloadOrderType","kind":"json-schema","title":"DownloadOrderType","data":{"enum":["Standard","Custom"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of order, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/IProcessingParameterValue":{"id":"components/schemas/IProcessingParameterValue","kind":"json-schema","title":"IProcessingParameterValue","data":{"type":"object","additionalProperties":false,"description":"Value for a processing parameter."}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string","description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"filename_properties":{"type":"array","items":{"type":"string"},"description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"title":{"type":"string","description":"Gets or sets the title that describes this link.","nullable":true},"templated":{"type":"boolean","description":"Gets or sets a value indicating whether the contained URI is a template.","default":false}},"additionalProperties":false,"description":"Represents a link to a resource."}},"components/schemas/OrderRequestResource":{"id":"components/schemas/OrderRequestResource","kind":"json-schema","title":"OrderRequestResource","data":{"type":"object","properties":{"zip_filename":{"type":"string","description":"The name of the ZIP file.","nullable":true},"global":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RequestResource"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration of what to download by asset media group. For example, the rendition "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MP4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all videos, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"medium"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all images. Asset media groups are identified by their ID."},"children":[]}]}]}],"nullable":true},"individual":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RequestResource"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration of what to download for individual assets. To use when willing to download something different for specific assets than for the rest of the assets of the same media group. For example, to download the rendition "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MP4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a video asset with ID 1234, while for all other videos, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Original"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rendition will be downloaded through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"global"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration."},"children":[]}]}]}],"nullable":true},"isEmpty":{"type":"boolean","description":"Whether the order is empty.","readOnly":true}},"additionalProperties":false,"description":"The configuration to create an order."}},"components/schemas/ProcessingParameter":{"id":"components/schemas/ProcessingParameter","kind":"json-schema","title":"ProcessingParameter","data":{"enum":["fileExtension","colorSpace","resolution","bitrate","aspectRatio","dimension","colorProfile","clippingPath","resizeLogic","width","height","simple","filename","cropping","preset","trimStart","trimEnd","focalPoint"],"type":"string","description":"List of file processing attributes."}},"components/schemas/RequestResource":{"id":"components/schemas/RequestResource","kind":"json-schema","title":"RequestResource","data":{"type":"object","properties":{"renditions":{"type":"array","items":{"type":"string"},"description":"The list of renditions to download.","nullable":true},"conversions":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/ConversionParameterResource"},"description":"Configuration for a conversion from an original file."},"description":"Configuration to create a new conversion from the original file for the download.","nullable":true},"user_rendition_configuration":{"$ref":"#/components/schemas/UserRenditionConfigurationResource"},"presets":{"type":"array","items":{"type":"string"},"description":"List of predefined settings for the download order.","nullable":true}},"additionalProperties":false,"description":"Configuration for the files to download either for an individual asset, or for all assets from the same media group."}},"components/schemas/SelectionResource":{"id":"components/schemas/SelectionResource","kind":"json-schema","title":"SelectionResource","data":{"type":"object","properties":{"selectionPool":{"type":"string","description":"The identifier of the selection pool that contains the entities to download.","nullable":true},"subPoolId":{"type":"integer","description":"When a selection pool is page specific, the ID of the entity on the page. For example, in the case of a selection pool for the assets in a collection, the ID of the collection.","format":"int64","nullable":true},"definitionName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The definition name of the download order items, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M.Asset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Describes what selection pool to use for an order. The selection pool contains the list of entities to download."}},"components/schemas/UserRenditionConfigurationResource":{"id":"components/schemas/UserRenditionConfigurationResource","kind":"json-schema","title":"UserRenditionConfigurationResource","data":{"type":"object","properties":{"label":{"type":"string","description":"The label for the user rendition.","nullable":true},"culture":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The culture code of the user rendition, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"description":{"type":"string","description":"A description of the user rendition.","nullable":true}},"additionalProperties":false,"description":"Configuration to create a user rendition from the first conversion."}},"schema_914":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_914"},"schema_915":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_915"},"schema_916":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_916"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/ch/download-orders-api/index.json?download"},{"url":"/_bundle/ch/download-orders-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Download orders API","description":"Use the Download orders API to create and retrieve download orders. A download order is a compressed file that contains media files, such as images, vectors, or videos.\n## Authentication\nTo use the Download orders API, you need:\n- The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.\n- An access token and the client ID. Both are sent with every request. You can create a token through the [Content Hub interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) or by [requesting one using the API itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#making-requests)\n","product":"Content Hub"}},"baseSlug":"/ch/download-orders-api","routesMapping":{}}