{ "openapi" : "3.0.1", "info" : { "description" : "# Introduction\n\nThis API provides access to find and view Assets in your Asset library through quick search, categories, and collections.\nExamples refer to `mysite.widencollective.com`, please replace this with your Widen Collective URL.\n\nPlease refer to the [API FAQ](https://community.widen.com/collective/s/article/API-FAQs), or contact [support@widen.com](mailto:support@widen.com) for any questions or further needs regarding this API.\n\n## API v2.0\n\n[Acquia DAM (Widen) API v2.0](https://docs.acquia.com/acquia-dam/api-v2) is now available.\n\n## General Statements\n\n- There is a rate limit of 50 calls per second per access token to the API. Exceeding this rate results in \"429 too many requests\" error responses.\n\n## Getting Started - Authentication\n\nThe Acquia DAM REST API uses [OAuth 2](http://tools.ietf.org/html/rfc6749) for authentication. All requests for protected resources require an access token to be included in the Authorization header of the request.\n

When submitting a request for an access token, your client ID and client secret must be provided in the Authorization header using\nBasic Auth, as well as relevant information in the request body for the OAuth grant type you use. The client ID and secret can be provided by Widen Support.\n

The Access Token does not expire and only needs to be obtained once.

\n\n### Client Registration\n\nAll requests for access tokens must include your client ID and client secret in the Authorization header using HTTP Basic Authentication.\n\n### Grant Types\n\nTwo grant types are available for authenticating:\n\n- authorization_code\n\n [This grant type](http://tools.ietf.org/html/rfc6749#section-1.3.1) is preferred and should be used when you are exchanging an authorization code for an access token.\n\n Required fields in the request body are:\n\n - authorization_code - The authorization code to exchange for an access token\n - grant_type - \"authorization_code\"\n\n- password\n\n [This grant type](http://tools.ietf.org/html/rfc6749#section-1.3.3) should be used only if the authorization_code grant type is not possible in your situation. It requires you to directly pass the Acquia DAM username and password for authentication.\n\n Required fields in the request body are:\n\n - username - Acquia DAM user's username\n - password - Acquia DAM user's password\n - grant_type - \"password\"\n\n### Obtaining an Authorization Code\n\nAuthorization codes are one-time use codes which can be exchanged for an access token.\nTo obtain an authorization code from Acquia DAM, your application should redirect the user to\nthe following page in Acquia DAM and including the required query parameters.\n\n```\nhttps://mysite.widencollective.com/allowaccess\n?client_id=myclientid.app.widen.com\n&redirect_uri=http://myredirecturl\n&state=xyz123\n```\n\nThe path component of the url must be *allowaccess*.\n\nThere are then 3 query parameters (2 required, 1 optional) that can be added to the URL.\n\n- client_id - **Required** This is the client id registered in the Acquia DAM database. Your client id must be obtained out-of-band.\n- redirect_uri - **Required** This is the url you must supply that Acquia DAM should redirect to after the user chooses to allow your application access.\n- state - **Optional** This is an extra security measure that can be taken. If you specify a state, the state string will be returned to as a query parameter when redirecting to your redirect_uri.\n\nAfter loading the Acquia DAM site with this url, the user will be requested to authenticate (if needed). They will then be taken to the Allow Access page, where they user will be shown\nyour application's information (based on information in your client registration). At that point the user can choose whether to allow your application access\nto Acquia DAM or they may choose to cancel and be redirected to the main Acquia DAM page.\n\nAfter choosing to allow your application access to Collective, the Collective server will respond with a redirect to your redirect url you supplied as a query parameter. The redirect url will have an authorization code and possibly a state parameter added to the query string.\n\n```\nhttps://myredirecturl/\n?code=wac_demo_521daa97b78e27c483dd04119cad533\n&state=xyz123\n```\n\nYour application can then read the authorization code and make a request to exchange the code for an access token, using the [Access Token](#reference/security/access-token) endpoint, which can be used to access protected resources.\n\n### Success Response\n\nIn the case of a successful response to a request for an access token, the body of the response will contain a JSON object.\n\n- access_token - This is your access token. It should be stored securely and included with any requests to access protected resources.\n- token_type - This is the type of token you received. At this time, the token type will always be \"Bearer\".\n- username - For convenience, the username of the user you have been authorized as.\n\n### Error Response\n\nIn the case of an exceptional condition, you may receive an error response. The body of the response will include JSON with information about the error. The *error* property corresponds to a corresponds to one of the error response codes found [here](http://tools.ietf.org/html/rfc6749#section-5.2). Also included is an *error_description* with some information about what occurred.\n\n- Bad Request (400) - The most common type of error response where there is a problem with the request that was made.\n- Server Error (500) - This error response is returned if there was an internal problem and the server could not finish handling the request.\n", "title" : "Acquia DAM (Widen) API", "version" : "v1.0" }, "servers" : [ { "url" : "https://.widencollective.com" } ], "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "tags" : [ { "name" : "Assets" }, { "description" : "Search for assets using a [quick search string](https://community.widen.com/collective/s/article/How-do-I-search-for-assets).\n\nQuick search fields can by specified by their regular or (short name):\n\n- AssetGroup (ag)\n- AssetsinGlobalCollections (acn)\n- AverageRating (rat)\n- Category (cat)\n- CollectionAssetFilenames (cafn)\n- CollectionTitleGlobal (cn)\n- DateAdded (da)\n- DateUpdated (du)\n- DocumentText (text)\n- ExpirationDate (ed)\n- FileFormat (ff)\n- Filename (fn)\n- Filesizeinbytes (size)\n- ID (id)\n- LastEditDate (lhd)\n- MetadataType (mt)\n- Orientation (ori)\n- OriginalFilename (ofn)\n- ReleaseDate (rd)\n- UUID (uuid)\n- UploadProfile (up)\n\nAdditional site-specific metadata field names can be found in DAM by going to More Searches -> Search Help.\n\nExample quick search strings:\n\nAssets with the terms \"sales\" and \"flyer\" in any field:\n\nQuick search string: sales flyer\n\nAssets with \"event\" in the filename that are new or modified since 01/01/2015:\n\nQuick search string: fn:event lhd:[after 01/01/2015]\n\nAssets in the \"2015 Catalog\" metadata type with an empty description (assumes a metadata field with key \"description\"):\n\nQuick search string: mt:{2015 Catalog} description:isempty\n", "name" : "Assets Search" }, { "description" : "Several Asset endpoints offer the ability to return additional data in the response by including these as a comma-separated list in the \"options\" parameter:\n\n## Embed Links\n\nOption embedLinks includes embed link urls with the asset. These links will not expire unless the underlying Asset expires. For more information, see [Customizing Links and Embed Codes](http://support.widencollective.com/customer/portal/articles/1753594-customizing-links-and-embed-codes?b_id=307).\n\n```json\n...\n\"embedLinks\":\n{\n \"640pxPortrait\": \"//embed.widencdn.net/img/marketing/bbuzac5jfd/x640px/logo.jpeg?u=ggiflw\",\n \"AssetDownloadLink\": \"//embed.widencdn.net/download/marketing/bbuzac5jfd/logo.eps?u=ggiflw\",\n \"640pxLandscape\": \"//embed.widencdn.net/img/marketing/bbuzac5jfd/640px/logo?u=ggiflw\"\n}\n...\n```\n\n## Embed Codes\n\nOption embedCodes includes embed codes with the asset. These codes will not expire unless the underlying Asset expires. For more information, see [Customizing Links and Embed Codes](http://support.widencollective.com/customer/portal/articles/1753594-customizing-links-and-embed-codes?b_id=307).\n\n```json\n...\n\"embedCodes\":\n{\n \"640pxPortrait\": \"<img height=\\\"640\\\" alt=\\\"logo\\\" src=\\\"https://embed.widencdn.net/img/marketing/bbuzac5jfd/x640px/logo.jpeg?u=ggiflw\\\"/ >\",\n \"AssetDownloadLink\": \"<a href=\\\"https://embed.widencdn.net/download/marketing/bbuzac5jfd/logo.eps?u=ggiflw\\\" target=\\\"_blank\\\">logo.eps</a>\",\n \"640pxLandscape\": \"<img width=\\\"640\\\" alt=\\\"logo\\\" src=\\\"https://embed.widencdn.net/img/marketing/bbuzac5jfd/640px/logo?u=ggiflw\\\"/ >\"\n}\n...\n```\n\n## Preconversions\n\nOption preconversions includes links to any available preconverted files for the Asset. These links will expire, by default after 24 hours.\n\n```json\n...\n\"preconversions\":\n{\n \"JPEG (800 pixel)\": \"http://s3.amazonaws.com/converted.widencdn.net/demo/2/c/a/2caf64b1-0d62-49d3-a286-18468f69fe0d.jpg?Expires=1398258435&AWSAccessKeyId=AKIAITF22STQRZR6F5ZB&Signature=p3OKYEuBnLnsnQGCpzKlxhi1wvA%3D\"\n}\n...\n```\n\n## Download URL\n\nOption downloadUrl includes a download link to the original file. This link will expire, by default after 24 hours.\n\n```json\n...\n\"downloadUrl\": \"https://demo.widencollective.com/asset/download/0747df59-8fb3-4ef3-b1ae-ebfa490370a9/original/0/2013-11-28T17:14:04Z/test.jpg?sig=19e7dfbe198bc4eda054e937ad998248f5cf73e0\"\n...\n```\n\n## Video URLs\n\nOption videoUrls includes links to raw standard def video, high def video, and poster frame for Video Assets. These links will expire, by default after 24 hours.\n\n```json\n...\n\"videoUrls\":\n{\n \"sd\": \"https://s3.amazonaws.com/previews-dam/demo/f/8/d/0/f8d0db5c-7bf6-4163-bed8-9df7ac60bec8/f8d0db5c-7bf6-4163-bed8-9df7ac60bec8_vid-sd.jpg?Signature=%2FcgzUJuzAIg9sMOVPC%2FuS9N1YpI%3D&AWSAccessKeyId=AKIAITF22STQRZR6F5ZQ&Expires=1416073715\",\n \"hd\": \"https://s3.amazonaws.com/previews-dam/demo/f/8/d/0/f8d0db5c-7bf6-4163-bed8-9df7ac60bec8/f8d0db5c-7bf6-4163-bed8-9df7ac60bec8_vid-hd.jpg?Signature=QNbXGT3MqjXSrKAwXSIe7CULHKI%3D&AWSAccessKeyId=AKIAITF22STQRZR6F5ZQ&Expires=1416073715\",\n \"thumbnail\": \"https://s3.amazonaws.com/previews-dam/demo/f/8/d/0/f8d0db5c-7bf6-4163-bed8-9df7ac60bec8/f8d0db5c-7bf6-4163-bed8-9df7ac60bec8_vid-thumbnail.jpg?Signature=K6wPc0SNAWt2RTTcfVnethZdNhs%3D&AWSAccessKeyId=AKIAITF22STQRZR6F5ZQ&Expires=1416073715\"\n}\n...\n```\n\n## Attached Documents\n\nOption attachedDocs includes links to any Attached Documents associated with the given Asset. Only implemented on the AssetDetails endpoint.\n\n```json\n...\n\"attachedDocs\": {\n \"docs\": [\n {\n \"uuid\": \"d3369990-9910-46b7-aafa-656fe829580c\",\n \"downloadUrl\": \"https://demo.widencollective.com/download/c69b3c52e03467e2b78cf339a02ed1b5ddbd22f34387108fa12b0516487fde00/MyAttachedDocument.pdf\",\n \"title\": \"MyAttachedDocument.pdf\"\n }\n ]\n}\n...\n```\n\n## Include Deleted\n\nOption includeDeleted will include deleted Assets in a search query, assuming the caller has permission to view deleted Assets.\n", "name" : "Asset Options" }, { "description" : "Provides information about Categories and the Assets contained in them.", "name" : "Categories" }, { "description" : "Provides information about global, shared, and private Collections.", "name" : "Collections" }, { "description" : "Retrieves links to asset previews that can be used in external locations, like web sites.", "name" : "Embed Codes" }, { "description" : "Provides information about File Formats.", "name" : "File Formats" }, { "description" : "Asset usage on external sites can be tracked via Integration Links, for reference and reporting within Widen DAM.", "name" : "Integration Links" }, { "description" : "Provides information about Metadata schemas.", "name" : "Metadata" }, { "description" : "Provides information about Orders and Conversions.", "name" : "Orders" }, { "description" : "Provides information about authentication and authorization.", "name" : "Security" }, { "description" : "Provides access to users and saved contacts.", "name" : "Users & Contacts" } ], "paths" : { "/api/rest/asset" : { "post" : { "description" : "Within our V1 API, uploads larger than 5GB are not supported. To upload larger files, or to use chunked uploading, you must use our V2 API.

The following `multipart/form-data` fields are expected in the request:

- `uploadProfileUUID`: (string) - the upload profile to use for this asset.
- `file`: (file) - the bytes of the file to be uploaded.
- `filename`: (string) - the file name of the asset being uploaded.


Example request:

------BOUNDARY
Content-Disposition: form-data; name=\"uploadProfileUUID\"
00000000-1111-2222-3333-444444444abc
------BOUNDARY
Content-Disposition: form-data; name=\"filename\"
Yellow Ducky.png
------BOUNDARY
Content-Disposition: form-data; name=\"file\"; filename=\"blob\"
Content-Type: application/octet-stream
// The bytes
------BOUNDARY--", "operationId" : "uploadAsset", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/UploadStatusWithUuid" } } }, "description" : "Asset uploaded successfully." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/UploadStatusWithError" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/UploadStatusWithError" } } }, "description" : "Invalid permission to upload asset." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Perform Upload", "tags" : [ "Assets" ] } }, "/api/rest/asset/changemetadatatype/asset/{assetuuid}/type/{typeuuid}" : { "put" : { "description" : "Updates asset metadata type.", "operationId" : "updateMetadataType", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "assetuuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The UUID of the desired metadata type.", "in" : "path", "name" : "typeuuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Asset metadata type updated." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid permission to update metadata type." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset or metadata type not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Update metadata type", "tags" : [ "Assets" ] } }, "/api/rest/asset/search" : { "post" : { "description" : "The POST body consists of a JSON object with a \"query\" property which references the query string for the search, and properties to select refine search filters:

