Parsequerade / docs
Background assets
GET/background-asset-versions/{backgroundAssetVersionId}

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
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/background-asset-versions/background_asset_version_123" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
backgroundAssetVersionIdRequiredstringThe selected resource’s ID.

Query parameters

NameTypeDescription
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuescreatedDate, platforms, state, stateDetails, version, locale

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "background_asset_version_123",
  "createdDate": "2026-10-14T12:00:00Z",
  "platforms": [
    "IOS"
  ],
  "state": "AWAITING_UPLOAD",
  "stateDetails": {
    "errors": [
      {
        "code": "EXAMPLE-OFFER-CODE",
        "description": "Keep your notes organized."
      }
    ],
    "warnings": [
      {
        "code": "EXAMPLE-OFFER-CODE",
        "description": "Keep your notes organized."
      }
    ],
    "infos": [
      {
        "code": "EXAMPLE-OFFER-CODE",
        "description": "Keep your notes organized."
      }
    ]
  },
  "version": "42",
  "locale": "en-US"
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
createdDatestring · date-timeWhen Apple created this resource, as an RFC 3339 timestamp.
platformsstring[]The platforms value reported by Apple for this resource.
ValuesIOS, MAC_OS, TV_OS, VISION_OS
statestringThe current state reported by Apple for this resource.
ValuesAWAITING_UPLOAD, PROCESSING, FAILED, COMPLETE
stateDetailsobjectThe state details value reported by Apple for this resource.
versionstringThe uploaded build’s version string; this is separate from the store versionString.
localestringThe exact Apple locale identifier, such as en-US.
backgroundAssetIdOptional linkagestring | nullID of the related background asset. Present only when Apple supplies linkage; related objects are not loaded automatically.
internalBetaReleaseIdOptional linkagestring | nullID of the related internal beta release. Present only when Apple supplies linkage; related objects are not loaded automatically.
externalBetaReleaseIdOptional linkagestring | nullID of the related external beta release. Present only when Apple supplies linkage; related objects are not loaded automatically.
appStoreReleaseIdOptional linkagestring | nullID of the related app store release. Present only when Apple supplies linkage; related objects are not loaded automatically.
assetFileIdOptional linkagestring | nullID of the related asset file. Present only when Apple supplies linkage; related objects are not loaded automatically.
manifestFileIdOptional linkagestring | nullID of the related manifest file. Present only when Apple supplies linkage; related objects are not loaded automatically.
stateDetails fields
NameTypeDescription
errorsOptionalobject[]The errors value reported by Apple for this resource.
warningsOptionalobject[]The warnings value reported by Apple for this resource.
infosOptionalobject[]The infos value reported by Apple for this resource.
stateDetails.errors fields
NameTypeDescription
codeOptionalstringThe code value reported by Apple for this resource.
descriptionOptionalstringThe localized store description.
stateDetails.warnings fields
NameTypeDescription
codeOptionalstringThe code value reported by Apple for this resource.
descriptionOptionalstringThe localized store description.
stateDetails.infos fields
NameTypeDescription
codeOptionalstringThe code value reported by Apple for this resource.
descriptionOptionalstringThe 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

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream 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/backgroundAssetVersions/{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 parameterTypeDescription
fieldsqueryfields[backgroundAssetVersions]

Reviewed 2026-10-14 · OpenAPI 4.5.1