GET /previews/{previewId}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/previews/preview_123" \
-H "Authorization: Bearer $ASC_FACADE_KEY"JavaScript Copy
const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/previews/preview_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}/previews/preview_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 previewId 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 fileSize, fileName, sourceFileChecksum, previewFrameTimeCode, mimeType, videoUrl, previewFrameImage, uploadOperations, videoDeliveryState
Response One flat object for the selected resource.
200 · application/json Copy
{
"id" : "app_preview_123" ,
"fileSize" : 184320 ,
"fileName" : "screenshot.png" ,
"sourceFileChecksum" : "source_file_checksum_example" ,
"previewFrameTimeCode" : "preview_frame_time_code_example" ,
"mimeType" : "mime_type_example"
}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. fileSize integerThe file size in bytes. fileName stringThe uploaded file’s name. sourceFileChecksum stringThe checksum Apple records for the uploaded source file. previewFrameTimeCode stringThe preview frame time code value reported by Apple for this resource. mimeType stringThe mime type value reported by Apple for this resource. videoUrl stringThe video url value reported by Apple for this resource. previewFrameImage objectThe preview frame image value reported by Apple for this resource. uploadOperations object[]Apple’s recorded upload-operation metadata. A GET does not perform these operations. videoDeliveryState objectThe video delivery state value reported by Apple for this resource. appPreviewSetId Optional linkage string | nullID of the related app preview set. Present only when Apple supplies linkage; related objects are not loaded automatically.
previewFrameImage fields Name Type Description image Optional objectThe image value reported by Apple for this resource. state Optional objectThe current state reported by Apple for this resource.
previewFrameImage.image fields Name Type Description templateUrl Optional stringThe template url value reported by Apple for this resource. width Optional integerThe width value reported by Apple for this resource. height Optional integerThe height value reported by Apple for this resource.
previewFrameImage.state 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 PROCESSING, COMPLETE, FAILED
previewFrameImage.state.errors fields Name Type Description code Optional stringThe code value reported by Apple for this resource. description Optional stringThe localized store description.
previewFrameImage.state.warnings fields Name Type Description code Optional stringThe code value reported by Apple for this resource. description Optional stringThe localized store description.
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 integerThe length value reported by Apple for this resource. offset Optional integerThe offset value reported by Apple for this resource. requestHeaders Optional object[]The request headers 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.
videoDeliveryState 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, PROCESSING, COMPLETE, FAILED
videoDeliveryState.errors fields Name Type Description code Optional stringThe code value reported by Apple for this resource. description Optional stringThe localized store description.
videoDeliveryState.warnings fields Name Type Description code Optional stringThe code value reported by Apple for this resource. description Optional stringThe localized store description.
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/appPreviews/{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[appPreviews]
Reviewed 2026-10-14 · OpenAPI 4.5.1