openapi: 3.0.1 info: title: App Store Connect AccessibilityDeclarations BackgroundAssets API version: 4.3.1 x-platforms: app_store_connect_api: App Store Connect API description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries. servers: - url: https://api.appstoreconnect.apple.com/ security: - itc-bearer-token: [] tags: - name: BackgroundAssets paths: /v1/backgroundAssets: post: tags: - BackgroundAssets operationId: backgroundAssets_createInstance requestBody: description: BackgroundAsset representation content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetCreateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '201': description: Single BackgroundAsset content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Create Background Assets /v1/backgroundAssets/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - BackgroundAssets operationId: backgroundAssets_getInstance parameters: - name: fields[backgroundAssets] in: query description: the fields to include for returned resources of type backgroundAssets schema: type: array items: type: string enum: - archived - assetPackIdentifier - createdDate - usedBytes - app - versions - appStoreVersion - internalBetaVersion - externalBetaVersion style: form explode: false required: false - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false required: false - name: fields[backgroundAssetVersions] in: query description: the fields to include for returned resources of type backgroundAssetVersions schema: type: array items: type: string enum: - createdDate - platforms - state - stateDetails - version - backgroundAsset - internalBetaRelease - externalBetaRelease - appStoreRelease - assetFile - manifestFile - backgroundAssetUploadFiles style: form explode: false required: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - app - appStoreVersion - internalBetaVersion - externalBetaVersion style: form explode: false required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single BackgroundAsset content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Background Assets patch: tags: - BackgroundAssets operationId: backgroundAssets_updateInstance requestBody: description: BackgroundAsset representation content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetUpdateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single BackgroundAsset content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Update Background Assets /v1/backgroundAssets/{id}/relationships/versions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - BackgroundAssets operationId: backgroundAssets_versions_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetVersionsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Background Assets / Versions /v1/backgroundAssets/{id}/versions: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - BackgroundAssets operationId: backgroundAssets_versions_getToManyRelated parameters: - name: filter[platforms] in: query description: filter by attribute 'platforms' schema: type: array items: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS style: form explode: false - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - AWAITING_UPLOAD - PROCESSING - FAILED - COMPLETE style: form explode: false - name: filter[version] in: query description: filter by attribute 'version' schema: type: array items: type: string style: form explode: false - name: filter[internalBetaRelease.state] in: query description: filter by attribute 'internalBetaRelease.state' schema: type: array items: type: string enum: - READY_FOR_TESTING - SUPERSEDED style: form explode: false - name: filter[externalBetaRelease.state] in: query description: filter by attribute 'externalBetaRelease.state' schema: type: array items: type: string enum: - READY_FOR_BETA_SUBMISSION - WAITING_FOR_REVIEW - IN_REVIEW - REJECTED - PROCESSING_FOR_TESTING - READY_FOR_TESTING - SUPERSEDED style: form explode: false - name: filter[appStoreRelease.state] in: query description: filter by attribute 'appStoreRelease.state' schema: type: array items: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - REJECTED - PROCESSING_FOR_DISTRIBUTION - READY_FOR_DISTRIBUTION - SUPERSEDED style: form explode: false - name: sort in: query description: comma-separated list of sort expressions; resources will be sorted as specified schema: type: array items: type: string enum: - version - -version style: form explode: false - name: fields[backgroundAssetVersions] in: query description: the fields to include for returned resources of type backgroundAssetVersions schema: type: array items: type: string enum: - createdDate - platforms - state - stateDetails - version - backgroundAsset - internalBetaRelease - externalBetaRelease - appStoreRelease - assetFile - manifestFile - backgroundAssetUploadFiles style: form explode: false - name: fields[backgroundAssets] in: query description: the fields to include for returned resources of type backgroundAssets schema: type: array items: type: string enum: - archived - assetPackIdentifier - createdDate - usedBytes - app - versions - appStoreVersion - internalBetaVersion - externalBetaVersion style: form explode: false - name: fields[backgroundAssetVersionInternalBetaReleases] in: query description: the fields to include for returned resources of type backgroundAssetVersionInternalBetaReleases schema: type: array items: type: string enum: - state - backgroundAssetVersion style: form explode: false - name: fields[backgroundAssetVersionExternalBetaReleases] in: query description: the fields to include for returned resources of type backgroundAssetVersionExternalBetaReleases schema: type: array items: type: string enum: - state - backgroundAssetVersion style: form explode: false - name: fields[backgroundAssetVersionAppStoreReleases] in: query description: the fields to include for returned resources of type backgroundAssetVersionAppStoreReleases schema: type: array items: type: string enum: - state - backgroundAssetVersion style: form explode: false - name: fields[backgroundAssetUploadFiles] in: query description: the fields to include for returned resources of type backgroundAssetUploadFiles schema: type: array items: type: string enum: - assetDeliveryState - assetToken - assetType - fileName - fileSize - sourceFileChecksum - sourceFileChecksums - uploadOperations style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - backgroundAsset - internalBetaRelease - externalBetaRelease - appStoreRelease - assetFile - manifestFile style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BackgroundAssetVersions content: application/json: schema: $ref: '#/components/schemas/BackgroundAssetVersionsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Background Assets / Versions components: schemas: PagedDocumentLinks: type: object properties: self: type: string format: uri-reference first: type: string format: uri-reference next: type: string format: uri-reference required: - self ResourceLinks: type: object properties: self: type: string format: uri-reference BackgroundAssetResponse: type: object title: BackgroundAssetResponse properties: data: $ref: '#/components/schemas/BackgroundAsset' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/BackgroundAssetVersion' discriminator: propertyName: type mapping: backgroundAssetVersions: '#/components/schemas/BackgroundAssetVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ErrorSourceParameter: type: object title: Parameter properties: parameter: type: string required: - parameter ErrorLinks: type: object properties: about: type: string format: uri-reference associated: oneOf: - type: string format: uri-reference - type: object properties: href: type: string format: uri-reference meta: type: object properties: source: type: string StateDetail: type: object properties: code: type: string description: type: string BackgroundAssetVersionExternalBetaRelease: type: object title: BackgroundAssetVersionExternalBetaRelease properties: type: type: string enum: - backgroundAssetVersionExternalBetaReleases id: type: string attributes: type: object properties: state: $ref: '#/components/schemas/BackgroundAssetVersionExternalBetaReleaseState' relationships: type: object properties: backgroundAssetVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppMediaAssetState: type: object properties: errors: type: array items: $ref: '#/components/schemas/AppMediaStateError' warnings: type: array items: $ref: '#/components/schemas/AppMediaStateError' state: type: string enum: - AWAITING_UPLOAD - UPLOAD_COMPLETE - COMPLETE - FAILED BackgroundAssetVersionAppStoreRelease: type: object title: BackgroundAssetVersionAppStoreRelease properties: type: type: string enum: - backgroundAssetVersionAppStoreReleases id: type: string attributes: type: object properties: state: $ref: '#/components/schemas/BackgroundAssetVersionAppStoreReleaseState' relationships: type: object properties: backgroundAssetVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type Platform: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS BackgroundAssetCreateRequest: type: object title: BackgroundAssetCreateRequest properties: data: type: object properties: type: type: string enum: - backgroundAssets attributes: type: object properties: assetPackIdentifier: type: string required: - assetPackIdentifier relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type required: - data required: - app required: - relationships - attributes - type required: - data DocumentLinks: type: object properties: self: type: string format: uri-reference required: - self BackgroundAssetVersionsResponse: type: object title: BackgroundAssetVersionsResponse properties: data: type: array items: $ref: '#/components/schemas/BackgroundAssetVersion' included: type: array items: oneOf: - $ref: '#/components/schemas/BackgroundAssetUploadFile' - $ref: '#/components/schemas/BackgroundAssetVersionAppStoreRelease' - $ref: '#/components/schemas/BackgroundAssetVersionExternalBetaRelease' - $ref: '#/components/schemas/BackgroundAssetVersionInternalBetaRelease' - $ref: '#/components/schemas/BackgroundAsset' discriminator: propertyName: type mapping: backgroundAssetVersionAppStoreReleases: '#/components/schemas/BackgroundAssetVersionAppStoreRelease' backgroundAssetVersionInternalBetaReleases: '#/components/schemas/BackgroundAssetVersionInternalBetaRelease' backgroundAssets: '#/components/schemas/BackgroundAsset' backgroundAssetUploadFiles: '#/components/schemas/BackgroundAssetUploadFile' backgroundAssetVersionExternalBetaReleases: '#/components/schemas/BackgroundAssetVersionExternalBetaRelease' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links Checksums: type: object properties: file: type: object properties: hash: type: string algorithm: $ref: '#/components/schemas/ChecksumAlgorithm' composite: type: object properties: hash: type: string algorithm: type: string enum: - MD5 BackgroundAssetVersionExternalBetaReleaseState: type: string enum: - READY_FOR_BETA_SUBMISSION - WAITING_FOR_REVIEW - IN_REVIEW - REJECTED - PROCESSING_FOR_TESTING - READY_FOR_TESTING - SUPERSEDED ErrorResponse: type: object properties: errors: type: array items: type: object properties: id: type: string status: type: string code: type: string title: type: string detail: type: string source: oneOf: - $ref: '#/components/schemas/ErrorSourcePointer' - $ref: '#/components/schemas/ErrorSourceParameter' links: $ref: '#/components/schemas/ErrorLinks' meta: type: object additionalProperties: {} required: - code - detail - status - title BackgroundAssetVersionInternalBetaRelease: type: object title: BackgroundAssetVersionInternalBetaRelease properties: type: type: string enum: - backgroundAssetVersionInternalBetaReleases id: type: string attributes: type: object properties: state: type: string enum: - READY_FOR_TESTING - SUPERSEDED relationships: type: object properties: backgroundAssetVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BackgroundAssetVersionState: type: string enum: - AWAITING_UPLOAD - PROCESSING - FAILED - COMPLETE App: type: object title: App properties: type: type: string enum: - apps id: type: string attributes: type: object properties: accessibilityUrl: type: string format: uri name: type: string bundleId: type: string sku: type: string primaryLocale: type: string isOrEverWasMadeForKids: type: boolean subscriptionStatusUrl: type: string format: uri subscriptionStatusUrlVersion: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' subscriptionStatusUrlForSandbox: type: string format: uri subscriptionStatusUrlVersionForSandbox: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' contentRightsDeclaration: type: string enum: - DOES_NOT_USE_THIRD_PARTY_CONTENT - USES_THIRD_PARTY_CONTENT streamlinedPurchasingEnabled: type: boolean relationships: type: object properties: accessibilityDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appEncryptionDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type appStoreIcon: type: object properties: data: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type ciProduct: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - ciProducts id: type: string required: - id - type betaTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type appStoreVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appTags: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' preReleaseVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type betaAppLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaAppLocalizations id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type betaLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaLicenseAgreements id: type: string required: - id - type betaAppReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewDetails id: type: string required: - id - type appInfos: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type appClips: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type appPricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' endUserLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - endUserLicenseAgreements id: type: string required: - id - type appPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appAvailabilityV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' inAppPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type deprecated: true subscriptionGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type gameCenterEnabledVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterEnabledVersions id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appCustomProductPages: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type inAppPurchasesV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type promotedPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type appEvents: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type reviewSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - reviewSubmissions id: type: string required: - id - type subscriptionGracePeriod: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionGracePeriods id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' customerReviewSummarizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' gameCenterDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type alternativeDistributionKey: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' analyticsReportRequests: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' marketplaceSearchDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' buildUploads: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' backgroundAssets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackScreenshotSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackCrashSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' webhooks: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' androidToIosAppMappingDetails: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type RelationshipLinks: type: object properties: self: type: string format: uri-reference related: type: string format: uri-reference SubscriptionStatusUrlVersion: type: string enum: - V1 - V2 ChecksumAlgorithm: type: string enum: - MD5 - SHA_256 BackgroundAsset: type: object title: BackgroundAsset properties: type: type: string enum: - backgroundAssets id: type: string attributes: type: object properties: archived: type: boolean assetPackIdentifier: type: string createdDate: type: string format: date-time usedBytes: type: integer format: int64 maximum: 9007199254740991 minimum: 0 relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type versions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type internalBetaVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type externalBetaVersion: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BackgroundAssetUpdateRequest: type: object title: BackgroundAssetUpdateRequest properties: data: type: object properties: type: type: string enum: - backgroundAssets id: type: string attributes: type: object properties: archived: type: boolean nullable: true required: - id - type required: - data BackgroundAssetVersionAppStoreReleaseState: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - REJECTED - PROCESSING_FOR_DISTRIBUTION - READY_FOR_DISTRIBUTION - SUPERSEDED BackgroundAssetVersion: type: object title: BackgroundAssetVersion properties: type: type: string enum: - backgroundAssetVersions id: type: string attributes: type: object properties: createdDate: type: string format: date-time platforms: type: array items: $ref: '#/components/schemas/Platform' state: $ref: '#/components/schemas/BackgroundAssetVersionState' stateDetails: type: object properties: errors: type: array items: $ref: '#/components/schemas/StateDetail' warnings: type: array items: $ref: '#/components/schemas/StateDetail' infos: type: array items: $ref: '#/components/schemas/StateDetail' version: type: string relationships: type: object properties: backgroundAsset: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssets id: type: string required: - id - type internalBetaRelease: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersionInternalBetaReleases id: type: string required: - id - type externalBetaRelease: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersionExternalBetaReleases id: type: string required: - id - type appStoreRelease: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetVersionAppStoreReleases id: type: string required: - id - type assetFile: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetUploadFiles id: type: string required: - id - type manifestFile: type: object properties: data: type: object properties: type: type: string enum: - backgroundAssetUploadFiles id: type: string required: - id - type backgroundAssetUploadFiles: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorSourcePointer: type: object title: JsonPointer properties: pointer: type: string required: - pointer BackgroundAssetVersionsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - backgroundAssetVersions id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links PagingInformation: type: object properties: paging: type: object properties: total: type: integer limit: type: integer nextCursor: type: string required: - limit required: - paging BackgroundAssetUploadFile: type: object title: BackgroundAssetUploadFile properties: type: type: string enum: - backgroundAssetUploadFiles id: type: string attributes: type: object properties: assetDeliveryState: $ref: '#/components/schemas/AppMediaAssetState' assetToken: type: string assetType: type: string enum: - ASSET - MANIFEST fileName: type: string fileSize: type: integer format: int64 maximum: 9007199254740991 minimum: 1 sourceFileChecksum: type: string deprecated: true sourceFileChecksums: $ref: '#/components/schemas/Checksums' uploadOperations: type: array items: $ref: '#/components/schemas/DeliveryFileUploadOperation' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type DeliveryFileUploadOperation: type: object properties: method: type: string url: type: string length: type: integer format: int64 maximum: 9007199254740991 minimum: 1 offset: type: integer format: int64 maximum: 9007199254740991 minimum: 0 requestHeaders: type: array items: $ref: '#/components/schemas/HttpHeader' expiration: type: string format: date-time partNumber: type: integer format: int64 maximum: 9007199254740991 minimum: 1 entityTag: type: string AppMediaStateError: type: object properties: code: type: string description: type: string HttpHeader: type: object properties: name: type: string value: type: string securitySchemes: itc-bearer-token: type: http scheme: bearer bearerFormat: JWT