- `assetStatusFilters` - array of one or more asset statuses: RELEASED, UNRELEASED, EXPIRED
- `fileTypeFilters` - array of one or more file types: IMAGES, VIDEO, AUDIO, INDESIGN, FLASH, PDF, OFFICE, COMPRESSED_ARCHIVE, OTHER
- `hasAttachedDocsFilter` - \"true\" to only return assets that have one or more attached documents
- `hasPublicCommentsFilter` - \"true\" to only return assets that have at least one public comment
- `metadataFilters` - array of objects containing a metadata field key and value keys (see example further down)
- `ratingFilters` - array of ratings to filter on: 1, 2, 3, 4, 5
- `categoryFilter` - category key to filter on (NOT an array, can only filter on one at a time)

The refine search keys should match those returned in the search results response \"refineFilters\" property.For example, using the response data below, filters could be added to only return images and videos with the value \"Presentation\" or \"Whitepaper\" for the metadata field \"Type\" using the following in the POST body:

```json{\nquery:'advisor',\nfileTypeFilters:['IMAGE','VIDEO'],\nmetadataFilters:[\n{fieldKey:'c87190e6-d1aa-4d9d-a3ca-f0b9ab9151d3',\nvalues:['3','4']}]\n}```", "operationId" : "performSearchPost", "parameters" : [ { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "Can be set to any of the \"key\" values returned from the \"sorts\" return data.", "in" : "query", "name" : "sort", "schema" : { "type" : "string", "default" : "date-added-reversed" } }, { "description" : "Whether to search within documents - PDFs, Word, Excel, etc.", "in" : "query", "name" : "searchdocuments", "schema" : { "type" : "boolean", "default" : true } }, { "description" : "Comma-separated list of additional options to include in the response. See Asset Options for available options.", "in" : "query", "name" : "options", "schema" : { "type" : "string" } }, { "description" : "Comma-separated list of metadata keys whose values will be returned in the response. Use \"all\" to get all metadata values.", "in" : "query", "name" : "metadata", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetList" } } }, "description" : "Asset search results are returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Search POST", "tags" : [ "Assets Search", "Assets" ] } }, "/api/rest/asset/search/{query}" : { "get" : { "description" : "Refine search filter counts are returned, but to filter on them the POST Asset Search endpoint must be used instead. The search query for the GET endpoint must be URL-encoded like so:

`/api/rest/asset/search/sales%20flyer`", "operationId" : "performSearch", "parameters" : [ { "description" : "The quick search query string. Search terms need to be url-encoded, i.e. %20 for a space. For more information on the format of a query string, see [Quick Search Help](https://community.widen.com/collective/s/article/How-do-I-search-for-assets).", "in" : "path", "name" : "query", "required" : true, "schema" : { "type" : "string", "pattern" : ".+" } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "Can be set to any of the \"key\" values returned from the \"sorts\" return data.", "in" : "query", "name" : "sort", "schema" : { "type" : "string", "default" : "date-added-reversed" } }, { "description" : "Whether to search within documents - PDFs, Word, Excel, etc.", "in" : "query", "name" : "searchdocuments", "schema" : { "type" : "boolean", "default" : true } }, { "description" : "Comma-separated list of additional options to include in the response. See Asset Options for available options.", "in" : "query", "name" : "options", "schema" : { "type" : "string" } }, { "description" : "Comma-separated list of metadata keys whose values will be returned in the response. Use \"all\" to get all metadata values.", "in" : "query", "name" : "metadata", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetList" } } }, "description" : "Asset search results are returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Search GET", "tags" : [ "Assets Search", "Assets" ] } }, "/api/rest/asset/uuid/{uuid}" : { "delete" : { "description" : "Deletes the indicated Asset from the Acquia DAM site. (Asset moves to the 'Pending Delete' queue in the Admin Tools web UI for an admin to fully remove or un-delete).", "operationId" : "deleteAsset", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Asset deleted successfully." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Delete Asset", "tags" : [ "Assets" ] }, "get" : { "description" : "Get metadata, release and expiration dates, and other Asset data by UUID.", "operationId" : "getAssetDetail", "parameters" : [ { "description" : "The UUID of the desired asset.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Comma-separated list of additional options to include in the response.", "in" : "query", "name" : "options", "schema" : { "type" : "string", "enum" : [ "embedCodes", "embedLinks", "downloadUrl", "videoUrls", "preconversions", "includeDeleted", "attachedDocs" ] } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetDetail" } } }, "description" : "Asset data is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Asset details", "tags" : [ "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/alternatepreview" : { "delete" : { "description" : "Remove an alternate preview for an asset.", "operationId" : "deleteAlternatePreview", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Alternative preview is removed." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewDeleteStatus" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewDeleteStatus" } } }, "description" : "Invalid permission to remove alternate preview." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewDeleteStatus" } } }, "description" : "Asset or alternate preview not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Remove alternate preview", "tags" : [ "Assets" ] }, "post" : { "description" : "Upload a new file as an alternate preview to an Asset.", "operationId" : "uploadAlternatePreview", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "file" : { "type" : "object", "description" : "Bytes of the alternate preview file for this asset." } }, "required" : [ "file" ] } } } }, "responses" : { "201" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewUploadStatus" } } }, "description" : "Alternative preview is uploaded." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewUploadStatus" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewUploadStatus" } } }, "description" : "Invalid permission to upload alternate preview." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AlternatePreviewUploadStatus" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Upload alternate preview", "tags" : [ "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/assetversions" : { "get" : { "description" : "Get ordered list of all Versions of the Asset by UUID (requires the AssetVersioning feature).", "operationId" : "getAssetVersions", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetVersionList" } } }, "description" : "Asset version list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset versioning is disabled for this site." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Asset version list", "tags" : [ "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/embed/code" : { "get" : { "description" : "Gets embed codes for the specified asset. If the feature is not enabled, you will get a 403 response.

For more information, see [Customizing Links and Embed Codes](https://community.acquia.com/acquiadam/s/article/How-do-I-customize-share-links-and-embed-codes-for-images).", "operationId" : "getEmbedCodes", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/EmbedCodesResponse" } } }, "description" : "Asset embed code list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset embed codes are disabled for this site." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Embed Codes", "tags" : [ "Embed Codes", "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/embed/link" : { "get" : { "description" : "Gets embed links for the specified asset.If the feature is not enabled, you will get a 403 response.

For more information, see [Customizing Links and Embed Codes](https://community.acquia.com/acquiadam/s/article/How-do-I-customize-share-links-and-embed-codes-for-images).\n", "operationId" : "getEmbedLinks", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/EmbedLinksResponse" } } }, "description" : "Asset embed link list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset embed links are disabled for this site." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Embed Links", "tags" : [ "Embed Codes", "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/metadata" : { "get" : { "description" : "Retrieves the metadata for the specified asset. Metadata fields with a single value, will have their value returned in the 'value' property on the root of each field object. Metadata fields which allow multiple selection, such as checkbox groups and palette fields, will have a 'selected' flag set on each of the selected items in the item list.", "operationId" : "getMetadata", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/MetadataFieldList" } } }, "description" : "Metadata for the asset is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Get metadata", "tags" : [ "Assets" ] }, "put" : { "description" : "Updates asset metadata. The JSON included in the request body is compatible with the JSON returned when retrieving metadata. Only required files are listed here in the PUT body. Any properties which are not required for the update will simply be ignored.

Any metadata fields not includes in the 'fields' array of the request will not be updated at all.

Any field included in the 'fields' array which supports only a single value will have its value cleared if the 'value' property is not included.

Best practice for fields which allow multiple selected values is to include all possible values in the 'items' array of the PUT body, only setting the 'selected' flag on the items you'd like to have selected after the update. Any items not included in the 'items' array when sending the request will be automatically deselected.

Values for date fields must either be sent in ISO-8601 format, or formatted as \"MM/dd/yyyy\". If the ISO-8601 format is not used, the system will assume the date to be at midnight in the default timezone of the Widen Collective user making the API call.", "operationId" : "updateMetadata", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataInput" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/MetadataFieldList" } } }, "description" : "Metadata updated and details returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Update metadata", "tags" : [ "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/preconversions" : { "get" : { "operationId" : "getPreconversions", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/Preconversions" } } }, "description" : "Preconversions list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Preconversions list", "tags" : [ "Assets" ] } }, "/api/rest/asset/uuid/{uuid}/security" : { "put" : { "description" : "Updates asset expiration date, release date, and/or asset groups. The JSON included in the request body is compatible with the JSON returned when retrieving Asset details.

Any security field not included in the body of the request will not be updated at all.

If a security field is included and is null, that field will be cleared on the Asset.

Values for date fields must either be sent in ISO-8601 format, or formatted as \"MM/dd/yyyy\". If the ISO-8601 format is not used, the system will assume the date to be at midnight in central time.", "operationId" : "updateSecurity", "parameters" : [ { "description" : "The Asset UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetSecurityRequest" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetSecurityResponse" } } }, "description" : "Security updated and details returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request or asset not found." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid permission to update security." }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Update security", "tags" : [ "Assets" ] } }, "/api/rest/assetgroups" : { "get" : { "deprecated" : true, "description" : "**This endpoint is now deprecated in v1.0.** For more information about our v2.0 implementation of this endpoint, please visit our Acquia DAM developer blog post, found [here](https://dev.acquia.com/blog/new-asset-group-endpoint).

Get a list of Asset Groups that the calling User has permission to view.", "operationId" : "getAssetGroups", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetGroupsResponse" } } }, "description" : "Asset group list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Get Asset Groups", "tags" : [ "Assets" ] } }, "/api/rest/assetversion/uuid/{uuid}" : { "get" : { "description" : "Get metadata, release and expiration dates, and other data by Version UUID (requires the AssetVersioning feature).", "operationId" : "getAssetVersionDetails", "parameters" : [ { "description" : "The UUID of the desired asset version.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetVersionDetail" } } }, "description" : "Asset version data is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Asset version not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Asset version details", "tags" : [ "Assets" ] } }, "/api/rest/category" : { "post" : { "operationId" : "createCategory", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EditCategoryRequest" } } } }, "responses" : { "201" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/Category" } } }, "description" : "Category created successfully." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Create Category", "tags" : [ "Categories" ] } }, "/api/rest/category/assets" : { "post" : { "description" : "Example showing how to add/remove assets to/from categories. The request allows you to specify the uuids of one or more categories and asset uuids which you would like to either add or remove from the specified categories.", "operationId" : "updateCategoryAssets", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateCategoryAssetsRequest" } } } }, "responses" : { "204" : { "description" : "The request was successful." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "The current user does not have permission to modify one or more of the specified categories." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Adding/Removing Assets", "tags" : [ "Categories" ] } }, "/api/rest/category/categoryTree" : { "get" : { "description" : "Gets the category tree structure for the entire site.", "operationId" : "getCategoryTree", "parameters" : [ { "description" : "If true, will include categories without Assets.", "in" : "query", "name" : "includeEmpty", "schema" : { "type" : "boolean", "default" : true } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CategoryListResponse" } } }, "description" : "Category tree is returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Categories feature is not enabled." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Category Tree", "tags" : [ "Categories" ] } }, "/api/rest/category/uuid/{uuid}" : { "put" : { "operationId" : "editCategory", "parameters" : [ { "description" : "The Category UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EditCategoryRequest" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/Category" } } }, "description" : "Category updated successfully." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Edit Category", "tags" : [ "Categories" ] } }, "/api/rest/category/uuid/{uuid}/assets" : { "get" : { "description" : "Gets a list of Assets in the given Category. Refine search filter counts are also returned, but to filter on them the POST Category Details endpoint must be used instead.", "operationId" : "getAssetsForCategory", "parameters" : [ { "description" : "The Category UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "Can be set to any of the \"key\" values returned from the \"sorts\" return data.", "in" : "query", "name" : "sort", "schema" : { "type" : "string", "default" : "date-added-reversed" } }, { "description" : "Comma-separated list of additional options to include in the response. See Asset Options for available options.", "in" : "query", "name" : "options", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetList" } } }, "description" : "Asset list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Category Details GET", "tags" : [ "Categories" ] }, "post" : { "description" : "Gets a list of Assets in the given Category. Refine search filter counts are also returned. The POST body consists of a JSON object with properties to select refine search filters:

- `assetStatusFilters` - array of one or more asset statuses: RELEASED, UNRELEASED, EXPIRED
- `fileTypeFilters` - array of one or more file types: IMAGES, VIDEO, AUDIO, INDESIGN, FLASH, PDF, OFFICE, COMPRESSED_ARCHIVE, OTHER
- `hasAttachedDocsFilter` - `Yes` to only return assets that have one or more attached documents
- `hasPublicCommentsFilter` - `Yes` to only return assets that have at least one public comment
- `metadataFilters` - array of objects containing a metadata field key and value keys (see example further down)
- `ratingFilters` - array of ratings to filter on: 1, 2, 3, 4, 5
- `categoryFilter` - category key to filter on (NOT an array, can only filter on one at a time)

The refine search keys should match those returned in the search results response `refineFilters` property. For example, using the response data below, filters could be added to only return images and office documents with the value of `Created Internally` or `Contracted` for the metadata field `Content Source` using the following in the POST body:

```{ query:'thesearch', fileTypeFilters:['IMAGE','OFFICE'], metadataFilters:[ {fieldKey:'878adec5-923c-499d-84c7-d3fb64a411ed', values:['9','10']}] }```", "operationId" : "getAssetsForCategoryPost", "parameters" : [ { "description" : "The Category UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "Can be set to any of the \"key\" values returned from the \"sorts\" return data.", "in" : "query", "name" : "sort", "schema" : { "type" : "string", "default" : "date-added-reversed" } }, { "description" : "Comma-separated list of additional options to include in the response. See Asset Options for available options.", "in" : "query", "name" : "options", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/AssetList" } } }, "description" : "Asset list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Category Details POST", "tags" : [ "Categories" ] } }, "/api/rest/category/uuid/{uuid}/subcategories" : { "get" : { "description" : "Get a list of categories under the given parent.", "operationId" : "byParent", "parameters" : [ { "description" : "The parent category UUID (or `root` to return all top-level categories)", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "If true, will include categories without Assets.", "in" : "query", "name" : "includeEmpty", "schema" : { "type" : "boolean", "default" : true } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CategoryListResponse" } } }, "description" : "Category list is returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Categories feature is not enabled." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Category List", "tags" : [ "Categories" ] } }, "/api/rest/collection" : { "post" : { "description" : "Creates a new Collection and optionally adds assets to that Collection.", "operationId" : "createCollection", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCollectionRequest" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CreateCollectionResponse" } } }, "description" : "Collection created and details returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Collections feature is not enabled." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Create Collection", "tags" : [ "Collections" ] } }, "/api/rest/collection/assets" : { "post" : { "description" : "Add or remove multiple Assets from one or many Collections.", "operationId" : "addOrRemoveAssetsFromCollections", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateCollectionsAssetsRequest" } } } }, "responses" : { "204" : { "description" : "Assets have been added or removed." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Collections feature is not enabled or user does not have permission to modify one or more of the specified Collections." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Adding/Removing Assets", "tags" : [ "Collections" ] } }, "/api/rest/collection/global" : { "get" : { "description" : "Lists global collections excluding those that appear empty to the user.", "operationId" : "listGlobalCollections", "parameters" : [ { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int64", "default" : 50 } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CollectionListResponse" } } }, "description" : "List of collections returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Global Collection List", "tags" : [ "Collections" ] } }, "/api/rest/collection/local" : { "get" : { "description" : "Lists collections created by the user.", "operationId" : "listLocalCollections", "parameters" : [ { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int64", "default" : 50 } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CollectionListResponse" } } }, "description" : "List of collections returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Local Collection List", "tags" : [ "Collections" ] } }, "/api/rest/collection/shared" : { "get" : { "description" : "Lists collections which have been shared with the user.", "operationId" : "listSharedCollections", "parameters" : [ { "description" : "Maximum number of results to return.", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int64", "default" : 50 } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CollectionListResponse" } } }, "description" : "List of collections returned." }, "400" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid request." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Shared Collection List", "tags" : [ "Collections" ] } }, "/api/rest/collection/uuid/{uuid}/assets" : { "get" : { "description" : "Gets the list of Assets in the given Collection, and some Collection info. Refine search filter counts are also returned, but to filter on them the POST Collection Details endpoint must be used instead.", "operationId" : "getCollectionAssets", "parameters" : [ { "description" : "Collection UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Maximum number of results to return", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "Can be set to any of the \"key\" values returned from the \"sorts\" return data.", "in" : "query", "name" : "sort", "schema" : { "type" : "string", "default" : "date-added-reversed" } }, { "description" : "Comma-separated list of additional options to include in the response. See Asset Options for available options.", "in" : "query", "name" : "options", "schema" : { "type" : "string" } }, { "description" : "Comma-separated list of metadata keys whose values will be returned in the response. Use `all` to get all metadata values.", "in" : "query", "name" : "metadata", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CollectionAssetsResponse" } } }, "description" : "Collection details and assets are returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Collection Details GET", "tags" : [ "Collections" ] }, "post" : { "description" : "Gets the list of Assets in the given Collection, and some Collection info. Refine search filter counts are also returned. The POST body consists of a JSON object with properties to select refine search filters:

- `assetStatusFilters` - array of one or more asset statuses: RELEASED, UNRELEASED, EXPIRED
- `fileTypeFilters` - array of one or more file types: IMAGES, VIDEO, AUDIO, INDESIGN, FLASH, PDF, OFFICE, COMPRESSED_ARCHIVE, OTHER
- `hasAttachedDocsFilter` - \"Yes\" to only return assets that have one or more attached documents
- `hasPublicCommentsFilter` - \"Yes\" to only return assets that have at least one public comment
- `metadataFilters` - array of objects containing a metadata field key and value keys (see example further down)
- `ratingFilters` - array of ratings to filter on: 1, 2, 3, 4, 5
- `categoryFilter` - category key to filter on (NOT an array, can only filter on one at a time)

The refine search keys should match those returned in the search results response \"refineFilters\" property. For example, using the response data below, filters could be added to only return assets with a rating of 4 or 5 having a value of \"Logo\" or \"Illustration\" for the metadata field \"Type\" using the following in the POST body:

```{query:'thesearch', ratingFilters:['5','4'], metadataFilters:[{ fieldKey:'c87190e6-d1aa-4d9d-a3ca-f0b9ab9151d3', values:['23','2'] }]}```", "operationId" : "getCollectionAssetsPost", "parameters" : [ { "description" : "Collection UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Index of the first result to return.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Maximum number of results to return", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "Can be set to any of the \"key\" values returned from the \"sorts\" return data.", "in" : "query", "name" : "sort", "schema" : { "type" : "string", "default" : "date-added-reversed" } }, { "description" : "Comma-separated list of additional options to include in the response. See Asset Options for available options.", "in" : "query", "name" : "options", "schema" : { "type" : "string" } }, { "description" : "Comma-separated list of metadata keys whose values will be returned in the response. Use `all` to get all metadata values.", "in" : "query", "name" : "metadata", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/CollectionAssetsResponse" } } }, "description" : "Collection details and assets are returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Collection Details POST", "tags" : [ "Collections" ] } }, "/api/rest/conversion/order/profile/uuid/{uuid}" : { "post" : { "description" : "Retrieves the list of conversions available for a specific order profile and set of assets.", "operationId" : "getApplicableConversions", "parameters" : [ { "description" : "The UUID of the order profile.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Uuids" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ConversionListResponse" } } }, "description" : "List of applicable conversions." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Conversions for Order", "tags" : [ "Orders" ] } }, "/api/rest/fileformats" : { "get" : { "description" : "Get the list of all recognized file formats.", "operationId" : "getFileFormats", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/FileFormatListResponse" } } }, "description" : "File format list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "File Format List", "tags" : [ "File Formats" ] } }, "/api/rest/integrationlink" : { "get" : { "description" : "Returns all Integration Links that have been registered.", "operationId" : "getIntegrationLinks", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLinkListResponse" } } }, "description" : "Integration link list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "List Integration Links", "tags" : [ "Integration Links" ] }, "post" : { "description" : "Creates an Integration Link to indicate an Asset has been embedded or copied to an external site. The POST body consists of a JSON object with a the below collection of name/value pairs:

