GET /background-asset-upload-files/{backgroundAssetUploadFileId}Copy
Proposed · Extended read design · Adapter not implemented
Request Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.
cURL JavaScript Python
cURL Copy
BASE='https://asc.example.com/v1/connections/conn_example'
curl --fail-with-body "$BASE/background-asset-upload-files/background_asset_upload_file_123" \
-H "Authorization: Bearer $ASC_FACADE_KEY"JavaScript Copy
const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/background-asset-upload-files/background_asset_upload_file_123`, {
headers: { Authorization: `Bearer ${process.env.ASC_FACADE_KEY}` }
});
const body = await response.json();
if (!response.ok) {
throw new Error(body.error?.message ?? `HTTP ${response.status}`);
}
console.log(body);Python Copy
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError
base = "https://asc.example.com/v1/connections/conn_example"
request = Request(
f"{base}/background-asset-upload-files/background_asset_upload_file_123",
headers={"Authorization": f"Bearer {os.environ['ASC_FACADE_KEY']}"},
)
try:
with urlopen(request) as response:
print(json.load(response))
except HTTPError as error:
detail = json.load(error)
raise RuntimeError(detail["error"]["message"]) from errorasc.example.com is a placeholder for your deployment. Examples use fictional IDs.
Path parameters Name Type Description backgroundAssetUploadFileId Required stringThe selected resource’s ID.
Query parameters Name Type Description fields Optional stringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.Values assetDeliveryState, assetToken, assetType, fileName, fileSize, sourceFileChecksums, uploadOperations
Response One flat object for the selected resource.
200 · application/json Copy
{
"id" : "background_asset_upload_file_123" ,
"assetDeliveryState" : {
"errors" : [
{
"code" : "EXAMPLE-OFFER-CODE" ,
"description" : "Keep your notes organized."
}
],
"warnings" : [
{
"code" : "EXAMPLE-OFFER-CODE" ,
"description" : "Keep your notes organized."
}
],
"state" : "AWAITING_UPLOAD"
},
"assetToken" : "asset_token_example" ,
"assetType" : "ASSET" ,
"fileName" : "screenshot.png" ,
"fileSize" : 184320
}Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.
Response fields Name Type Description id stringApple’s resource ID. Keep this string unchanged when addressing a resource. assetDeliveryState objectThe delivery state and any processing issues Apple reports for this asset. assetToken stringThe asset token value reported by Apple for this resource. assetType stringThe asset type value reported by Apple for this resource.Values ASSET, MANIFEST fileName stringThe uploaded file’s name. fileSize integer · int64The file size in bytes. sourceFileChecksums objectThe source file checksums value reported by Apple for this resource. uploadOperations object[]Apple’s recorded upload-operation metadata. A GET does not perform these operations.
assetDeliveryState fields Name Type Description errors Optional object[]The errors value reported by Apple for this resource. warnings Optional object[]The warnings value reported by Apple for this resource. state Optional stringThe current state reported by Apple for this resource.Values AWAITING_UPLOAD, UPLOAD_COMPLETE, COMPLETE, FAILED
assetDeliveryState.errors fields Name Type Description code Optional stringThe code value reported by Apple for this resource. description Optional stringThe localized store description.
assetDeliveryState.warnings fields Name Type Description code Optional stringThe code value reported by Apple for this resource. description Optional stringThe localized store description.
sourceFileChecksums fields Name Type Description file Optional objectThe file value reported by Apple for this resource. composite Optional objectThe composite value reported by Apple for this resource.
sourceFileChecksums.file fields Name Type Description hash Optional stringThe hash value reported by Apple for this resource. algorithm Optional stringThe algorithm value reported by Apple for this resource.Values MD5, SHA_256
sourceFileChecksums.composite fields Name Type Description hash Optional stringThe hash value reported by Apple for this resource. algorithm Optional stringThe algorithm value reported by Apple for this resource.Values MD5
uploadOperations fields Name Type Description method Optional stringThe method value reported by Apple for this resource. url Optional stringThe url value reported by Apple for this resource. length Optional integer · int64The length value reported by Apple for this resource. offset Optional integer · int64The offset value reported by Apple for this resource. requestHeaders Optional object[]The request headers value reported by Apple for this resource. expiration Optional string · date-timeExpiration, as an RFC 3339 timestamp. partNumber Optional integer · int64The part number value reported by Apple for this resource. entityTag Optional stringThe entity tag value reported by Apple for this resource.
uploadOperations.requestHeaders fields Name Type Description name Optional stringThe resource’s name. An app’s localized name is read from its app-info localization. value Optional stringThe value value reported by Apple for this resource.
Behavior A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data. Errors HTTP Type Description 400 invalid_queryUnsupported filter, sort, limit, or cursor. 401 unauthorizedMissing or invalid facade API key. 403 forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource. 404 resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope. 429 rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned. 502–504 upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.
Apple mapping Upstream route and translation The adapter calls GET /v1/backgroundAssetUploadFiles/{id}. Read Apple’s original endpoint ↗
Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.
Facade parameter Type Description fields queryfields[backgroundAssetUploadFiles]
Reviewed 2026-10-14 · OpenAPI 4.5.1