{"openapi":"3.0.1","info":{"title":"External assets library","description":"The External assets library allows you to utilize assets stored in external locations without uploading them to Bluestone PIM. You can organize and link different types of assets to products, including images, music, videos, and documents.\n <b><h1>Deprecated endpoints:</h1></b><table border=\"1px;\"><tr><th style=\"text-align: center; vertical-align: middle;\"><b><h3>Uri</b></h3></th><th><b>Method</b></th><th><b><h3>Since</h3></b></th><th><b><h3>End of life</h3></b></th></tr></table>","version":"1-apps"},"servers":[{"url":"api.test.bluestonepim.com/external-media"}],"tags":[{"name":"Media assets","description":"Manage media assets."},{"name":"Media attribute","description":"Manage media attributes."},{"name":"Media category","description":"Manage media categories."},{"name":"Media product","description":"Manage media products."},{"name":"Metadata","description":"update metadata to Papi Sync"}],"paths":{"/assets/bulk":{"post":{"tags":["Media assets"],"summary":"Bulk create new assets.","operationId":"bulkCreateAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateMediaAssetRequest"}}}},"responses":{"201":{"description":"Assets bulk created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateMediaAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot bulk create asset"}},"security":[{"oauth2":[]}]}},"/assets":{"get":{"tags":["Media assets"],"summary":"List media assets.","description":"The External assets library allows you to utilize assets stored in external locations without uploading them to Bluestone PIM. You can organize and link different types of assets to products, including images, music, videos, and documents.","operationId":"searchMediaAsset","parameters":[{"name":"searchKeyword","in":"query","description":"Keyword for searching.","schema":{"type":"string","default":""}},{"name":"exactMatch","in":"query","description":"Exactly match with keyword.","schema":{"type":"boolean"}},{"name":"sortReverse","in":"query","description":"Sort reverse.","schema":{"title":"Sort reverse.","type":"integer","format":"int32","default":0}},{"name":"sortKey","in":"query","description":"Sort key.","schema":{"title":"Sort key.","type":"string","default":"title"}},{"name":"page","in":"query","description":"Page.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"maximum":100,"type":"integer","format":"int32","default":20}},{"name":"status","in":"query","description":"Status of asset.","schema":{"type":"string","default":"active"}},{"name":"externalNumber","in":"query","description":"Asset number.","schema":{"type":"string"}}],"responses":{"200":{"description":"Media Asset listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMediaAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Cannot list media asset"}},"security":[{"oauth2":[]}]},"post":{"tags":["Media assets"],"summary":"Create a new asset.","operationId":"createAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMediaAssetRequest"}}}},"responses":{"201":{"description":"Asset created","headers":{"Resource-Id":{"description":"Created asset ID.","style":"simple","schema":{"type":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable request"},"500":{"description":"Cannot create asset"}},"security":[{"oauth2":[]}]}},"/assets/{id}":{"get":{"tags":["Media assets"],"summary":"Get asset from ID.","operationId":"getMediaAsset","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Media Asset described","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"put":{"tags":["Media assets"],"summary":"Update asset.","operationId":"updateAsset","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMediaAssetRequest"}}}},"responses":{"200":{"description":"Asset updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Media asset not found"},"500":{"description":"Cannot update asset"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Media assets"],"summary":"Delete asset by ID.","operationId":"deleteMediaAsset","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Media asset deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Media asset not found"}},"security":[{"oauth2":[]}]}},"/assets/filter":{"post":{"tags":["Media assets"],"summary":"Filter asset from External Media Library.","operationId":"filterMediaAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterMediaAssetRequest"}}}},"responses":{"200":{"description":"Media Asset listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMediaAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Cannot list media asset"}},"security":[{"oauth2":[]}]}},"/assets/{id}/categories":{"get":{"tags":["Media assets"],"summary":"Get associated categories of given asset ID.","operationId":"getCategoriesByAsset","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Categories listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCategoryDataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Categories not found"}},"security":[{"oauth2":[]}]},"put":{"tags":["Media attribute"],"summary":"Replace categories to asset.","operationId":"replaceCategories","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCategoriesRequest"}}}},"responses":{"200":{"description":"Categories are replaced to asset","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetCategoriesResponse"}}}}},"204":{"description":"Empty product list request and remove all products in asset"},"207":{"description":"Some categories are linked but found errors for some categories","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetCategoriesResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset"}},"security":[{"oauth2":[]}]}},"/assets/externalNumber/{externalNumber}":{"get":{"tags":["Media assets"],"summary":"Get asset by External number.","operationId":"getMediaAssetByExternalNumber","parameters":[{"name":"externalNumber","in":"path","description":"External Number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Media Asset described","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found media asset"}},"security":[{"oauth2":[]}]}},"/assets/{id}/products":{"get":{"tags":["Media assets"],"summary":"Get associated product of given asset ID.","operationId":"getProductsByAsset","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Product listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductDataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product not found"}},"security":[{"oauth2":[]}]},"put":{"tags":["Media attribute"],"summary":"Replace products to asset.","operationId":"replaceProducts","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetProductsRequest"}}}},"responses":{"200":{"description":"Products are linked to asset","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetProductsResponse"}}}}},"204":{"description":"Empty product list request and remove all products in asset"},"207":{"description":"Some products are linked but found errors for some products","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetProductsResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset"}},"security":[{"oauth2":[]}]}},"/assets/{id}/categories/{categoryId}":{"post":{"tags":["Media attribute"],"summary":"Link asset to category.","operationId":"linkCategory","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assets category updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCategoryResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset category for update"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Media attribute"],"summary":"Unlink asset from category.","operationId":"unlinkCategory","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assets category removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCategoryResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset category for remove"}},"security":[{"oauth2":[]}]}},"/assets/{id}/labels":{"post":{"tags":["Media attribute"],"summary":"Link labels to asset.","operationId":"linkLabels","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetLabelsRequest"}}}},"responses":{"200":{"description":"Assets labels are linked","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetLabelsResponse"}}}}},"207":{"description":"Some assets labels are linked but found errors for some labels","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetLabelsResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset or labels"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Media attribute"],"summary":"Unlink labels to asset.","operationId":"unlinkLabels","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetLabelsRequest"}}}},"responses":{"200":{"description":"Assets labels removed","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateAssetsListAttributeResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset for remove labels"},"500":{"description":"Cannot remove asset labels"}},"security":[{"oauth2":[]}]}},"/assets/{id}/products/{productId}":{"post":{"tags":["Media attribute"],"summary":"Link product to asset.","operationId":"linkProduct","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assets product updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetProductResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset product for update"},"500":{"description":"Cannot link asset product"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Media attribute"],"summary":"Unlink product from asset.","operationId":"unlinkProduct","parameters":[{"name":"id","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assets product removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetProductResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found asset product for remove"},"500":{"description":"Cannot unlink asset product"}},"security":[{"oauth2":[]}]}},"/category/{categoryId}/assets":{"get":{"tags":["Media category"],"summary":"Get asset for category.","operationId":"getAssetsByCategory","parameters":[{"name":"categoryId","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get asset successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaAssetCategoryResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Category not found"}},"security":[{"oauth2":[]}]},"put":{"tags":["Media category"],"summary":"Replace asset for category.","operationId":"replaceAssetsByCategory","parameters":[{"name":"categoryId","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceCategoryAssetRequest"}}}},"responses":{"200":{"description":"Replace asset successful"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Category not found"}},"security":[{"oauth2":[]}]}},"/category/metadata/external-media":{"get":{"tags":["Media category"],"summary":"Get category media assets that modified after a given time.","operationId":"getCategoryMetaData","parameters":[{"name":"updatedAfter","in":"query","description":"Time stamp.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"maximum":100,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Get metadata successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaMetaDataResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/category/metadata/external-media/{categoryId}":{"get":{"tags":["Media category"],"summary":"Get external media metadata by category ID.","operationId":"getMetaDataByCategory","parameters":[{"name":"categoryId","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get metadata successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaAssetCategoryResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get metadata"}},"security":[{"oauth2":[]}]}},"/category/{categoryId}/assets/{assetId}":{"put":{"tags":["Media category"],"summary":"Sort category asset index.","operationId":"sortAsset","parameters":[{"name":"categoryId","in":"path","description":"Category ID.","required":true,"schema":{"type":"string"}},{"name":"assetId","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}},{"name":"sortIndex","in":"query","description":"Sort index.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Upsert asset successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SortedAttributeAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/product/{productId}/assets":{"get":{"tags":["Media product"],"summary":"Get asset for product.","operationId":"getMediaAssetByProduct","parameters":[{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get asset successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaAssetProductResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product not found"}},"security":[{"oauth2":[]}]},"put":{"tags":["Media product"],"summary":"Replace product asset.","operationId":"upsertProductAssets","parameters":[{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceProductAssetRequest"}}}},"responses":{"204":{"description":"Upsert asset successful"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Category not found"}},"security":[{"oauth2":[]}]}},"/product/metadata/external-media":{"get":{"tags":["Media product"],"summary":"Get media assets that modified after a given time.","operationId":"getMetaData","parameters":[{"name":"updatedAfter","in":"query","description":"Time stamp.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"maximum":100,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Get metadata successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaAssetProductResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get metadata"}},"security":[{"oauth2":[]}]}},"/product/metadata/external-media/{productId}":{"get":{"tags":["Media product"],"summary":"Get external media metadata by product ID.","operationId":"getMetaDataByProduct","parameters":[{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get metadata successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaAssetProductResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get metadata"}},"security":[{"oauth2":[]}]}},"/product/{productId}/assets/{assetId}":{"put":{"tags":["Media product"],"summary":"Sort product asset index.","operationId":"sortAsset_1","parameters":[{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}},{"name":"assetId","in":"path","description":"Asset ID.","required":true,"schema":{"type":"string"}},{"name":"sortIndex","in":"query","description":"Sort index.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Upsert asset successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SortedAttributeAssetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/metadata/jobs":{"get":{"tags":["Metadata"],"summary":"Get Metadata job","operationId":"SearchMetadataJob","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"maximum":100,"type":"integer","format":"int32","default":20}},{"name":"sortReverse","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"sortKey","in":"query","schema":{"type":"string","default":"createdAt"}}],"responses":{"200":{"description":"Metadata Job listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMetadataJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/metadata/jobs/{id}":{"get":{"tags":["Metadata"],"summary":"Get Metadata job","operationId":"getMetadataById","parameters":[{"name":"id","in":"path","description":"MetadataJob ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata Job by ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMetadataJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Cannot get Metadata Job"}},"security":[{"oauth2":[]}]}},"/metadata/papiSync":{"post":{"tags":["Metadata"],"summary":"Post all products/categories external media as metadata to Papi Sync","operationId":"postMetadata","responses":{"202":{"description":"Post metadata successful","content":{"application/json":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"status":{"title":"Error status code.","type":"integer","format":"int32"},"error":{"title":"General error description.","type":"string"},"errorDetails":{"title":"List of errors details.","type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"requestId":{"title":"Request ID used for logging.","type":"string"},"timestamp":{"title":"Error timestamp.","type":"integer","format":"int64"},"quotaLimitExceededDetails":{"title":"Additional entity id list related to error","type":"array","items":{"$ref":"#/components/schemas/QuotaLimitExceededDetails"}}}},"ErrorDetails":{"type":"object","properties":{"message":{"title":"Error message.","type":"string"},"field":{"title":"Error related field.","type":"string"},"rejectedValue":{"title":"Invalid value causing error.","type":"string"}}},"QuotaLimitExceededDetails":{"type":"object","properties":{"quota":{"title":"Quota name.","type":"string"},"message":{"title":"Quota limit message.","type":"string"},"limit":{"title":"Quota limit.","type":"integer","format":"int32"},"entityId":{"title":"Id of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true},"entityType":{"title":"Type of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true}}},"BulkCreateMediaAssetResponse":{"type":"object","properties":{"total":{"title":"Total.","type":"integer","format":"int32"},"successCount":{"title":"Success count.","type":"integer","format":"int32"},"failCount":{"title":"Fail count.","type":"integer","format":"int32"},"createMediaAssetResponses":{"type":"array","items":{"$ref":"#/components/schemas/CreateMediaAssetResponse"}}}},"CreateMediaAssetResponse":{"type":"object","properties":{"id":{"title":"Asset ID.","type":"string"},"title":{"title":"Asset title.","type":"string"},"url":{"title":"Asset URL.","type":"string"},"code":{"title":"Asset code.","type":"integer","format":"int32"},"metaData":{"title":"Meta data.","type":"object","additionalProperties":{"title":"Meta data.","type":"object"}},"errorMessages":{"title":"Error message.","type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}},"success":{"type":"boolean"}}},"ErrorMessage":{"title":"Error message.","type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"errorMsg":{"type":"string"}}},"BulkCreateMediaAssetRequest":{"required":["data"],"type":"object","properties":{"data":{"title":"Asset list.","type":"array","items":{"$ref":"#/components/schemas/CreateMediaAssetRequest"}}}},"CreateMediaAssetRequest":{"required":["mediaType","source","status","title","url"],"type":"object","properties":{"title":{"title":"Asset title.","type":"string"},"description":{"title":"Asset description.","type":"string"},"url":{"title":"Asset URL.","type":"string"},"source":{"title":"Media source.","type":"string"},"status":{"title":"Asset status.","type":"string","enum":["active","archived"]},"mediaType":{"title":"Asset type.","type":"string"},"externalNumber":{"title":"External number reference.","type":"string"},"metaData":{"title":"Asset Metadata.","type":"object","additionalProperties":{"title":"Asset Metadata.","type":"object"}},"contentType":{"title":"Content type.","type":"string"}}},"MediaAssetResponse":{"required":["createdAt","modifiedAt"],"type":"object","properties":{"id":{"title":"Asset ID.","type":"string"},"title":{"title":"Asset title.","type":"string"},"description":{"title":"Asset description.","type":"string"},"url":{"title":"Asset URL.","type":"string"},"source":{"title":"Asset source.","type":"string"},"status":{"title":"Asset status.","type":"string"},"mediaType":{"title":"Asset type.","type":"string"},"contentType":{"title":"Asset content type.","type":"string"},"createdBy":{"title":"Created user.","type":"string"},"labels":{"title":"Labels list.","type":"array","items":{"title":"Labels list.","type":"string"}},"externalNumber":{"title":"External No.","type":"string"},"createdAt":{"title":"Created time.","type":"string","example":"2017-09-02T09:00:00Z"},"modifiedBy":{"title":"Modified user.","type":"string"},"modifiedAt":{"title":"Modified time.","type":"string","example":"2017-09-02T09:00:00Z"}}},"SearchMediaAssetResponse":{"type":"object","properties":{"total":{"title":"Total of result.","type":"integer","format":"int64"},"page":{"title":"Page.","type":"integer","format":"int32"},"pageSize":{"title":"Page size.","type":"integer","format":"int32"},"data":{"title":"Results list.","type":"array","items":{"$ref":"#/components/schemas/MediaAssetResponse"}}}},"FilterMediaAssetData":{"type":"object","properties":{"type":{"title":"Filter type.","type":"string","enum":["CONTAINS","IN","IS"]},"values":{"title":"Filter values list.","type":"array","items":{"title":"Filter values list.","type":"string"}}}},"FilterMediaAssetRequest":{"type":"object","properties":{"sort":{"$ref":"#/components/schemas/SortRequest"},"pageSize":{"title":"Page size","maximum":1000,"minimum":1,"type":"integer","format":"int32"},"page":{"title":"Page","type":"integer","format":"int32"},"includeLabels":{"title":"Include labels to result","type":"boolean"},"titleFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"},"urlFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"},"descriptionFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"},"assetTypeFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"},"labelFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"},"sourceFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"},"statusFilter":{"$ref":"#/components/schemas/FilterMediaAssetData"}}},"SortRequest":{"title":"Sort request","type":"object","properties":{"sortReverse":{"title":"Sort reverse.","type":"integer","format":"int32"},"sortKey":{"title":"Sort key.","type":"string"}}},"GetCategoryDataResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PimCategoryResponse"}}}},"PimCategoryResponse":{"type":"object","properties":{"id":{"title":"Category ID.","type":"string"},"name":{"title":"Category name.","type":"string"},"number":{"title":"Category number.","type":"string"},"description":{"title":"Category description.","type":"string"}}},"GetProductDataResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PimProductResponse"}}}},"PimProductResponse":{"type":"object","properties":{"id":{"title":"Product ID.","type":"string"},"name":{"title":"Product name.","type":"string"},"number":{"title":"Product number.","type":"string"},"description":{"title":"Product description.","type":"string"}}},"UpdateMediaAssetRequest":{"type":"object","properties":{"title":{"title":"Asset title.","type":"string"},"description":{"title":"Asset description.","type":"string"},"url":{"title":"Asset URL.","type":"string"},"source":{"title":"Media source.","type":"string"},"status":{"title":"Asset status.","type":"string","enum":["active","archived"]},"mediaType":{"title":"Asset type.","type":"string"},"externalNumber":{"title":"External number reference.","type":"string"},"metaData":{"title":"Asset Metadata.","type":"object","additionalProperties":{"title":"Asset Metadata.","type":"object"}},"contentType":{"title":"Content type.","type":"string"}}},"AssetCategoryResponse":{"type":"object","properties":{"categoryId":{"title":"Category ID.","type":"string"},"status":{"title":"Status.","type":"string"}}},"AssetLabelsResponse":{"type":"object","properties":{"labelId":{"title":"Label ID.","type":"string"},"status":{"title":"Label status.","type":"string"},"error":{"title":"Error details.","type":"string"},"errorCode":{"title":"Error code.","type":"integer","format":"int32"}}},"AssetLabelsRequest":{"type":"object","properties":{"labels":{"title":"Label ids list.","type":"array","items":{"title":"Label ids list.","type":"string"}}}},"AssetProductResponse":{"type":"object","properties":{"productId":{"title":"Product ID.","type":"string"},"status":{"title":"Status.","type":"string"}}},"AssetCategoriesResponse":{"type":"object","properties":{"categoryId":{"title":"Category ID.","type":"string"},"status":{"title":"Status.","type":"string"},"error":{"title":"Error details.","type":"string"},"errorCode":{"title":"Error code.","type":"integer","format":"int32"}}},"AssetCategoriesRequest":{"type":"object","properties":{"categories":{"title":"Category ids list.","type":"array","items":{"title":"Category ids list.","type":"string"}}}},"AssetProductsResponse":{"type":"object","properties":{"productId":{"title":"Product ID.","type":"string"},"status":{"title":"Status.","type":"string"},"error":{"title":"Error details.","type":"string"},"errorCode":{"title":"Error code.","type":"integer","format":"int32"}}},"AssetProductsRequest":{"type":"object","properties":{"products":{"title":"Product ids list.","type":"array","items":{"title":"Product ids list.","type":"string"}}}},"UpdateAssetsListAttributeResponse":{"type":"object","properties":{"operationStatus":{"title":"Asset attribute updated status.","type":"string","enum":["SUCCESS","NOT_FOUND","FAIL"]},"entityId":{"title":"entityId","type":"string","example":"string"},"message":{"type":"string"}}},"MediaAssetCategoryResponse":{"type":"object","properties":{"id":{"title":"Asset ID.","type":"string"},"title":{"title":"Asset title.","type":"string"},"description":{"title":"Asset description.","type":"string"},"url":{"title":"Asset URL.","type":"string"},"source":{"title":"Asset source.","type":"string"},"status":{"title":"Asset status.","type":"string"},"mediaType":{"title":"Asset media type.","type":"string"},"labels":{"title":"Labels list.","type":"array","items":{"title":"Labels list.","type":"string"}},"sortIndex":{"title":"Sort index.","type":"integer","format":"int32"}}},"GetMetaDataResponse":{"type":"object","properties":{"id":{"type":"string"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetaDataResponse"}}}},"MediaMetaDataResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetMetaDataResponse"}}}},"MetaDataResponse":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"mediaType":{"type":"string"},"contentType":{"type":"string"},"labels":{"type":"array","items":{"type":"string"}},"sortIndex":{"type":"integer","format":"int32"}}},"ReplaceCategoryAssetRequest":{"type":"object","properties":{"assetsId":{"type":"array","items":{"title":"Assets id list","type":"string"}}}},"SortedAttributeAssetResponse":{"type":"object","properties":{"mediaAttributeId":{"type":"array","description":"List of media attributes ID.","items":{"type":"string","description":"List of media attributes ID."}}}},"MediaAssetProductResponse":{"type":"object","properties":{"id":{"title":"Asset ID.","type":"string"},"title":{"title":"Asset title.","type":"string"},"description":{"title":"Asset description.","type":"string"},"url":{"title":"Asset URL.","type":"string"},"source":{"title":"Asset source.","type":"string"},"status":{"title":"Asset status.","type":"string"},"mediaType":{"title":"Asset media type.","type":"string"},"labels":{"title":"Labels list.","type":"array","items":{"title":"Labels list.","type":"string"}},"sortIndex":{"title":"Sort index.","type":"integer","format":"int32"},"externalNumber":{"title":"External No.","type":"string"}}},"ReplaceProductAssetRequest":{"type":"object","properties":{"assetsId":{"type":"array","items":{"title":"Asset ids list.","type":"string"}}}},"MetadataJobResponse":{"title":"Result list","type":"object","properties":{"id":{"title":"JobId","type":"string"},"totalProducts":{"title":"totalProducts","type":"integer","format":"int32"},"executedProducts":{"title":"executedProducts","type":"integer","format":"int32"},"totalCategories":{"title":"totalCategories","type":"integer","format":"int32"},"executedCategories":{"title":"executedCategories","type":"integer","format":"int32"},"status":{"title":"status","type":"string"},"createdBy":{"title":"createdBy","type":"string"},"createdAt":{"title":"createdAt","type":"string","format":"date-time"},"modifiedBy":{"title":"modifiedBy","type":"string"},"modifiedAt":{"title":"modifiedAt","type":"string","format":"date-time"}}},"SearchMetadataJobResponse":{"type":"object","properties":{"total":{"title":"Total of result.","type":"integer","format":"int64"},"page":{"title":"page","type":"integer","format":"int32"},"pageSize":{"title":"page size","type":"integer","format":"int32"},"data":{"title":"Result list","type":"array","items":{"$ref":"#/components/schemas/MetadataJobResponse"}}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}},"x-amazon-apigateway-api-key-source":"AUTHORIZER"}