- `assetUuid` (required) - uuid of the Asset being linked.
- `description` (required, max 255 chars) - text to describe the link.
- `url` (optional) - url to the page containing the Asset link.", "operationId" : "createLink", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLinkModel" } } } }, "responses" : { "201" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLinkModel" } } }, "description" : "Integration link is created." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Register Integration Link", "tags" : [ "Integration Links" ] } }, "/api/rest/integrationlink/{uuid}" : { "delete" : { "description" : "Deletes a previously registered Integration Link.", "operationId" : "removeLink", "parameters" : [ { "description" : "The uuid of the Integration Link to remove.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Integration link is removed." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Remove Integration Link", "tags" : [ "Integration Links" ] } }, "/api/rest/metadata/field/uuid/{uuid}/values" : { "post" : { "description" : "Adds new value option to a controlled vocabulary Metadata Field. JSON request body contains the following objects:

- `displayName` (required) - Display name for the new metadata.
- `valueindex` (optional) - 0-based index where the new value be be inserted. If ommitted, value will be added to the end of the list.", "operationId" : "addValueToMetadataTypeListField", "parameters" : [ { "description" : "UUID of the Metadata Field to add a value to.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/MetadataStringListResponse" } } }, "description" : "Metadata field value is added." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Add Metadata Field Value", "tags" : [ "Metadata" ] } }, "/api/rest/metadata/types" : { "get" : { "description" : "Retrieves the list of all MetadataTypes in the system. In addition to the Type's name and use, a listing of all that Type's MetadataFields is provided. For MetadataFields with a controlled list of options, each value is also provided.", "operationId" : "getMetadataTypes", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/MetadataTypeListResponse" } } }, "description" : "Metadata types list is returned." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Metadata Types List", "tags" : [ "Metadata" ] } }, "/api/rest/oauth/logout" : { "post" : { "description" : "Invalidates the supplied access token on the server.", "operationId" : "logout", "responses" : { "200" : { "description" : "Access token invalidated." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Logout", "tags" : [ "Security" ] } }, "/api/rest/oauth/token" : { "post" : { "description" : "Obtain an access token by a valid grant type. The preferred method of obtaining an Access Token is with an Authorization Code. Once you have an Authorization Code (see 'Obtaining an Authorization Code' above), use this API call to exchange it for an Access Token. If obtaining an Authorization Code is not possible, a password may be used instead (see the 2nd example in Obtain Access Token below). It requires your application to handle the User's Widen DAM credentials directly. Use your Client ID and Client Secret to generate the Basic HTTP Authorization header in the following format:

```Authorization: Basic Base64Encode(clientId:clientSecret)```

For example, for the below values of Client ID and Client Secret:

`Client ID = \"6ccea893ddb16e80eb2f3c942509b2adfcc24e5e.app.widen.com\"`
`Client Secret = \"0feb4b54244fb6041e7b7502f22ee4c4f07a1b0a\"`

The resulting Authorization header would be:

```Basic NmNjZWE4OTNkZGIxNmU4MGViMmYzYzk0MjUwOWIyYWRmY2MyNGU1ZS5hcHAud2lkZW4uY29tOjBmZWI0YjU0MjQ0ZmI2MDQxZTdiNzUwMmYyMmVlNGM0ZjA3YTFiMGE=```

The returned Access Token is used in the Authorization header of all other API calls. It does not expire and only needs to be obtained once.", "operationId" : "generateAccessTokenWithCredentials", "parameters" : [ { "in" : "header", "name" : "Authorization", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OAuthTokenExchangeRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/OAuthTokenResponse" } } }, "description" : "Auth token data is returned." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Client not found/disabled." }, "404" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Auth code not found/expired." } }, "security" : [ ], "summary" : "Obtain access token", "tags" : [ "Security" ] } }, "/api/rest/order" : { "post" : { "description" : "Create an asset order. The POST body must include, at a minimum, the recipients, conversions, assets and order profile UUIDs. Optionally, the POST body can include a custom email subject, notes to include in the generated email, and values for any metadata fields which are included in the order profile.

Successful generation of the order will have a 201 (Created) response and will include an array of the individual orders (per recipient) that were created.", "operationId" : "createOrder", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCreationRequest" } } } }, "responses" : { "201" : { "description" : "Order created." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Create Order", "tags" : [ "Orders" ] } }, "/api/rest/order/items/removals" : { "post" : { "description" : "This can be called before attempting to create an order to determine which items will be removed from the order. Situations include an asset that has been deleted or an asset the user does not have permission to order.

Any items returned in the removedItems list, will be removed automatically when the order is submitted.", "operationId" : "cleanOrderItems", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Uuids" } } } }, "responses" : { "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Clean Assets for Order", "tags" : [ "Orders" ] } }, "/api/rest/order/profile/internet" : { "get" : { "description" : "Gets the Order Profiles available for sending orders via the internet.", "operationId" : "getDirectorInternetProfiles", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/OrderProfileListResponse" } } }, "description" : "List of Order Profiles." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Internet Order Profile List", "tags" : [ "Orders" ] } }, "/api/rest/order/seqNum/{seqNum}" : { "get" : { "description" : "Gets order information by order sequence number and, if the order conversion status is 'Completed', up to 100 assets and associated conversions and pickup urls for that order. If the order conversion status is not 'Completed', only order details (uuid, conversion status, assets in order, and sequence number) will appear in the response.", "operationId" : "getOrderDetailBySequenceNum", "parameters" : [ { "description" : "The sequence number of the Order.", "in" : "path", "name" : "seqNum", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The starting index of assets in the order to include.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/OrderDetail" } } }, "description" : "Order details." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Permission denied." }, "404" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Order not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Order Details by Sequence Number", "tags" : [ "Orders" ] } }, "/api/rest/order/uuid/{uuid}" : { "get" : { "description" : "Gets order information by uuid and, if the order conversion status is 'Completed', up to 100 assets and associated conversions and pickup urls for that order. If the order conversion status is not 'Completed', only order details (uuid, conversion status, assets in order, and sequence number) will appear in the response.", "operationId" : "getOrderDetailByUUID", "parameters" : [ { "description" : "The Order UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The starting index of assets in the order to include.", "in" : "query", "name" : "start", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/OrderDetail" } } }, "description" : "Order details." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." }, "403" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Permission denied." }, "404" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Order not found." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Order Details by UUID", "tags" : [ "Orders" ] } }, "/api/rest/order/uuid/{uuid}/zip" : { "get" : { "description" : "Used to check the status of an archive operation that has previously been submitted. If the archive operation is complete, this call returns a download link for the zip archive.", "operationId" : "getZipStatusOrDownloadLink", "parameters" : [ { "description" : "The Order UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ZipStatus" } } }, "description" : "The status of the zip archive operation." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Get Zip Archive Status/Link", "tags" : [ "Orders" ] }, "post" : { "description" : "Used to submit a request to begin the creation of a zip archive for a specific order.", "operationId" : "createZipForOrder", "parameters" : [ { "description" : "The Order UUID.", "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "The request was successfully submitted." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Create Zip Archive", "tags" : [ "Orders" ] } }, "/api/rest/uploadprofile" : { "get" : { "description" : "Gets the Upload Profiles the authenticated user is able to upload Assets to.

Other helpful fields are also returned:
- `releaseDate` indicates the value that will be assigned to assets being uploaded with this profile.
- `assetGroups` indicates the list of asset groups that will be assigned to assets being uploaded with this profile.", "operationId" : "getUploadProfiles", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/UploadProfilesResponse" } } }, "description" : "Upload profiles are returned." }, "401" : { "content" : { "application/json; charset=UTF-8;" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "Upload Profiles List", "tags" : [ "Assets" ] } }, "/api/rest/user/address" : { "get" : { "description" : "Retrieves the current user's address.", "operationId" : "getUserAddress", "responses" : { "200" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/UserAddressResponse" } } }, "description" : "User address information is returned." }, "401" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Invalid authentication." } }, "security" : [ { "access-token" : [ ] }, { "basic" : [ ] } ], "summary" : "User Address", "tags" : [ "Users & Contacts" ] } } }, "components" : { "schemas" : { "AddressFieldModel" : { "type" : "object", "properties" : { "required" : { "type" : "boolean" }, "value" : { "type" : "string" } } }, "AddressModel" : { "type" : "object", "properties" : { "email" : { "type" : "string" }, "fields" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AddressFieldModel" } }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "AlternatePreviewDeleteStatus" : { "type" : "object", "properties" : { "assetUuid" : { "type" : "string" }, "deleted" : { "type" : "boolean" }, "message" : { "type" : "string" } } }, "AlternatePreviewUploadStatus" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "success" : { "type" : "boolean" }, "uuid" : { "type" : "string" } } }, "AssetCategory" : { "type" : "object", "properties" : { "parentCategoryUuid" : { "type" : "string" }, "title" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "AssetCategoryList" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetCategory" } }, "categoriesString" : { "type" : "string" }, "categoryPaths" : { "type" : "array", "items" : { "type" : "string" } } } }, "AssetDetail" : { "type" : "object", "properties" : { "allAssetGroups" : { "type" : "object" }, "archived" : { "type" : "boolean" }, "aspectRatio" : { "type" : "number", "format" : "double" }, "assetGroups" : { "type" : "array", "items" : { "type" : "string" } }, "attachedDocs" : { "$ref" : "#/components/schemas/AttachedDocsList" }, "audioData" : { "$ref" : "#/components/schemas/AudioData" }, "categories" : { "$ref" : "#/components/schemas/AssetCategoryList" }, "dateAdded" : { "type" : "string", "format" : "date-time" }, "dateDeleted" : { "type" : "string", "format" : "date-time" }, "dateLastEdited" : { "type" : "string", "format" : "date-time" }, "dateUpdated" : { "type" : "string", "format" : "date-time" }, "downloadUrl" : { "type" : "string" }, "expirationDate" : { "type" : "string", "format" : "date-time" }, "expired" : { "type" : "boolean" }, "externalId" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "fileFormat" : { "type" : "string" }, "filename" : { "type" : "string" }, "filesizeKilobytes" : { "type" : "integer", "format" : "int64" }, "finalized" : { "type" : "boolean" }, "metadata" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "metadataDetails" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataField" } }, "metadataImportComplete" : { "type" : "boolean" }, "metadataType" : { "type" : "string" }, "metadataTypeUuid" : { "type" : "string" }, "name" : { "type" : "string" }, "permission" : { "$ref" : "#/components/schemas/AssetPermission" }, "popularity" : { "type" : "integer", "format" : "int64" }, "previews" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "releaseDate" : { "type" : "string", "format" : "date-time" }, "size" : { "type" : "string" }, "thumbnailText" : { "type" : "string" }, "type" : { "type" : "string" }, "unreleased" : { "type" : "boolean" }, "uuid" : { "type" : "string" }, "videoData" : { "$ref" : "#/components/schemas/VideoData" }, "videoUrls" : { "$ref" : "#/components/schemas/VideoUrls" } } }, "AssetGroup" : { "type" : "object", "description" : "A list of asset groups that assets uploaded using this profile will be assigned to.", "properties" : { "name" : { "type" : "string", "description" : "The human-readable name of the asset group.", "example" : "public" }, "uuid" : { "type" : "string" } } }, "AssetGroupsResponse" : { "type" : "object", "properties" : { "assetGroups" : { "type" : "array", "description" : "The list of asset group objects.", "items" : { "$ref" : "#/components/schemas/AssetGroup" } } } }, "AssetList" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetSummary" } }, "defaultSortKey" : { "type" : "string" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterInfoRep" } }, "numResults" : { "type" : "integer", "format" : "int32" }, "query" : { "type" : "string" }, "refineFilters" : { "$ref" : "#/components/schemas/RefineSearchFiltersRep" }, "searchDescription" : { "type" : "string" }, "searchError" : { "type" : "string" }, "sorts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortInfoRep" } } } }, "AssetPermission" : { "type" : "object", "properties" : { "adminMetadata" : { "type" : "boolean" }, "editCategories" : { "type" : "boolean" }, "editMetadata" : { "type" : "boolean" }, "expirationDate" : { "type" : "boolean" }, "releaseDate" : { "type" : "boolean" }, "uuid" : { "type" : "string" } } }, "AssetSecurityRequest" : { "type" : "object", "properties" : { "expirationDate" : { "type" : "string", "format" : "date-time", "description" : "Must either be sent in ISO-8601 format, or formatted as 'MM/dd/yyyy'. If the ISO-8601 format is not used, the system will assume the date to be at midnight central time.", "nullable" : true }, "groups" : { "type" : "array", "description" : "List of asset group names as string values.", "items" : { "type" : "string", "description" : "List of asset group names as string values.", "nullable" : true }, "nullable" : true }, "releaseDate" : { "type" : "string", "format" : "date-time", "description" : "Must either be sent in ISO-8601 format, or formatted as 'MM/dd/yyyy'. If the ISO-8601 format is not used, the system will assume the date to be at midnight central time.", "nullable" : true } } }, "AssetSecurityResponse" : { "type" : "object", "properties" : { "expirationDate" : { "type" : "string", "format" : "date-time" }, "groups" : { "type" : "array", "items" : { "type" : "string" } }, "releaseDate" : { "type" : "string", "format" : "date-time" } } }, "AssetSummary" : { "type" : "object", "properties" : { "dateAdded" : { "type" : "string", "format" : "date-time" }, "dateLastEdited" : { "type" : "string", "format" : "date-time" }, "dateUpdated" : { "type" : "string", "format" : "date-time" }, "externalId" : { "type" : "string" }, "fileFormat" : { "type" : "string" }, "metadata" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "name" : { "type" : "string" }, "previews" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "size" : { "type" : "string" }, "type" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "AssetVersion" : { "type" : "object", "properties" : { "assetExternalId" : { "type" : "string" }, "currentVersion" : { "type" : "boolean" }, "dateAdded" : { "type" : "string", "format" : "date-time" }, "dateLastEdited" : { "type" : "string", "format" : "date-time" }, "dateUpdated" : { "type" : "string", "format" : "date-time" }, "fileFormat" : { "type" : "string" }, "name" : { "type" : "string" }, "previews" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "sizeInMb" : { "type" : "string" }, "type" : { "type" : "string" }, "uuid" : { "type" : "string" }, "versionNumber" : { "type" : "integer", "format" : "int64" } } }, "AssetVersionDetail" : { "type" : "object", "properties" : { "allAssetGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetGroup" } }, "archived" : { "type" : "boolean" }, "aspectRatio" : { "type" : "number", "format" : "double" }, "assetGroups" : { "type" : "array", "items" : { "type" : "string" } }, "attachedDocs" : { "$ref" : "#/components/schemas/AttachedDocsList" }, "audioData" : { "$ref" : "#/components/schemas/AudioData" }, "categories" : { "$ref" : "#/components/schemas/AssetCategoryList" }, "dateAdded" : { "type" : "string", "format" : "date-time" }, "dateDeleted" : { "type" : "string", "format" : "date-time" }, "dateLastEdited" : { "type" : "string", "format" : "date-time" }, "dateUpdated" : { "type" : "string", "format" : "date-time" }, "downloadUrl" : { "type" : "string" }, "expirationDate" : { "type" : "string", "format" : "date-time" }, "expired" : { "type" : "boolean" }, "externalId" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "fileFormat" : { "type" : "string" }, "filename" : { "type" : "string" }, "filesizeKilobytes" : { "type" : "integer", "format" : "int64" }, "finalized" : { "type" : "boolean" }, "metadata" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "metadataDetails" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataField" } }, "metadataImportComplete" : { "type" : "boolean" }, "metadataType" : { "type" : "string" }, "metadataTypeUuid" : { "type" : "string" }, "name" : { "type" : "string" }, "parentAssetUuid" : { "type" : "string" }, "permission" : { "$ref" : "#/components/schemas/AssetPermission" }, "popularity" : { "type" : "integer", "format" : "int64" }, "preconversions" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "previews" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "releaseDate" : { "type" : "string", "format" : "date-time" }, "size" : { "type" : "string" }, "thumbnailText" : { "type" : "string" }, "type" : { "type" : "string" }, "unreleased" : { "type" : "boolean" }, "uuid" : { "type" : "string" }, "versionNumber" : { "type" : "integer", "format" : "int32" }, "videoData" : { "$ref" : "#/components/schemas/VideoData" }, "videoUrls" : { "$ref" : "#/components/schemas/VideoUrls" } } }, "AssetVersionList" : { "type" : "object", "properties" : { "assetUuid" : { "type" : "string" }, "numResults" : { "type" : "integer", "format" : "int32" }, "versions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetVersion" } } } }, "AttachedDoc" : { "type" : "object", "properties" : { "downloadUrl" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "AttachedDocsList" : { "type" : "object", "properties" : { "docs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AttachedDoc" } } } }, "AudioData" : { "type" : "object", "properties" : { "url" : { "type" : "string" } } }, "Category" : { "type" : "object", "nullable" : true, "properties" : { "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Category" } }, "id" : { "type" : "integer", "format" : "int64", "deprecated" : true, "description" : "Numerical identifier of the category. Use `uuid` instead." }, "title" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "CategoryListResponse" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Category" } }, "parentCategory" : { "$ref" : "#/components/schemas/Category" } } }, "Collection" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "CollectionAsset" : { "type" : "object", "properties" : { "dateAdded" : { "type" : "string", "format" : "date-time" }, "dateLastEdited" : { "type" : "string", "format" : "date-time" }, "dateUpdated" : { "type" : "string", "format" : "date-time" }, "downloadUrl" : { "type" : "string" }, "embedCodes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "embedLinks" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "externalId" : { "type" : "string" }, "fileFormat" : { "type" : "string" }, "metadata" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "name" : { "type" : "string" }, "previews" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "size" : { "type" : "string" }, "type" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "CollectionAssetsResponse" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CollectionAsset" } }, "defaultSortKey" : { "type" : "string" }, "description" : { "type" : "string" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CollectionFilter" } }, "name" : { "type" : "string" }, "numResults" : { "type" : "integer", "format" : "int32" }, "refineFilters" : { "$ref" : "#/components/schemas/RefineFilters" }, "sorts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CollectionSort" } }, "type" : { "type" : "string", "enum" : [ "global", "local", "shared" ] }, "uuid" : { "type" : "string" } } }, "CollectionFilter" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "name" : { "type" : "string" } } }, "CollectionListResponse" : { "type" : "object", "properties" : { "collections" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Collection" } }, "count" : { "type" : "integer", "format" : "int64" } } }, "CollectionSort" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "title" : { "type" : "string" } } }, "CollectionType" : { "type" : "string", "description" : "The type of the collection just created.", "enum" : [ "global", "local", "shared" ], "example" : "local" }, "ConversionListResponse" : { "type" : "object", "properties" : { "conversions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConversionModel" } } } }, "ConversionModel" : { "type" : "object", "properties" : { "approvalRequired" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayOrder" : { "type" : "integer", "format" : "int32" }, "mediaType" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "CreateCollectionAssetResponse" : { "type" : "object", "description" : "The list of assets added to the collection just created.", "properties" : { "uuid" : { "type" : "string" } } }, "CreateCollectionRequest" : { "type" : "object", "properties" : { "assets" : { "$ref" : "#/components/schemas/Uuids" }, "description" : { "type" : "string", "description" : "An optional string that sets the description text for the new collection.", "example" : "Must have the precious. They stole it from us. Sneaky little hobbitses.", "nullable" : true }, "title" : { "type" : "string", "description" : "A string specifying the title of the collection to create. Must not be blank.", "example" : "My Precious" } }, "required" : [ "title" ] }, "CreateCollectionResponse" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "description" : "The list of assets added to the collection just created.", "items" : { "$ref" : "#/components/schemas/CreateCollectionAssetResponse" } }, "assetsAddedCount" : { "type" : "integer", "format" : "int32", "description" : "Number of assets added to the collection just created." }, "description" : { "type" : "string", "description" : "The description of the collection just created." }, "name" : { "type" : "string", "description" : "The title of the collection just created." }, "numResults" : { "type" : "integer", "format" : "int32", "deprecated" : true, "description" : "Number of assets added to the collection just created." }, "type" : { "$ref" : "#/components/schemas/CollectionType" }, "uuid" : { "type" : "string", "description" : "The UUID of the collection just created." } } }, "EditCategoryRequest" : { "type" : "object", "description" : "If neither `displayAlphabetically` nor `displayBeforeCategory` are provided, the category will be added at the end.", "properties" : { "description" : { "type" : "string" }, "displayAlphabetically" : { "type" : "boolean", "default" : false, "description" : "`true` to reorganize the categories at this level alphabetically after category creation." }, "displayBeforeCategory" : { "type" : "string", "description" : "To display the new category before another category, provide its UUID here." }, "parentCategory" : { "type" : "string", "description" : "UUID of the parent category, or `root` to make a top-level category. Required if creating, optional if editing an existing category." }, "title" : { "type" : "string", "description" : "Display title" } }, "required" : [ "title" ] }, "EmbedCodesResponse" : { "type" : "object", "properties" : { "embedCodes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uuid" : { "type" : "string" } } }, "EmbedLinksResponse" : { "type" : "object", "properties" : { "embedLinks" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uuid" : { "type" : "string" } } }, "ErrorResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "error" : { "type" : "string" } } }, "FileFormatListResponse" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "formats" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileFormatModel" } } } }, "FileFormatModel" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" } } }, "FilterInfoRep" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "name" : { "type" : "string" } } }, "IntegrationLinkListResponse" : { "type" : "object", "properties" : { "integrationLinks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IntegrationLinkModel" } } } }, "IntegrationLinkModel" : { "type" : "object", "properties" : { "assetUuid" : { "type" : "string" }, "description" : { "type" : "string" }, "updatedDate" : { "type" : "string", "format" : "date-time" }, "url" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "MetadataField" : { "type" : "object", "properties" : { "discriminator" : { "type" : "string" }, "displayKey" : { "type" : "string" }, "displayName" : { "type" : "string" }, "editable" : { "type" : "boolean" }, "helpText" : { "type" : "string" }, "required" : { "type" : "boolean" }, "uuid" : { "type" : "string" }, "value" : { "type" : "string" } } }, "MetadataFieldInput" : { "type" : "object", "properties" : { "displayKey" : { "type" : "string" }, "itemList" : { "$ref" : "#/components/schemas/MetadataItemListInput" }, "uuid" : { "type" : "string" }, "value" : { "type" : "string" }, "values" : { "type" : "array", "items" : { "type" : "string" } } } }, "MetadataFieldList" : { "type" : "object", "properties" : { "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataField" } } } }, "MetadataInput" : { "type" : "object", "description" : "If metadata is required for the specified order profile, it should be included here.", "properties" : { "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataFieldInput" } } } }, "MetadataItemInput" : { "type" : "object", "properties" : { "selected" : { "type" : "boolean" }, "uuid" : { "type" : "string" } } }, "MetadataItemListInput" : { "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataItemInput" } } } }, "MetadataRefineFilter" : { "type" : "object", "properties" : { "fieldKey" : { "type" : "string" }, "fieldName" : { "type" : "string" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineFilter" } } } }, "MetadataStringListResponse" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "key" : { "type" : "string" }, "uuid" : { "type" : "string" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataStringListValue" } } } }, "MetadataStringListValue" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "index" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" } } }, "MetadataType" : { "type" : "object", "properties" : { "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataField" } }, "name" : { "type" : "string" }, "use" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "MetadataTypeListResponse" : { "type" : "object", "properties" : { "metadataTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataType" } } } }, "OAuthTokenExchangeRequest" : { "type" : "object", "properties" : { "authorization_code" : { "type" : "string", "description" : "The raw (unhashed) namespaced authorization code. Only required when grant_type=authorization_code" }, "grant_type" : { "type" : "string", "description" : "The desired grant type for token exchange.", "enum" : [ "password", "authorization_code", "refresh_token" ] }, "password" : { "type" : "string", "description" : "The password of the account to generate a token for. Only required when grant_type=password" }, "username" : { "type" : "string", "description" : "The username of the account to generate a token for. Only required when grant_type=password" } } }, "OAuthTokenResponse" : { "type" : "object", "properties" : { "accessToken" : { "type" : "string", "description" : "The raw (unhashed) namespaced access token." }, "tokenType" : { "type" : "string", "description" : "The provided access token type." }, "username" : { "type" : "string", "description" : "The username of the user the access token was generated for." } } }, "OrderCreationRequest" : { "type" : "object", "properties" : { "assets" : { "type" : "array", "description" : "Array of asset UUIDs to include in the order.", "items" : { "type" : "string", "description" : "Array of asset UUIDs to include in the order." } }, "conversions" : { "type" : "array", "description" : "Array of conversion UUIDs to perform on the assets for the order.", "items" : { "type" : "string", "description" : "Array of conversion UUIDs to perform on the assets for the order." } }, "createArchive" : { "type" : "boolean", "description" : "Optionally kick off the creation of a zip archive for the order created for the first (or only) recipient listed. Does not create zip archives for any recipient other than the first listed. Defaults to false." }, "metadata" : { "$ref" : "#/components/schemas/MetadataInput" }, "notes" : { "type" : "string", "description" : "Optional notes to include in the order email." }, "profile" : { "type" : "string", "description" : "The UUID of the order profile to be used when creating this order." }, "recipients" : { "type" : "array", "description" : "Array of the current user's saved contact UUIDs who should receive the order.", "items" : { "type" : "string", "description" : "Array of the current user's saved contact UUIDs who should receive the order." } }, "subject" : { "type" : "string", "description" : "Optional subject to use in the order email, a default is use if left blank." } } }, "OrderDetail" : { "type" : "object", "properties" : { "assetsInOrder" : { "type" : "integer", "format" : "int32" }, "conversionStatus" : { "type" : "string" }, "datePlaced" : { "type" : "string", "format" : "date-time" }, "downloadCount" : { "type" : "integer", "format" : "int64" }, "expirationDate" : { "type" : "string", "format" : "date-time" }, "externalPickupLink" : { "type" : "string" }, "orderedItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrderedItem" } }, "recipient" : { "$ref" : "#/components/schemas/AddressModel" }, "sender" : { "$ref" : "#/components/schemas/AddressModel" }, "sequenceNumber" : { "type" : "string" }, "status" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "OrderProfileListResponse" : { "type" : "object", "properties" : { "profiles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrderProfileModel" } } } }, "OrderProfileModel" : { "type" : "object", "properties" : { "internetDelivery" : { "type" : "boolean" }, "metadataTypeUuid" : { "type" : "string" }, "name" : { "type" : "string" }, "sendToSelf" : { "type" : "boolean" }, "specialInstructions" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "OrderedItem" : { "type" : "object", "properties" : { "conversions" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "filename" : { "type" : "string" }, "previews" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uuid" : { "type" : "string" } } }, "Preconversions" : { "type" : "object", "properties" : { "preconversions" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "uuid" : { "type" : "string" } } }, "RefineFilter" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int64" }, "key" : { "type" : "string" }, "name" : { "type" : "string" } } }, "RefineFilters" : { "type" : "object", "properties" : { "assetStatus" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineFilter" } }, "category" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineFilter" } }, "fileType" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineFilter" } }, "hasAttachedDocs" : { "$ref" : "#/components/schemas/RefineFilter" }, "hasPublicComments" : { "$ref" : "#/components/schemas/RefineFilter" }, "metadata" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataRefineFilter" } }, "rating" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineFilter" } } } }, "RefineSearchCountRep" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "key" : { "type" : "string" }, "name" : { "type" : "string" } } }, "RefineSearchFiltersRep" : { "type" : "object", "properties" : { "assetStatus" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineSearchCountRep" } }, "category" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineSearchCountRep" } }, "fileType" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineSearchCountRep" } }, "hasAttachedDocs" : { "$ref" : "#/components/schemas/RefineSearchCountRep" }, "hasPublicComments" : { "$ref" : "#/components/schemas/RefineSearchCountRep" }, "metadata" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineSearchMetadataRep" } }, "rating" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineSearchCountRep" } } } }, "RefineSearchMetadataRep" : { "type" : "object", "properties" : { "fieldKey" : { "type" : "string" }, "fieldName" : { "type" : "string" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RefineSearchCountRep" } } } }, "RemovedItemModel" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "reason" : { "type" : "string" } } }, "RemovedItemsListResponse" : { "type" : "object", "properties" : { "removedItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RemovedItemModel" } } } }, "SortInfoRep" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "title" : { "type" : "string" } } }, "UpdateCategoryAssetsRequest" : { "type" : "object", "properties" : { "add" : { "$ref" : "#/components/schemas/Uuids" }, "categories" : { "$ref" : "#/components/schemas/Uuids" }, "remove" : { "$ref" : "#/components/schemas/Uuids" } } }, "UpdateCollectionsAssetsRequest" : { "type" : "object", "properties" : { "add" : { "$ref" : "#/components/schemas/Uuids" }, "collections" : { "$ref" : "#/components/schemas/Uuids" }, "remove" : { "$ref" : "#/components/schemas/Uuids" } }, "required" : [ "collections" ] }, "UploadProfile" : { "type" : "object", "properties" : { "assetGroups" : { "type" : "array", "description" : "A list of asset groups that assets uploaded using this profile will be assigned to.", "items" : { "$ref" : "#/components/schemas/AssetGroup" } }, "mobileAllowed" : { "type" : "boolean", "deprecated" : true, "description" : "Legacy field used by Widen's old mobile app. No longer used, and `false` will always be returned." }, "releaseDate" : { "type" : "string", "format" : "date-time", "description" : "The release date to assign to the asset being uploaded with this profile." }, "title" : { "type" : "string", "description" : "The display name of the upload profile.", "example" : "Public Upload Profile" }, "uuid" : { "type" : "string" } } }, "UploadProfilesResponse" : { "type" : "object", "properties" : { "uploadProfiles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UploadProfile" } } } }, "UploadStatus" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "Indicates whether the upload was successful." } } }, "UploadStatusWithError" : { "type" : "object", "properties" : { "error" : { "type" : "string", "description" : "An error detail message returned with a failed upload." }, "success" : { "type" : "boolean", "description" : "Indicates whether the upload was successful." } } }, "UploadStatusWithUuid" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "Indicates whether the upload was successful." }, "uuid" : { "type" : "string", "description" : "The uuid of the newly uploaded Asset.", "example" : "3bce5d5c-6ffc-4396-96fe-2e8795d8f991" } } }, "UserAddressFieldsResponse" : { "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "company" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "country" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "email" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "firstName" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "lastName" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "phone" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "postalCode" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "stateOrProvince" : { "$ref" : "#/components/schemas/UserAddressValueResponse" }, "streetAddress" : { "$ref" : "#/components/schemas/UserAddressValueResponse" } } }, "UserAddressResponse" : { "type" : "object", "properties" : { "fields" : { "$ref" : "#/components/schemas/UserAddressFieldsResponse" }, "uuid" : { "type" : "string", "description" : "The user's address identifier.", "example" : "3bce5d5c-6ffc-4396-96fe-2e8795d8f991" } } }, "UserAddressValueResponse" : { "type" : "object", "properties" : { "required" : { "type" : "boolean", "description" : "Boolean indicator of whether the field is required for account registration." }, "value" : { "type" : "string", "nullable" : true } } }, "Uuids" : { "type" : "object", "description" : "A helper object that stores a list of UUID Strings.", "properties" : { "uuids" : { "type" : "array", "description" : "A list of UUIDs.", "items" : { "type" : "string", "description" : "A list of UUIDs." } } } }, "VideoData" : { "type" : "object", "properties" : { "url" : { "type" : "string" } } }, "VideoUrls" : { "type" : "object", "properties" : { "hd" : { "type" : "string" }, "sd" : { "type" : "string" }, "thumbnail" : { "type" : "string" } } }, "ZipStatus" : { "type" : "object", "properties" : { "archived" : { "type" : "integer", "format" : "int32", "description" : "The number of assets archived so far.", "example" : 27 }, "done" : { "type" : "boolean", "description" : "Boolean to indicate if the archive operation is complete." }, "download" : { "type" : "string", "format" : "uri", "description" : "A download link for the archive or null if archive doesn't exist.", "example" : "https://example.com/download/zipfile.zip" }, "errored" : { "type" : "boolean", "description" : "Boolean to indicate that there was an error creating the archive." }, "total" : { "type" : "integer", "format" : "int32", "description" : "The total number of assets scheduled to be added to the archive.", "example" : 42 } } } }, "securitySchemes" : { "access-token" : { "description" : "Example bearer header: `Authorization: Bearer wac_demo_abc123def456`", "in" : "header", "name" : "Authorization", "type" : "apiKey" }, "basic" : { "description" : "Example basic authentication header: `Authorization: Basic wac_demo_abc123def456:x-oauth-basic` (Note: username and password value must be Base64 encoded per the basic auth specification.)", "scheme" : "basic", "type" : "http" } } } }