{ "openapi": "3.0.1", "info": { "title": "Aprimo DAM REST API", "description": "Programmatic access to Aprimo DAM assets, classifications, and metadata.\n\n**Accept header:** Use `Accept: application/json` for flat JSON responses (recommended for integrations). Use `Accept: application/hal+json` for HAL hypermedia responses with `_links` and `_embedded`.\n\n**Required headers on all requests:** `API-VERSION: 1`, `Authorization: Bearer `, `User-Agent` (sent automatically by most HTTP clients).\n\n**Language:** Include `languages: ` to receive localized field values in a specific language. Accepts a single language ID, comma-separated list, or `*` for all languages.", "version": "v1" }, "servers": [ { "url": "https://{tenant}.dam.aprimo.com/api/core", "description": "Aprimo DAM REST API", "variables": { "tenant": { "default": "your-tenant", "description": "Your Aprimo tenant identifier (the subdomain of your Aprimo DAM URL)." } } } ], "paths": { "/search/classifications": { "post": { "tags": [ "Search" ], "operationId": "CreateSearchClassifications", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationSearchResponse" }, "example": { "totalCount": 1, "page": 1, "pageSize": 50, "items": [ { "id": "f8381f8f40174f4d8c31a832013f4aac", "identifier": "GeneralIdentifier", "name": "General", "namePath": null, "labelPath": null, "sortIndex": 3, "sortOrder": "", "disabledInDAMUI": false, "isRoot": true, "parentId": null, "hasChildren": null, "tag": null, "labels": [ { "value": "General", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "registeredFields": [ { "fieldId": "54c036af9f264a7194acac3600e6d967" } ], "registeredFieldGroups": [ { "fieldGroupId": "40cd3ee808e54c528ec850a372e4de1c" }, { "fieldGroupId": "51b493b7afcb47df874fac39013b4cad" } ], "parent": null, "ancestors": null, "children": null, "fields": null, "recordPermissions": null, "downloadPermissions": null, "classificationTreePermissions": null, "slaveClassifications": null, "followerClassifications": null, "classificationTreePermission": null, "modifiedOn": "2025-04-24T21:26:23.023Z", "createdOn": "2017-11-21T19:22:30.327Z", "createdBy": null, "modifiedBy": null } ] } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "summary": "Search for classifications using a search expression", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationSearchRequest" }, "example": { "searchExpression": { "expression": "Name = 'Marketing*'", "supportWildcards": true }, "logRequest": false } } } } } }, "/search/records": { "post": { "tags": [ "Search" ], "operationId": "CreateSearchRecords", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" }, "example": { "totalCount": 1, "page": 1, "pageSize": 50, "items": [ { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": { "items": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "fieldName": "Abstract", "label": "Abstract", "dataType": "SingleLineText", "localizedValues": [ { "value": "This document outlines the integration between Aprimo DAM and inriver PIM.", "aiInfluenced": true, "languageId": "00000000000000000000000000000000", "modifiedOn": "2025-12-05T16:44:47.747Z" } ], "inheritanceState": null, "inheritable": null } ] }, "masterFileLatestVersion": { "id": "619359a2128e42b88481b3aa01138a31", "versionLabel": "", "versionNumber": 1, "fileName": "Aprimo+inriver Solution Brief.pdf", "fileSize": 2049211, "fileExtension": "pdf", "fileCreatedOn": "2025-12-05T16:43:10Z", "isLatest": true, "fileProcessingState": "Open", "fileState": "Available", "aiInfluenced": "Unknown", "preventDownload": false, "createdOn": "2025-12-05T16:43:12.587Z" }, "masterFileLatestPublishedVersion": null, "classifications": null, "files": null, "permissions": null, "locks": null } ], "facets": [] } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "summary": "Search for records using a search expression", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSearchRequest" }, "examples": { "simpleText": { "summary": "Simple full-text search across all fields", "value": { "searchExpression": { "expression": "AMP-2000" }, "logRequest": false } }, "exactFieldMatch": { "summary": "Exact match on a specific field", "value": { "searchExpression": { "expression": "Title = 'AMP Studio Series Product Sheet'" }, "logRequest": false } }, "containsText": { "summary": "Field contains a word or phrase", "value": { "searchExpression": { "expression": "Title CONTAINS 'Studio Series'" }, "logRequest": false } }, "statusAndContentType": { "summary": "Filter by status and content type", "value": { "searchExpression": { "expression": "ContentType = 'Asset' AND Status = 'Released'" }, "logRequest": false } }, "multipleContentTypes": { "summary": "Match any of several content types", "value": { "searchExpression": { "expression": "ContentType = 'Asset', 'Image', 'Video'" }, "logRequest": false } }, "dateRange": { "summary": "Records created within a date range", "value": { "searchExpression": { "expression": "CreatedOn >= 2025-01-01 AND CreatedOn <= 2025-12-31" }, "logRequest": false } }, "fileExtension": { "summary": "Filter by master file extension", "value": { "searchExpression": { "expression": "LatestVersionOfMasterFile.Extension = 'pdf'" }, "logRequest": false } }, "multipleExtensions": { "summary": "Multiple file extensions using OR", "value": { "searchExpression": { "expression": "LatestVersionOfMasterFile.Extension = 'mp4' OR 'jpg' OR 'pdf'" }, "logRequest": false } }, "hasPublicUri": { "summary": "Records that have a published public URI", "value": { "searchExpression": { "expression": "LatestVersionOfMasterFile.HasPublicUri = true" }, "logRequest": false } }, "fieldNameSyntax": { "summary": "Search using custom metadata field names", "value": { "searchExpression": { "expression": "FieldName(\"Brand\") = 'AMP' AND FieldName(\"ProductLine\") = 'Studio Series'" }, "logRequest": false } }, "wildcardSearch": { "summary": "Wildcard pattern matching on a field", "value": { "searchExpression": { "expression": "Title = 'AMP-*'", "supportWildcards": true }, "logRequest": false } }, "parameterizedQuery": { "summary": "Reusable query using ? placeholders", "value": { "searchExpression": { "expression": "Title CONTAINS ? OR FieldName(\"SKU\") = ?", "parameters": [ "Studio Series", "AMP-2000" ] }, "logRequest": false } }, "namedParameters": { "summary": "Named @parameter placeholders for reusable values", "value": { "searchExpression": { "expression": "CreatedBy.Name = @User OR ModifiedBy.Name = @User", "namedParameters": { "User": "jsmith" } }, "logRequest": false } }, "withFacets": { "summary": "Search with facet aggregations by content type and creation date", "value": { "searchExpression": { "expression": "FieldName(\"Brand\") = 'AMP' AND Status = 'Released'" }, "facets": [ { "name": "byContentType", "type": "contentType" }, { "name": "byCreatedOn", "type": "createdOn" } ], "logRequest": false } }, "combinedConditions": { "summary": "Multiple metadata field conditions combined with AND/OR grouping", "value": { "searchExpression": { "expression": "FieldName(\"Brand\") = \"AMP\" AND FieldName(\"ProductYear\") = 2026 AND (FieldName(\"ProductLine\") = \"Studio Series\" OR FieldName(\"ProductLine\") = \"Pro Series\")" }, "logRequest": false } }, "disabledKeywords": { "summary": "Treat reserved keywords as literal text using disabledKeywords", "value": { "searchExpression": { "expression": "built in amplifier", "disabledKeywords": [ "In" ] }, "logRequest": false } } } } } } } }, "/fileversion/{fileVersionId}/renditions": { "get": { "tags": [ "FileVersion" ], "summary": "Read all renditions of a file version", "operationId": "GetFileversionRenditions", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string" }, "example": "619359a2128e42b88481b3aa01138a31" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenditionCollection" }, "example": { "items": [ { "id": "619359a2128e42b88481b3aa01138a31", "name": "Original file", "type": "Original", "extension": "pdf", "uri": null, "publishedUri": null, "publicLinks": null, "preview": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/rendition/{renditionId}": { "get": { "tags": [ "Rendition" ], "summary": "Read a single rendition", "operationId": "GetRenditionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "renditionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string" }, "example": "619359a2128e42b88481b3aa01138a31" }, { "name": "select-rendition", "in": "header", "required": false, "description": "Embed sub-resources inline.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "publiclinks" ] } }, "example": [ "publiclinks" ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rendition" }, "example": { "id": "619359a2128e42b88481b3aa01138a31", "name": "Original file", "type": "Original", "extension": "pdf", "uri": null, "publishedUri": null, "publicLinks": null, "preview": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-rendition` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." } }, "/record/{recordId}": { "get": { "tags": [ "Record" ], "summary": "Read a single record", "operationId": "GetRecordById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string" }, "example": "fa7eb97fe1ef4f5c8554b3aa011387ec" }, { "name": "select-record", "in": "header", "required": false, "description": "Embed record sub-resources inline. Comma-separate multiple values e.g. `fields,masterfilelatestversion`. Without this header those properties are null in the response. Select headers cascade — the API limits any single resource type to a maximum of 2 occurrences in an embedding chain to prevent infinite recursion.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "fields", "files", "preview", "thumbnail", "masterfile", "masterfilelatestversion", "masterfilelatestpublishedversion", "classifications", "accesslists", "permissions", "locks", "analyticsdata", "managedcontent", "modifiedby", "createdby" ] } }, "example": [ "fields", "files" ] }, { "name": "select-record-fields", "in": "header", "required": false, "description": "When `select-record: fields` is used, filters which fields are returned. Accepts comma-separated field names or IDs. Without this header all fields are returned.", "schema": { "type": "string" }, "example": "Title,Abstract" }, { "name": "select-record-fieldgroups", "in": "header", "required": false, "description": "When `select-record: fields` is used, filters fields to those belonging to the specified field groups. Accepts comma-separated field group IDs or URL-encoded names.", "schema": { "type": "string" }, "example": "MyFieldGroup" }, { "name": "select-fileversion", "in": "header", "required": false, "description": "Cascades into any embedded FileVersion object (e.g. from `select-record: masterfilelatestversion`, or from `select-file: fileversions/latestversion`). Embeds sub-resources on the FileVersion inline.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "filetype", "filepreviews", "masterfilepreview", "preview", "thumbnail", "additionalfiles", "renditions", "publiclinks", "watermark", "publicuris", "permissions", "createdby" ] } }, "example": [ "filetype", "filepreviews" ] }, { "name": "select-file", "in": "header", "required": false, "description": "Cascades into any embedded File object (e.g. from `select-record: files` or `select-record: masterfile`). Embeds sub-resources on the File inline.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "preview", "thumbnail", "fileversions", "latestversion", "fields", "checkedoutby", "watermark", "createdby" ] } }, "example": [ "preview", "thumbnail" ] }, { "name": "select-classification", "in": "header", "required": false, "description": "Cascades into any embedded Classification object (e.g. from `select-record: classifications`). Embeds sub-resources on each Classification inline.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "parent", "ancestors", "children", "image", "fields", "recordpermissions", "downloadpermissions", "classificationtreepermissions", "slaveclassifications", "followerclassifications", "classificationtreepermission", "modifiedby", "createdby" ] } }, "example": [ "parent", "ancestors" ] }, { "name": "select-user", "in": "header", "required": false, "description": "Cascades into any embedded User object (e.g. from `select-record: modifiedby/createdby`, `select-file: createdby/checkedoutby`). Embeds sub-resources on the User inline.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "fields", "memberships", "permissions", "image", "modifiedby", "createdby" ] } }, "example": [ "fields", "memberships" ] }, { "$ref": "#/components/parameters/Languages" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Record" }, "examples": { "bare": { "summary": "No select headers — scalar fields only, all sub-resources null", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "textContent": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "classifications": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null } }, "withFields": { "summary": "select-record: fields — metadata fields embedded", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": { "items": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "fieldName": "Abstract", "label": "Abstract", "dataType": "SingleLineText", "definition": null, "inheritanceState": null, "inheritable": null, "localizedValues": [ { "value": "This document outlines the integration between Aprimo DAM and inriver PIM.", "aiInfluenced": true, "languageId": "00000000000000000000000000000000", "readOnly": null, "modifiedOn": "2025-12-05T16:44:47.747Z" } ] } ] }, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "classifications": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null } }, "withFiles": { "summary": "select-record: files — file objects embedded", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": null, "files": { "items": [ { "id": "ce1e7c4b4b3f4c04bd18b3aa01138a31", "checkedOut": false, "checkedOutOn": null, "checkedOutBy": null, "watermarkId": "00000000000000000000000000000000", "watermarkType": "UseSetting", "watermark": null, "preview": null, "thumbnail": null, "fileVersions": null, "latestVersion": null, "fields": null, "createdOn": "2025-12-05T16:43:12.587Z", "createdBy": null } ] }, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "classifications": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null } }, "withClassifications": { "summary": "select-record: classifications — classification memberships embedded", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "classifications": { "items": [ { "id": "91a5f46165344a37aa07a84200a5c208", "sortIndex": 2147483647, "isManual": true, "target": null }, { "id": "ee2708c7026745528c0db3aa0112ab86", "sortIndex": 2147483647, "isManual": true, "target": null }, { "id": "f8381f8f40174f4d8c31a832013f4aac", "sortIndex": 2147483647, "isManual": true, "target": null } ] }, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null } }, "withPreview": { "summary": "select-record: preview — preview image metadata and time-limited URI", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": { "size": 93368, "width": 612, "height": 792, "extension": "jpg", "uri": "https://s1.sb.previews.aprimo.com/your-tenant/...preview.jpg?sv=...&sig=..." }, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withThumbnail": { "summary": "select-record: thumbnail — thumbnail image metadata and time-limited URI", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": { "size": 8915, "width": 124, "height": 160, "extension": "jpg", "uri": "https://s1.sb.previews.aprimo.com/your-tenant/...thumbnail.jpg?sv=...&sig=..." }, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withMasterFile": { "summary": "select-record: masterfile — master file object embedded", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": { "id": "ce1e7c4b4b3f4c04bd18b3aa01138a31", "checkedOut": false, "checkedOutOn": null, "checkedOutBy": null, "watermarkId": "00000000000000000000000000000000", "watermarkType": "UseSetting", "watermark": null, "preview": null, "thumbnail": null, "fileVersions": null, "latestVersion": null, "fields": null, "createdOn": "2025-12-05T16:43:12.587Z", "createdBy": null }, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withMasterFileLatestPublishedVersion": { "summary": "select-record: masterfilelatestpublishedversion — null if no published version exists", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withAccessLists": { "summary": "select-record: accesslists — access list memberships embedded", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": { "items": [] }, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withPermissions": { "summary": "select-record: permissions — current user permissions on the record", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": { "canRead": true, "canReadAllVersions": true, "canModify": true, "canDelete": true, "hasFullControl": true, "canDownload": true }, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withLocks": { "summary": "select-record: locks — checkout lock information", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": { "items": [] }, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withAnalyticsData": { "summary": "select-record: analyticsdata — view and download counts", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": { "views": 1, "downloads": 0 }, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withManagedContent": { "summary": "select-record: managedcontent — null if record has no managed content", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": null } }, "withModifiedBy": { "summary": "select-record: modifiedby — user who last modified the record", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": { "id": "2dd66657db834b579a12a96c00ed6522", "name": "jdoe", "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com", "imageUri": "", "aprimoUserId": 3808, "isActive": true, "storageQuota": -1, "storageUsed": 193865329152, "modifiedOn": "2026-05-11T19:22:52.923Z", "createdOn": "2018-10-01T14:24:19.733Z", "tag": null, "fields": null, "memberships": null, "permissions": null, "image": null, "expirationDate": null, "lastSuccessfulLogOnDate": "2026-05-11T19:23:48.85Z" }, "createdBy": null } }, "withCreatedBy": { "summary": "select-record: createdby — user who created the record", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "fields": null, "files": null, "classifications": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": null, "masterFileLatestPublishedVersion": null, "accessLists": null, "permissions": null, "locks": null, "analyticsData": null, "managedContent": null, "modifiedBy": null, "createdBy": { "id": "2dd66657db834b579a12a96c00ed6522", "name": "jdoe", "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com", "imageUri": "", "aprimoUserId": 3808, "isActive": true, "storageQuota": -1, "storageUsed": 193865329152, "modifiedOn": "2026-05-11T19:22:52.923Z", "createdOn": "2018-10-01T14:24:19.733Z", "tag": null, "fields": null, "memberships": null, "permissions": null, "image": null, "expirationDate": null, "lastSuccessfulLogOnDate": "2026-05-11T19:23:48.85Z" } } }, "withMasterFileLatestVersion": { "summary": "select-record: masterfilelatestversion — file version embedded, its sub-resources still null", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": { "id": "619359a2128e42b88481b3aa01138a31", "versionLabel": "", "versionNumber": 1, "fileName": "Aprimo+inriver Solution Brief.pdf", "fileCreatedOn": "2025-12-05T16:43:10Z", "fileModifiedOn": "2025-12-05T16:43:10Z", "fileSize": 2049211, "fileExtension": "pdf", "comment": "", "isLatest": true, "fileProcessingState": "Open", "fileState": "Available", "aiInfluenced": "Unknown", "preventDownload": false, "watermarkId": "00000000000000000000000000000000", "watermarkType": "InheritFromFile", "crc32": -837030814, "createdOn": "2025-12-05T16:43:12.587Z", "filePreviews": null, "renditions": null, "publicLinks": null, "publicUris": null, "thumbnail": null, "preview": null, "permissions": null }, "masterFileLatestPublishedVersion": null, "classifications": null, "permissions": null, "locks": null } }, "withMasterFileAndPublicLinks": { "summary": "select-record: masterfilelatestversion + select-fileversion: publiclinks — cascaded embed", "value": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "masterFileLatestVersion": { "id": "619359a2128e42b88481b3aa01138a31", "versionLabel": "", "versionNumber": 1, "fileName": "Aprimo+inriver Solution Brief.pdf", "fileCreatedOn": "2025-12-05T16:43:10Z", "fileModifiedOn": "2025-12-05T16:43:10Z", "fileSize": 2049211, "fileExtension": "pdf", "comment": "", "isLatest": true, "fileProcessingState": "Open", "fileState": "Available", "aiInfluenced": "Unknown", "preventDownload": false, "watermarkId": "00000000000000000000000000000000", "watermarkType": "InheritFromFile", "crc32": -837030814, "createdOn": "2025-12-05T16:43:12.587Z", "filePreviews": null, "renditions": null, "thumbnail": null, "preview": null, "publicUris": null, "permissions": null, "publicLinks": { "items": [ { "id": "d62e6222a408488ea838001421e4dc6b", "uri": "https://p1.sb.aprimocdn.net/productstrategy1/fa7eb97f-e1ef-4f5c-8554-b3aa011387ec/Aprimo%2Binriver%20Solution%20Brief.pdf_Original%20file.pdf", "status": "Published", "canDelete": true, "provider": "FastlyCDN", "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "fileVersionId": "619359a2128e42b88481b3aa01138a31", "additionalFileId": null, "fileSize": 2049211, "renditionName": "", "origin": "Order", "modifiedOn": "2026-05-11T14:37:29.85Z", "createdOn": "2026-05-11T14:37:26.773Z", "createdBy": null, "modifiedBy": null } ] } }, "masterFileLatestPublishedVersion": null, "classifications": null, "permissions": null, "locks": null } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-record`, `select-record-fields`, `select-record-fieldgroups`, `select-fileversion`, `select-file`, `select-classification`, `select-user` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Select headers cascade: `select-record-fields` applies to any embedded object of that type returned by `select-record`. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." }, "put": { "tags": [ "Record" ], "summary": "Edit an existing record.", "operationId": "UpdateRecordById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "fa7eb97fe1ef4f5c8554b3aa011387ec" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordEditRequest" }, "example": { "status": "Released", "fields": { "addOrUpdate": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "value": "Updated Title" } ] } ] }, "classifications": { "addOrUpdate": [ { "id": "f8381f8f40174f4d8c31a832013f4aac", "sortIndex": 1 } ], "remove": [ { "id": "ee2708c7026745528c0db3aa0112ab86" } ] } } } } } }, "delete": { "tags": [ "Record" ], "summary": "Delete the specified record.", "operationId": "DeleteRecordById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "fa7eb97fe1ef4f5c8554b3aa011387ec" } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } } } }, "/records": { "get": { "tags": [ "Record" ], "summary": "Read a collection of records", "operationId": "GetRecords", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.", "schema": { "type": "string" }, "example": "Status = 'Released'" }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" }, { "$ref": "#/components/parameters/Languages" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCollection" }, "example": { "totalCount": 1, "offset": 0, "limit": 50, "items": [ { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": { "items": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "fieldName": "Abstract", "label": "Abstract", "dataType": "SingleLineText", "localizedValues": [ { "value": "This document outlines the integration between Aprimo DAM and inriver PIM.", "aiInfluenced": true, "languageId": "00000000000000000000000000000000", "modifiedOn": "2025-12-05T16:44:47.747Z" } ], "inheritanceState": null, "inheritable": null } ] }, "masterFileLatestVersion": { "id": "619359a2128e42b88481b3aa01138a31", "versionLabel": "", "versionNumber": 1, "fileName": "Aprimo+inriver Solution Brief.pdf", "fileSize": 2049211, "fileExtension": "pdf", "fileCreatedOn": "2025-12-05T16:43:10Z", "isLatest": true, "fileProcessingState": "Open", "fileState": "Available", "aiInfluenced": "Unknown", "preventDownload": false, "createdOn": "2025-12-05T16:43:12.587Z" }, "masterFileLatestPublishedVersion": null, "classifications": null, "files": null, "permissions": null, "locks": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "Record" ], "summary": "Creates a new record. In order to successfully create a record, the record needs to be classified.", "operationId": "CreateRecords", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Record" }, "example": { "id": "fa7eb97fe1ef4f5c8554b3aa011387ec", "status": "Released", "contentType": "Asset", "title": null, "tag": null, "aiInfluenced": "No", "hasImageOverlay": false, "modifiedOn": "2026-05-11T14:37:29.927Z", "createdOn": "2025-12-05T16:43:10.65Z", "createdBy": null, "modifiedBy": null, "fields": { "items": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "fieldName": "Abstract", "label": "Abstract", "dataType": "SingleLineText", "localizedValues": [ { "value": "This document outlines the integration between Aprimo DAM and inriver PIM.", "aiInfluenced": true, "languageId": "00000000000000000000000000000000", "modifiedOn": "2025-12-05T16:44:47.747Z" } ], "inheritanceState": null, "inheritable": null } ] }, "masterFileLatestVersion": { "id": "619359a2128e42b88481b3aa01138a31", "versionLabel": "", "versionNumber": 1, "fileName": "Aprimo+inriver Solution Brief.pdf", "fileSize": 2049211, "fileExtension": "pdf", "fileCreatedOn": "2025-12-05T16:43:10Z", "isLatest": true, "fileProcessingState": "Open", "fileState": "Available", "aiInfluenced": "Unknown", "preventDownload": false, "createdOn": "2025-12-05T16:43:12.587Z" }, "masterFileLatestPublishedVersion": null, "classifications": null, "files": null, "permissions": null, "locks": null } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCreateRequest" }, "example": { "contentType": "Asset", "classifications": { "addOrUpdate": [ { "id": "f8381f8f40174f4d8c31a832013f4aac", "sortIndex": 1 } ] }, "fields": { "addOrUpdate": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "value": "My Asset Title" } ] } ] } } } } } } }, "/publicuri/{publicUriId}": { "get": { "tags": [ "PublicUri" ], "summary": "Read a single public URI", "operationId": "GetPublicuriById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "publicUriId", "in": "path", "description": "id of the public link", "required": true, "schema": { "type": "string" }, "example": "d62e6222a408488ea838001421e4dc6b" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUri" }, "example": { "id": "d62e6222a408488ea838001421e4dc6b", "uri": "https://p1.sb.aprimocdn.net/productstrategy1/fa7eb97f-e1ef-4f5c-8554-b3aa011387ec/asset_Original%20file.pdf", "fileName": null, "renditionName": "Original file", "renditionType": "Original", "status": "Published", "provider": "FastlyCDN", "origin": "Order", "canDelete": true, "targetType": null, "targetId": null, "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "fileVersionId": "619359a2128e42b88481b3aa01138a31", "renditionId": "619359a2128e42b88481b3aa01138a31", "createdOn": "2026-05-11T14:37:26.773Z", "modifiedOn": "2026-05-11T14:37:29.85Z", "createdBy": null, "modifiedBy": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/publiclink/{publicLinkId}": { "get": { "tags": [ "PublicLink" ], "summary": "Read a single public link", "operationId": "GetPubliclinkById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "publicLinkId", "in": "path", "description": "id of the public link", "required": true, "schema": { "type": "string" }, "example": "d62e6222a408488ea838001421e4dc6b" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLink" }, "example": { "id": "d62e6222a408488ea838001421e4dc6b", "uri": "https://p1.sb.aprimocdn.net/productstrategy1/fa7eb97f-e1ef-4f5c-8554-b3aa011387ec/asset_Original%20file.pdf", "status": "Published", "provider": "FastlyCDN", "renditionName": "", "origin": "Order", "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "fileVersionId": "619359a2128e42b88481b3aa01138a31", "additionalFileId": null, "fileSize": 2049211, "canDelete": true, "createdOn": "2026-05-11T14:37:26.773Z", "modifiedOn": "2026-05-11T14:37:29.85Z", "createdBy": null, "modifiedBy": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "PublicLink" ], "summary": "Edits existing public link", "operationId": "UpdatePubliclinkById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "publicLinkId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "d62e6222a408488ea838001421e4dc6b" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkEditRequest" }, "example": { "renditionName": "Web", "URI": "https://cdn.example.com/asset.jpg", "provider": "Aprimo", "fileSize": 204800 } } } } }, "delete": { "tags": [ "PublicLink" ], "summary": "Delete the specified public link", "operationId": "DeletePubliclinkById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "publicLinkId", "in": "path", "description": "id of the public link", "required": true, "schema": { "type": "string" }, "example": "d62e6222a408488ea838001421e4dc6b" } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } } } }, "/orders": { "get": { "tags": [ "Order" ], "summary": "Read a collection of orders", "operationId": "GetOrders", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.", "schema": { "type": "string" }, "example": "Status = 'Released'" }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCollection" }, "example": { "totalCount": 1, "offset": 0, "limit": 50, "items": [ { "id": "57c64d65b581441f8fccb4490144aefb", "type": "DownloadOrder", "orderType": "download", "status": "Success", "message": "", "failedTargetsCount": 0, "totalFileSize": 2049211, "deliveredFiles": [ "https://your-tenant.dam.aprimo.com/api/core/download?token=" ], "creatorEmail": "user@example.com", "disableNotification": true, "priority": 0, "useCDN": "Automatic", "disableProcessing": "No", "executionTime": "00:00:00.182", "createdOn": "2026-05-13T19:42:08.095Z", "startedOn": "2026-05-13T19:42:08.345Z", "earliestStartDate": null, "targets": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "Order" ], "summary": "Creates a new order.", "operationId": "CreateOrders", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" }, "example": { "id": "57c64d65b581441f8fccb4490144aefb", "type": "DownloadOrder", "orderType": "download", "status": "Success", "message": "", "failedTargetsCount": 0, "totalFileSize": 2049211, "deliveredFiles": [ "https://your-tenant.dam.aprimo.com/api/core/download?token=" ], "creatorEmail": "user@example.com", "disableNotification": true, "priority": 0, "useCDN": "Automatic", "disableProcessing": "No", "executionTime": "00:00:00.182", "createdOn": "2026-05-13T19:42:08.095Z", "startedOn": "2026-05-13T19:42:08.345Z", "earliestStartDate": null, "targets": null } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateRequest" }, "example": { "type": "download", "targets": [ { "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "targetTypes": [ "Original" ], "assetType": "LatestVersionOfMasterFile" } ], "disableNotification": true } } } } } }, "/order/{orderId}": { "get": { "tags": [ "Order" ], "summary": "Read a single order", "operationId": "GetOrderById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "orderId", "in": "path", "description": "id of the order", "required": true, "schema": { "type": "string" }, "example": "57c64d65b581441f8fccb4490144aefb" }, { "name": "select-order", "in": "header", "required": false, "description": "Embed sub-resources inline. Comma-separate multiple values.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "targets", "createdby" ] } }, "example": [ "targets", "createdby" ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" }, "example": { "id": "57c64d65b581441f8fccb4490144aefb", "type": "DownloadOrder", "orderType": "download", "status": "Success", "message": "", "failedTargetsCount": 0, "totalFileSize": 2049211, "deliveredFiles": [ "https://your-tenant.dam.aprimo.com/api/core/download?token=" ], "creatorEmail": "user@example.com", "disableNotification": true, "priority": 0, "useCDN": "Automatic", "disableProcessing": "No", "executionTime": "00:00:00.182", "createdOn": "2026-05-13T19:42:08.095Z", "startedOn": "2026-05-13T19:42:08.345Z", "earliestStartDate": null, "targets": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-order` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." } }, "/file/{fileId}/fileversions": { "get": { "tags": [ "File" ], "summary": "Read all file versions of a file", "operationId": "GetFileFileversions", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string" }, "example": "ce1e7c4b4b3f4c04bd18b3aa01138a31" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/fileversion/{fileVersionId}/publicuris": { "get": { "tags": [ "FileVersion" ], "summary": "Read the public uris for the file version", "operationId": "GetFileversionPublicuris", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string" }, "example": "619359a2128e42b88481b3aa01138a31" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUriCollection" }, "example": { "items": [ { "id": "d62e6222a408488ea838001421e4dc6b", "uri": "https://p1.sb.aprimocdn.net/productstrategy1/fa7eb97f-e1ef-4f5c-8554-b3aa011387ec/asset_Original%20file.pdf", "fileName": null, "renditionName": "Original file", "renditionType": "Original", "status": "Published", "provider": "FastlyCDN", "origin": "Order", "canDelete": true, "targetType": null, "targetId": null, "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "fileVersionId": "619359a2128e42b88481b3aa01138a31", "renditionId": "619359a2128e42b88481b3aa01138a31", "createdOn": "2026-05-11T14:37:26.773Z", "modifiedOn": "2026-05-11T14:37:29.85Z", "createdBy": null, "modifiedBy": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/fileversion/{fileVersionId}/publiclinks": { "get": { "tags": [ "FileVersion" ], "summary": "Read public links for a file version", "operationId": "GetFileversionPubliclinks", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fileVersionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "619359a2128e42b88481b3aa01138a31" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkCollection" }, "example": { "items": [ { "id": "d62e6222a408488ea838001421e4dc6b", "uri": "https://p1.sb.aprimocdn.net/productstrategy1/fa7eb97f-e1ef-4f5c-8554-b3aa011387ec/asset_Original%20file.pdf", "status": "Published", "provider": "FastlyCDN", "renditionName": "", "origin": "Order", "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "fileVersionId": "619359a2128e42b88481b3aa01138a31", "additionalFileId": null, "fileSize": 2049211, "canDelete": true, "createdOn": "2026-05-11T14:37:26.773Z", "modifiedOn": "2026-05-11T14:37:29.85Z", "createdBy": null, "modifiedBy": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/file/{fileId}/latestversion": { "get": { "tags": [ "File" ], "summary": "Read the latest file version", "operationId": "GetFileLatestversion", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string" }, "example": "ce1e7c4b4b3f4c04bd18b3aa01138a31" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersion" }, "example": { "id": "619359a2128e42b88481b3aa01138a31", "versionLabel": "", "versionNumber": 1, "fileName": "Aprimo+inriver Solution Brief.pdf", "fileSize": 2049211, "fileExtension": "pdf", "fileCreatedOn": "2025-12-05T16:43:10Z", "isLatest": true, "fileProcessingState": "Open", "fileState": "Available", "aiInfluenced": "Unknown", "preventDownload": false, "createdOn": "2025-12-05T16:43:12.587Z" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/fieldgroup/{fieldGroupId}": { "get": { "tags": [ "FieldGroup" ], "summary": "Read a single field group", "operationId": "GetFieldgroupById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string" }, "example": "40cd3ee808e54c528ec850a372e4de1c" }, { "name": "select-fieldgroup", "in": "header", "required": false, "description": "Embed sub-resources inline. Comma-separate multiple values.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "members", "modifiedby", "createdby" ] } }, "example": [ "members", "modifiedby" ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldGroup" }, "example": { "id": "40cd3ee808e54c528ec850a372e4de1c", "name": "All Fields", "members": null, "tag": null, "modifiedOn": "2026-02-25T21:20:36.93Z", "createdOn": "2017-11-06T23:04:01.26Z", "createdBy": null, "modifiedBy": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-fieldgroup` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." }, "put": { "tags": [ "FieldGroup" ], "summary": "Edit an existing field group.", "operationId": "UpdateFieldgroupById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fieldGroupId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "40cd3ee808e54c528ec850a372e4de1c" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldGroupEditRequest" }, "example": { "name": "Updated Field Group Name", "members": { "addOrUpdate": [ "a07842ae9c7d4eb9a43ab2b801540674" ], "remove": [] } } } } } }, "delete": { "tags": [ "FieldGroup" ], "summary": "Delete the specified field group.", "operationId": "DeleteFieldgroupById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fieldGroupId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "40cd3ee808e54c528ec850a372e4de1c" } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } } } }, "/fieldgroups": { "get": { "tags": [ "FieldGroup" ], "summary": "Read a collection of field groups", "operationId": "GetFieldgroups", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.", "schema": { "type": "string" }, "example": "Status = 'Released'" }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldGroupCollection" }, "example": { "totalCount": 1, "offset": 0, "limit": 50, "items": [ { "id": "40cd3ee808e54c528ec850a372e4de1c", "name": "All Fields", "members": null, "tag": null, "modifiedOn": "2026-02-25T21:20:36.93Z", "createdOn": "2017-11-06T23:04:01.26Z", "createdBy": null, "modifiedBy": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "FieldGroup" ], "summary": "Creates a new field group.", "operationId": "CreateFieldgroups", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldGroupCreateRequest" }, "example": { "name": "Asset Metadata", "members": { "addOrUpdate": [ "a07842ae9c7d4eb9a43ab2b801540674" ] } } } } } } }, "/fielddefinition/{fieldDefinitionId}": { "get": { "tags": [ "FieldDefinition" ], "summary": "Read a single field definition", "operationId": "GetFielddefinitionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fieldDefinitionId", "in": "path", "description": "id of the field definition", "required": true, "schema": { "type": "string" }, "example": "6e9807ce16bd4960bda1b26327633896" }, { "name": "select-fielddefinition", "in": "header", "required": false, "description": "Embed sub-resources inline. Comma-separate multiple values.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "createdby", "modifiedby" ] } }, "example": [ "createdby", "modifiedby" ] }, { "$ref": "#/components/parameters/Languages" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinition" }, "example": { "id": "6e9807ce16bd4960bda1b26327633896", "name": "ADAM_Video_Width", "label": "Width", "labels": [ { "value": "Width", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "helpText": "Width", "helpTexts": [ { "value": "Width", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "dataType": "Numeric", "scope": "RecordContentContentTypeDependent", "scopeCategory": "Record", "indexed": true, "languageMode": "Single", "memberships": [ "29075cc44d9248c581d4d44b80103f48", "40cd3ee808e54c528ec850a372e4de1c" ], "enabledLanguages": [], "isRequired": false, "isReadOnly": true, "isUniqueIdentifier": false, "sortIndex": 1, "inlineStyle": "", "defaultValue": "", "validation": "", "validationErrorMessage": "", "validationTrigger": "Always", "storageMode": "NonEmptyValues", "resetToDefaultTriggers": [ "OnNewField", "OnMasterFileChange" ], "resetToDefaultFields": [], "searchIndexRebuildRequired": false, "accuracy": 1, "range": "", "tag": null, "createdOn": "2017-11-06T23:04:01.59Z", "modifiedOn": "2017-11-06T23:04:01.59Z", "createdBy": null, "modifiedBy": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-fielddefinition` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." }, "put": { "tags": [ "FieldDefinition" ], "summary": "Edit an existing field definition.", "operationId": "UpdateFielddefinitionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "6e9807ce16bd4960bda1b26327633896" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionEditRequest" }, "example": { "isReadOnly": false, "defaultValue": "0", "resetToDefaultTriggers": [ "OnNewField", "OnMasterFileChange" ], "storageMode": "logChanges" } } } } }, "delete": { "tags": [ "FieldDefinition" ], "summary": "Delete the specified field definition.", "operationId": "DeleteFielddefinitionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "6e9807ce16bd4960bda1b26327633896" } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } } } }, "/fielddefinitions": { "get": { "tags": [ "FieldDefinition" ], "summary": "Read a collection of field definitions", "operationId": "GetFielddefinitions", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.", "schema": { "type": "string" }, "example": "Status = 'Released'" }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" }, { "$ref": "#/components/parameters/Languages" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionCollection" }, "example": { "totalCount": 1, "offset": 0, "limit": 50, "items": [ { "id": "6e9807ce16bd4960bda1b26327633896", "name": "ADAM_Video_Width", "label": "Width", "labels": [ { "value": "Width", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "helpText": "Width", "helpTexts": [ { "value": "Width", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "dataType": "Numeric", "scope": "RecordContentContentTypeDependent", "scopeCategory": "Record", "indexed": true, "languageMode": "Single", "memberships": [ "29075cc44d9248c581d4d44b80103f48", "40cd3ee808e54c528ec850a372e4de1c" ], "enabledLanguages": [], "isRequired": false, "isReadOnly": true, "isUniqueIdentifier": false, "sortIndex": 1, "inlineStyle": "", "defaultValue": "", "validation": "", "validationErrorMessage": "", "validationTrigger": "Always", "storageMode": "NonEmptyValues", "resetToDefaultTriggers": [ "OnNewField", "OnMasterFileChange" ], "resetToDefaultFields": [], "searchIndexRebuildRequired": false, "accuracy": 1, "range": "", "tag": null, "createdOn": "2017-11-06T23:04:01.59Z", "modifiedOn": "2017-11-06T23:04:01.59Z", "createdBy": null, "modifiedBy": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "FieldDefinition" ], "summary": "Creates a new field definition.", "operationId": "CreateFielddefinitions", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionCreateRequest" }, "example": { "name": "assetCost", "dataType": "numeric", "scope": "recordContentGlobal", "languageMode": "multiple", "indexed": false, "isRequired": false, "isReadOnly": false, "labels": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "Asset Cost" } ], "accuracy": "0.01", "range": "0-1000000" } } } } } }, "/collection/{collectionId}": { "get": { "tags": [ "Collection" ], "summary": "Read a single collection", "operationId": "GetCollectionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string" }, "example": "66701e3a1bd2405ea375b3b401531d19" }, { "name": "select-collection", "in": "header", "required": false, "description": "Embed sub-resources inline. Comma-separate multiple values.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ownedby", "permissions", "records", "comments", "modifiedby", "createdby" ] } }, "example": [ "ownedby", "permissions" ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collection" }, "example": { "id": "66701e3a1bd2405ea375b3b401531d19", "name": "Product Briefs", "description": "A collection that contains Product Brief assets", "type": "Static", "status": "Active", "searchExpression": null, "searchCriteria": null, "ownerId": "2dd66657db834b579a12a96c00ed6522", "ownedBy": null, "permissions": null, "records": null, "comments": null, "tag": null, "isReadOnly": null, "modifiedOn": "2025-12-15T20:36:40.467Z", "createdOn": "2025-12-15T20:34:40.503Z", "createdBy": null, "modifiedBy": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-collection` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." }, "put": { "tags": [ "Collection" ], "summary": "Edit an existing collection.", "operationId": "UpdateCollectionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "66701e3a1bd2405ea375b3b401531d19" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEditRequest" }, "example": { "name": "Q1 Campaign Assets - Updated", "description": "Updated description" } } } } }, "delete": { "tags": [ "Collection" ], "summary": "Deletes the specified collection", "operationId": "DeleteCollectionById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "66701e3a1bd2405ea375b3b401531d19" } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } } } }, "/collections": { "get": { "tags": [ "Collection" ], "summary": "Read all collections", "operationId": "GetCollections", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.", "schema": { "type": "string" }, "example": "Status = 'Released'" }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionCollection" }, "example": { "totalCount": 1, "offset": 0, "limit": 50, "items": [ { "id": "66701e3a1bd2405ea375b3b401531d19", "name": "Product Briefs", "description": "A collection that contains Product Brief assets", "type": "Static", "status": "Active", "searchExpression": null, "searchCriteria": null, "ownerId": "2dd66657db834b579a12a96c00ed6522", "ownedBy": null, "permissions": null, "records": null, "comments": null, "tag": null, "isReadOnly": null, "modifiedOn": "2025-12-15T20:36:40.467Z", "createdOn": "2025-12-15T20:34:40.503Z", "createdBy": null, "modifiedBy": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "Collection" ], "summary": "Creates a new collection.", "operationId": "CreateCollections", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collection" }, "example": { "id": "66701e3a1bd2405ea375b3b401531d19", "name": "Product Briefs", "description": "A collection that contains Product Brief assets", "type": "Static", "status": "Active", "searchExpression": null, "searchCriteria": null, "ownerId": "2dd66657db834b579a12a96c00ed6522", "ownedBy": null, "permissions": null, "records": null, "comments": null, "tag": null, "isReadOnly": null, "modifiedOn": "2025-12-15T20:36:40.467Z", "createdOn": "2025-12-15T20:34:40.503Z", "createdBy": null, "modifiedBy": null } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionCreateRequest" }, "example": { "name": "Q1 Campaign Assets", "description": "Assets for the Q1 marketing campaign", "type": "static" } } } } } }, "/classification/{classificationId}": { "get": { "tags": [ "Classification" ], "summary": "Read a single classification by id", "operationId": "GetClassificationById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string" }, "example": "f8381f8f40174f4d8c31a832013f4aac" }, { "name": "select-classification", "in": "header", "required": false, "description": "Embed sub-resources inline. Comma-separate multiple values.", "style": "simple", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "parent", "ancestors", "children", "image", "fields", "recordpermissions", "downloadpermissions", "classificationtreepermissions", "slaveclassifications", "followerclassifications", "classificationtreepermission", "modifiedby", "createdby" ] } }, "example": [ "parent", "ancestors" ] }, { "$ref": "#/components/parameters/Languages" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" }, "example": { "id": "f8381f8f40174f4d8c31a832013f4aac", "identifier": "GeneralIdentifier", "name": "General", "namePath": null, "labelPath": null, "sortIndex": 3, "sortOrder": "", "disabledInDAMUI": false, "isRoot": true, "parentId": null, "hasChildren": null, "tag": null, "labels": [ { "value": "General", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "registeredFields": [ { "fieldId": "54c036af9f264a7194acac3600e6d967" } ], "registeredFieldGroups": [ { "fieldGroupId": "40cd3ee808e54c528ec850a372e4de1c" }, { "fieldGroupId": "51b493b7afcb47df874fac39013b4cad" } ], "parent": null, "ancestors": null, "children": null, "fields": null, "recordPermissions": null, "downloadPermissions": null, "classificationTreePermissions": null, "slaveClassifications": null, "followerClassifications": null, "classificationTreePermission": null, "modifiedOn": "2025-04-24T21:26:23.023Z", "createdOn": "2017-11-21T19:22:30.327Z", "createdBy": null, "modifiedBy": null } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "description": "**Select headers:** Use `select-classification` to embed sub-resources inline in the response. Properties are `null` by default until the corresponding select header value is included. Discover available values at runtime by calling this endpoint with `Accept: application/hal+json`." }, "put": { "tags": [ "Classification" ], "summary": "Edit an existing classification.", "operationId": "UpdateClassificationById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "classificationId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "f8381f8f40174f4d8c31a832013f4aac" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationEditRequest" }, "example": { "name": "Updated Category Name", "sortIndex": 5 } } } } }, "delete": { "tags": [ "Classification" ], "summary": "Deletes the specified classification", "operationId": "DeleteClassificationById", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "classificationId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "f8381f8f40174f4d8c31a832013f4aac" } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } } } }, "/classifications": { "get": { "tags": [ "Classification" ], "summary": "Read a collection of classifications", "operationId": "GetClassifications", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" }, { "name": "page", "in": "query", "description": "Page number (1-based). Use together with pageSize.", "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "Number of items per page. Use together with page.", "schema": { "type": "integer" }, "example": 50 }, { "name": "skip", "in": "query", "description": "Number of items to skip. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items to return. Alternative to page/pageSize pagination.", "schema": { "type": "integer" }, "example": 50 }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.", "schema": { "type": "string" }, "example": "Status = 'Released'" }, { "name": "sort", "in": "query", "description": "Sort expression. Prefix a field name with - for descending order.", "schema": { "type": "string" }, "example": "modifiedOn" }, { "$ref": "#/components/parameters/Languages" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationCollection" }, "example": { "totalCount": 1, "offset": 0, "limit": 50, "items": [ { "id": "f8381f8f40174f4d8c31a832013f4aac", "identifier": "GeneralIdentifier", "name": "General", "namePath": null, "labelPath": null, "sortIndex": 3, "sortOrder": "", "disabledInDAMUI": false, "isRoot": true, "parentId": null, "hasChildren": null, "tag": null, "labels": [ { "value": "General", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "registeredFields": [ { "fieldId": "54c036af9f264a7194acac3600e6d967" } ], "registeredFieldGroups": [ { "fieldGroupId": "40cd3ee808e54c528ec850a372e4de1c" }, { "fieldGroupId": "51b493b7afcb47df874fac39013b4cad" } ], "parent": null, "ancestors": null, "children": null, "fields": null, "recordPermissions": null, "downloadPermissions": null, "classificationTreePermissions": null, "slaveClassifications": null, "followerClassifications": null, "classificationTreePermission": null, "modifiedOn": "2025-04-24T21:26:23.023Z", "createdOn": "2017-11-21T19:22:30.327Z", "createdBy": null, "modifiedBy": null } ] } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "Classification" ], "summary": "Creates a new classification. In order to successfully create a classification, the parent of the classification must be specified via the parentId, parentName or isRoot property.", "operationId": "CreateClassifications", "parameters": [ { "$ref": "#/components/parameters/ApiVersion" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" }, "example": { "id": "f8381f8f40174f4d8c31a832013f4aac", "identifier": "GeneralIdentifier", "name": "General", "namePath": null, "labelPath": null, "sortIndex": 3, "sortOrder": "", "disabledInDAMUI": false, "isRoot": true, "parentId": null, "hasChildren": null, "tag": null, "labels": [ { "value": "General", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "registeredFields": [ { "fieldId": "54c036af9f264a7194acac3600e6d967" } ], "registeredFieldGroups": [ { "fieldGroupId": "40cd3ee808e54c528ec850a372e4de1c" }, { "fieldGroupId": "51b493b7afcb47df874fac39013b4cad" } ], "parent": null, "ancestors": null, "children": null, "fields": null, "recordPermissions": null, "downloadPermissions": null, "classificationTreePermissions": null, "slaveClassifications": null, "followerClassifications": null, "classificationTreePermission": null, "modifiedOn": "2025-04-24T21:26:23.023Z", "createdOn": "2017-11-21T19:22:30.327Z", "createdBy": null, "modifiedBy": null } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationCreateRequest" }, "example": { "parentNamePath": "/StoreInfo/Europe", "name": "Brand Related", "identifier": "brand_related", "sortIndex": 6, "sortOrder": "Label", "disabledInDAMUI": false, "labels": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "Brand Related - English" } ] } } } } } } }, "components": { "parameters": { "ApiVersion": { "name": "API-VERSION", "in": "header", "description": "The version of the Aprimo DAM REST API to use.", "required": true, "schema": { "enum": [ "1" ], "type": "string", "default": "1" } }, "Languages": { "name": "languages", "in": "header", "required": false, "description": "Specifies the language(s) for localized field values in the response. Accepts a single language ID, a comma-separated list of language IDs, or `*` for all languages.", "schema": { "type": "string" }, "example": "*" } }, "securitySchemes": { "OAuth2": { "type": "oauth2", "description": "Aprimo OAuth 2.0 authentication. Register your application under Administration > Integration > Registrations. Replace `your-tenant` in the URLs below with your Aprimo tenant identifier. Token registration changes may take up to 15 minutes to take effect.", "flows": { "clientCredentials": { "tokenUrl": "https://your-tenant.aprimo.com/login/connect/token", "scopes": { "api": "Access to the Aprimo DAM REST API" } }, "authorizationCode": { "authorizationUrl": "https://your-tenant.aprimo.com/login/connect/authorize", "tokenUrl": "https://your-tenant.aprimo.com/login/connect/token", "scopes": { "api": "Access to the Aprimo DAM REST API", "offline_access": "Request a refresh token for long-lived access (must be enabled on the registration)" } }, "password": { "tokenUrl": "https://your-tenant.aprimo.com/login/connect/token", "scopes": { "api": "Access to the Aprimo DAM REST API" } } } }, "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Pass a JWT access token obtained from the Aprimo OAuth 2.0 token endpoint. For the password flow, the `password` parameter is the user's Aprimo API token (found under My Profile > User Token), not their account password." } }, "schemas": { "LocalizedValue": { "type": "object", "properties": { "value": { "type": "string" }, "languageId": { "type": "string", "description": "Use 00000000000000000000000000000000 for language-neutral fields" }, "aiInfluenced": { "type": "boolean", "nullable": true }, "readOnly": { "type": "boolean", "nullable": true }, "modifiedOn": { "type": "string", "format": "date-time", "nullable": true } } }, "RecordField": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string", "description": "Internal field name used in API calls" }, "label": { "type": "string" }, "dataType": { "type": "string", "description": "e.g. SingleLineText, MultiLineText, DateTime, Numeric, Boolean, ListString" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/LocalizedValue" } }, "inheritanceState": { "type": "string", "nullable": true }, "inheritable": { "type": "boolean", "nullable": true } } }, "FileVersion": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "versionLabel": { "type": "string" }, "versionNumber": { "type": "integer" }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "description": "File size in bytes" }, "fileExtension": { "type": "string" }, "fileCreatedOn": { "type": "string", "format": "date-time" }, "fileModifiedOn": { "type": "string", "format": "date-time" }, "isLatest": { "type": "boolean" }, "fileProcessingState": { "type": "string", "enum": [ "Open", "Processing", "Failed" ] }, "fileState": { "type": "string", "enum": [ "Available", "Deleted", "Archived" ] }, "aiInfluenced": { "type": "string", "enum": [ "No", "Yes", "Unknown" ] }, "preventDownload": { "type": "boolean" }, "watermarkId": { "type": "string", "format": "uuid" }, "watermarkType": { "type": "string" }, "crc32": { "type": "integer" }, "comment": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" } } }, "Record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Active", "Released", "Archived" ] }, "contentType": { "type": "string", "description": "e.g. Asset, Document" }, "title": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "textContent": { "type": "string", "nullable": true }, "aiInfluenced": { "type": "string", "enum": [ "No", "Yes", "Unknown" ] }, "hasImageOverlay": { "type": "boolean", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "nullable": true }, "modifiedBy": { "type": "object", "nullable": true }, "fields": { "type": "object", "nullable": true, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordField" } } } }, "preview": { "type": "object", "nullable": true, "description": "Populated via `select-record: preview`. The `uri` is a time-limited signed URL (expires after ~30 hours).", "properties": { "size": { "type": "integer" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "extension": { "type": "string" }, "uri": { "type": "string" } } }, "thumbnail": { "type": "object", "nullable": true, "description": "Populated via `select-record: thumbnail`. The `uri` is a time-limited signed URL (expires after ~30 hours).", "properties": { "size": { "type": "integer" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "extension": { "type": "string" }, "uri": { "type": "string" } } }, "masterFileLatestVersion": { "allOf": [ { "$ref": "#/components/schemas/FileVersion" } ], "nullable": true }, "masterFileLatestPublishedVersion": { "allOf": [ { "$ref": "#/components/schemas/FileVersion" } ], "nullable": true }, "classifications": { "type": "object", "nullable": true }, "files": { "type": "object", "nullable": true }, "permissions": { "type": "object", "nullable": true }, "locks": { "type": "object", "nullable": true } } }, "RecordCollection": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Total number of records matching the query. Note: approximated in search results due to two-step Elasticsearch + database querying." }, "offset": { "type": "integer" }, "limit": { "type": "integer", "maximum": 1000 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Record" } } } }, "Classification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "type": "string", "description": "Unique text identifier" }, "name": { "type": "string" }, "namePath": { "type": "string", "nullable": true, "description": "Full slash-separated path e.g. /Root/Category/Subcategory" }, "labelPath": { "type": "string", "nullable": true }, "sortIndex": { "type": "integer" }, "sortOrder": { "type": "string" }, "disabledInDAMUI": { "type": "boolean" }, "isRoot": { "type": "boolean" }, "parentId": { "type": "string", "format": "uuid", "nullable": true }, "hasChildren": { "type": "boolean", "nullable": true }, "tag": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "languageId": { "type": "string" } } } }, "registeredFields": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid" } } } }, "registeredFieldGroups": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "fieldGroupId": { "type": "string", "format": "uuid" } } } }, "parent": { "type": "object", "nullable": true, "description": "Populated via select-classification: parent" }, "ancestors": { "type": "object", "nullable": true, "description": "Populated via select-classification: ancestors" }, "children": { "type": "object", "nullable": true, "description": "Populated via select-classification: children" }, "fields": { "type": "object", "nullable": true, "description": "Populated via select-classification: fields" }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "nullable": true }, "modifiedBy": { "type": "object", "nullable": true } } }, "ClassificationCollection": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Classification" } } } }, "Collection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "Static", "Dynamic" ], "description": "Static = curated list of records, Dynamic = query-driven" }, "status": { "type": "string", "description": "e.g. Active, Inactive" }, "ownerId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "isReadOnly": { "type": "boolean", "nullable": true }, "records": { "type": "object", "nullable": true, "description": "Populated via select-collection: records" }, "permissions": { "type": "object", "nullable": true, "description": "Populated via select-collection: permissions" }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "nullable": true }, "modifiedBy": { "type": "object", "nullable": true } } }, "CollectionCollection": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } } }, "FieldDefinition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Internal name used in API calls" }, "label": { "type": "string", "description": "Primary display label" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "languageId": { "type": "string" } } } }, "helpText": { "type": "string", "nullable": true }, "helpTexts": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "languageId": { "type": "string" } } } }, "dataType": { "type": "string", "description": "e.g. Numeric, SingleLineText, MultiLineText, Date, DateTime, OptionList, ClassificationList, RecordLink" }, "scope": { "type": "string", "description": "e.g. RecordContentGlobal, RecordContentContentTypeDependent, File, Classification" }, "scopeCategory": { "type": "string", "description": "e.g. Record, File, Classification" }, "indexed": { "type": "boolean" }, "languageMode": { "type": "string", "enum": [ "Single", "Multiple" ] }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Field group IDs this field belongs to" }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isRequired": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isUniqueIdentifier": { "type": "boolean" }, "sortIndex": { "type": "integer" }, "inlineStyle": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "validation": { "type": "string", "nullable": true }, "validationErrorMessage": { "type": "string", "nullable": true }, "validationTrigger": { "type": "string", "description": "e.g. Always, OnSave" }, "storageMode": { "type": "string", "description": "e.g. NonEmptyValues, LogChanges, AllValues" }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" } }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "searchIndexRebuildRequired": { "type": "boolean" }, "tag": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "nullable": true }, "modifiedBy": { "type": "object", "nullable": true } } }, "FieldDefinitionCollection": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "FieldGroup": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tag": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" } } }, "FieldGroupCollection": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroup" } } } }, "Order": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "e.g. DownloadOrder, EmailOrder, FtpResortOrder, PublicCdnOrder" }, "orderType": { "type": "string", "description": "e.g. download, email, ftpResort, publicCdn" }, "status": { "type": "string", "description": "e.g. Success, Failed, Processing, Waiting" }, "message": { "type": "string", "nullable": true }, "failedTargetsCount": { "type": "integer" }, "totalFileSize": { "type": "integer", "description": "Total size of ordered files in bytes" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "Download URLs for completed orders. Tokens expire after 30 hours." }, "creatorEmail": { "type": "string" }, "disableNotification": { "type": "boolean" }, "priority": { "type": "integer", "description": "0 = Normal, 1 = High" }, "useCDN": { "type": "string", "description": "e.g. Automatic, Yes, No" }, "disableProcessing": { "type": "string", "description": "e.g. No, Yes" }, "executionTime": { "type": "string", "description": "ISO 8601 duration e.g. 00:00:00.182" }, "createdOn": { "type": "string", "format": "date-time" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "earliestStartDate": { "type": "string", "format": "date-time", "nullable": true }, "targets": { "type": "object", "nullable": true, "description": "Populated via select-order: targets" } } }, "OrderCollection": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } }, "Rendition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Display name of the rendition" }, "type": { "type": "string", "description": "e.g. Original, Preview, Thumbnail, Web" }, "extension": { "type": "string" }, "uri": { "type": "string", "nullable": true, "description": "Populated via select-rendition. Direct URI to the rendition file." }, "publishedUri": { "type": "string", "nullable": true, "description": "Published CDN URI if available" }, "publicLinks": { "type": "object", "nullable": true, "description": "Populated via select-rendition: publiclinks" }, "preview": { "type": "string", "nullable": true } } }, "RenditionCollection": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Rendition" } } } }, "PublicLink": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "uri": { "type": "string", "description": "Public CDN URL for the asset" }, "status": { "type": "string", "description": "e.g. Published, Unpublished" }, "provider": { "type": "string", "description": "CDN provider e.g. FastlyCDN, AzureCDN" }, "renditionName": { "type": "string" }, "origin": { "type": "string", "description": "How the public link was created e.g. Order, Manual" }, "recordId": { "type": "string", "format": "uuid" }, "fileVersionId": { "type": "string", "format": "uuid" }, "additionalFileId": { "type": "string", "format": "uuid", "nullable": true }, "fileSize": { "type": "integer", "description": "File size in bytes" }, "canDelete": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "nullable": true }, "modifiedBy": { "type": "object", "nullable": true } } }, "PublicLinkCollection": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicLink" } } } }, "PublicUri": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "uri": { "type": "string", "description": "Public CDN URI for the asset" }, "fileName": { "type": "string", "nullable": true }, "renditionName": { "type": "string" }, "renditionType": { "type": "string", "description": "e.g. Original, Preview, Thumbnail" }, "status": { "type": "string", "description": "e.g. Published, Unpublished" }, "provider": { "type": "string", "description": "CDN provider e.g. FastlyCDN" }, "origin": { "type": "string", "description": "e.g. Order, Manual" }, "canDelete": { "type": "boolean" }, "targetType": { "type": "string", "nullable": true }, "targetId": { "type": "string", "format": "uuid", "nullable": true }, "recordId": { "type": "string", "format": "uuid" }, "fileVersionId": { "type": "string", "format": "uuid" }, "renditionId": { "type": "string", "format": "uuid" }, "createdOn": { "type": "string", "format": "date-time" }, "modifiedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "object", "nullable": true }, "modifiedBy": { "type": "object", "nullable": true } } }, "PublicUriCollection": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUri" } } } }, "SearchExpression": { "type": "object", "description": "Search expression using Aprimo's query language. Use `expression` for a single query string, or `subExpressions` for multiple combined queries. Cannot use both together.", "properties": { "expression": { "type": "string", "description": "Query string using property-operator-value syntax. Operators: `=`, `<>`, `>`, `>=`, `<`, `<=`, `CONTAINS`, `in`. Logical: `AND`, `OR`, `NOT`. Use `?` for positional parameters, `@name` for named parameters. Use `FieldName(\"fieldName\")` or `FieldId(\"guid\")` to reference metadata fields. Examples: `Status = 'Released'` | `Title CONTAINS 'umbrella'` | `FieldName(\"Brand\") = 'Acme' AND CreatedOn >= 2025-01-01`" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Values for `?` positional placeholders in the expression, in order." }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Values for `@name` named placeholders in the expression." }, "disabledKeywords": { "type": "array", "items": { "type": "string" }, "description": "Disable specific keywords so they are treated as literal text. e.g. [\"In\", \"And\", \"Or\", \"Not\", \"Contains\"]" }, "supportWildcards": { "type": "boolean", "default": false, "description": "When true, `*` matches multiple characters and `?` matches a single character in quoted strings." }, "defaultLogicalOperator": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND", "description": "Logical operator applied between terms when no explicit operator is present." }, "languages": { "type": "array", "items": { "type": "string" }, "description": "Restrict search to specific language IDs." }, "subExpressions": { "type": "array", "description": "Alternative to `expression`. All sub-expressions are combined with AND. Each has its own `expression` and `languages`.", "items": { "type": "object", "properties": { "expression": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string" } } } } } } }, "SearchResponse": { "type": "object", "description": "Paginated search results with optional facet aggregations.", "properties": { "totalCount": { "type": "integer", "description": "Approximate total number of matching results." }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Record" } }, "facets": { "type": "array", "description": "Facet aggregations requested in the search body.", "items": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "count": { "type": "integer" } } } } } } } } }, "ClassificationSearchResponse": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Classification" } } } }, "FieldMutationItem": { "type": "object", "description": "A field value to add or update. Reference the field by its definition ID.", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Field definition ID" }, "localizedValues": { "type": "array", "items": { "type": "object", "properties": { "languageId": { "type": "string", "description": "Language ID. Use 00000000000000000000000000000000 for language-neutral fields." }, "value": { "type": "string", "description": "String value for single-value fields (text, date, numeric)" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Array of IDs for multi-select or classification-linked fields" } } } } } }, "RecordCreateRequest": { "type": "object", "required": [ "contentType" ], "properties": { "contentType": { "type": "string", "description": "Content type e.g. Asset, Document, Record" }, "status": { "type": "string", "enum": [ "Active", "Released", "Archived" ] }, "tag": { "type": "string", "description": "XML-formatted tag metadata" }, "fields": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMutationItem" } } } }, "classifications": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Classification ID" }, "sortIndex": { "type": "integer" } } } } } } }, "example": { "contentType": "Asset", "classifications": { "addOrUpdate": [ { "id": "f8381f8f40174f4d8c31a832013f4aac", "sortIndex": 1 } ] }, "fields": { "addOrUpdate": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "value": "My Asset Title" } ] } ] } } }, "RecordEditRequest": { "type": "object", "description": "Only properties included in the request body are changed. Omit properties you do not want to modify.", "properties": { "contentType": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Released", "Archived" ] }, "tag": { "type": "string" }, "fields": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMutationItem" } }, "remove": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } }, "classifications": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sortIndex": { "type": "integer" } } } }, "remove": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } }, "example": { "status": "Released", "fields": { "addOrUpdate": [ { "id": "a07842ae9c7d4eb9a43ab2b801540674", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "value": "Updated Title" } ] } ] }, "classifications": { "addOrUpdate": [ { "id": "f8381f8f40174f4d8c31a832013f4aac", "sortIndex": 1 } ], "remove": [ { "id": "ee2708c7026745528c0db3aa0112ab86" } ] } } }, "ClassificationCreateRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "identifier": { "type": "string", "description": "Unique text identifier for the classification" }, "parentId": { "type": "string", "format": "uuid", "description": "Parent classification ID. Use parentNamePath as alternative." }, "parentNamePath": { "type": "string", "description": "Slash-separated path to parent e.g. /StoreInfo/Europe" }, "isRoot": { "type": "boolean", "description": "Set to true to create at root level" }, "sortIndex": { "type": "integer" }, "sortOrder": { "type": "string", "enum": [ "Label", "Identifier", "SortIndex" ] }, "disabledInDAMUI": { "type": "boolean" }, "labels": { "type": "array", "description": "Localized display labels", "items": { "type": "object", "properties": { "languageId": { "type": "string" }, "value": { "type": "string" } } } }, "fields": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMutationItem" } } } }, "registeredFields": { "type": "object", "description": "Field definitions registered to this classification", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "registeredFieldGroups": { "type": "object", "description": "Field groups registered to this classification", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "example": { "parentNamePath": "/StoreInfo/Europe", "name": "Brand Related", "identifier": "brand_related", "sortIndex": 6, "sortOrder": "Label", "disabledInDAMUI": false, "labels": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "Brand Related - English" } ] } }, "ClassificationEditRequest": { "type": "object", "description": "Only properties included in the request body are changed.", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "sortIndex": { "type": "integer" }, "sortOrder": { "type": "string", "enum": [ "Label", "Identifier", "SortIndex" ] }, "disabledInDAMUI": { "type": "boolean" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "languageId": { "type": "string" }, "value": { "type": "string" } } } }, "fields": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMutationItem" } }, "remove": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } }, "registeredFields": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "registeredFieldGroups": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "followerclassifications": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "example": { "name": "Updated Category Name", "sortIndex": 5 } }, "CollectionCreateRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "static", "dynamic" ], "description": "static = curated list of records, dynamic = query-driven" }, "tag": { "type": "string" }, "searchExpression": { "type": "object", "description": "Required when type is dynamic", "properties": { "expression": { "type": "string", "description": "Search expression string e.g. \"Classification.Name = 'MyClass'\"" }, "languages": { "type": "array", "items": { "type": "string" } } } } }, "example": { "name": "Q1 Campaign Assets", "description": "Assets for the Q1 marketing campaign", "type": "static" } }, "CollectionEditRequest": { "type": "object", "description": "Only properties included are changed.", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "tag": { "type": "string" }, "searchExpression": { "type": "object", "description": "For dynamic collections — updates the query driving record membership.", "properties": { "expression": { "type": "string", "description": "Search expression string e.g. \"Classification.Name = 'MyClass'\"" }, "languages": { "type": "array", "items": { "type": "string" } } } } }, "example": { "name": "Q1 Campaign Assets - Updated", "description": "Updated description" } }, "OrderCreateRequest": { "type": "object", "required": [ "type", "targets" ], "properties": { "type": { "type": "string", "enum": [ "download", "email", "ftpResort", "publicCdn" ], "description": "Order delivery type" }, "targets": { "type": "array", "items": { "type": "object", "required": [ "recordId" ], "properties": { "recordId": { "type": "string", "format": "uuid" }, "fileVersionId": { "type": "string", "format": "uuid", "description": "Specific file version. Defaults to latest." }, "targetTypes": { "type": "array", "items": { "type": "string" }, "description": "e.g. MasterPreview, MasterThumbnail, Document, Original" }, "assetType": { "type": "string", "description": "e.g. AllVersionsOfAllFiles, LatestVersionOfMasterFile" } } } }, "creatorEmail": { "type": "string" }, "disableNotification": { "type": "boolean" }, "priority": { "type": "string", "enum": [ "Low", "Medium", "High" ] }, "emailSubject": { "type": "string", "description": "Email orders only" }, "emailBody": { "type": "string", "description": "Email orders only" }, "emailRecipients": { "type": "array", "items": { "type": "string" }, "description": "Email orders only" }, "downloadsPageUrl": { "type": "string", "description": "Download orders only" } }, "example": { "type": "download", "targets": [ { "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "targetTypes": [ "Original" ], "assetType": "LatestVersionOfMasterFile" } ], "disableNotification": true } }, "FieldGroupEditRequest": { "type": "object", "description": "Only properties included are changed.", "properties": { "name": { "type": "string" }, "tag": { "type": "string" }, "members": { "type": "object", "description": "Field definition IDs to add or remove from the group", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "example": { "name": "Updated Field Group Name", "members": { "addOrUpdate": [ "a07842ae9c7d4eb9a43ab2b801540674" ], "remove": [] } } }, "FieldDefinitionEditRequest": { "type": "object", "description": "Only properties included are changed. Available properties depend on the field's dataType.", "properties": { "label": { "type": "string" }, "isRequired": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "defaultValue": { "type": "string" }, "tag": { "type": "string" }, "validationTrigger": { "type": "string", "description": "e.g. always, onSave" }, "validation": { "type": "string", "description": "Validation expression" }, "validationErrorMessage": { "type": "string" }, "storageMode": { "type": "string", "description": "e.g. logChanges, nonEmptyValues, allValues" }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "e.g. onNewField, OnLoad, OnFieldChange, OnMasterFileChange" }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "enabledLanguages": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "childClassifications": { "type": "object", "description": "classificationList fields only", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "showSummaryImage": { "type": "boolean", "description": "recordLink and recordList fields only" } }, "example": { "isReadOnly": false, "defaultValue": "0", "resetToDefaultTriggers": [ "OnNewField", "OnMasterFileChange" ], "storageMode": "logChanges" } }, "PublicLinkCreateRequest": { "type": "object", "required": [ "recordId", "renditionName" ], "properties": { "recordId": { "type": "string", "format": "uuid" }, "fileVersionId": { "type": "string", "format": "uuid", "description": "Defaults to latest version if omitted" }, "renditionName": { "type": "string", "description": "Name of the rendition e.g. Original, Thumbnail" }, "uri": { "type": "string" }, "provider": { "type": "string" } }, "example": { "recordId": "fa7eb97fe1ef4f5c8554b3aa011387ec", "renditionName": "Original", "provider": "Aprimo" } }, "PublicLinkEditRequest": { "type": "object", "properties": { "renditionName": { "type": "string" }, "URI": { "type": "string", "description": "New URI for the public link" }, "provider": { "type": "string" }, "fileSize": { "type": "integer", "description": "File size in bytes" } }, "example": { "renditionName": "Web", "URI": "https://cdn.example.com/asset.jpg", "provider": "Aprimo", "fileSize": 204800 } }, "PublicUriEditRequest": { "type": "object", "description": "Edit an existing public URI. Consult the Aprimo developer documentation for the full list of editable properties.", "properties": { "uri": { "type": "string" }, "provider": { "type": "string" } }, "example": { "provider": "Aprimo" } }, "FieldGroupCreateRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "tag": { "type": "string" }, "members": { "type": "object", "description": "Field definition IDs to include in this group", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "example": { "name": "Asset Metadata", "members": { "addOrUpdate": [ "a07842ae9c7d4eb9a43ab2b801540674" ] } } }, "FieldDefinitionCreateRequest": { "type": "object", "required": [ "name", "dataType" ], "description": "Create a new field definition. Required properties and available options vary by dataType.", "properties": { "name": { "type": "string", "description": "Internal identifier name (no spaces)" }, "dataType": { "type": "string", "enum": [ "singleLineText", "multiLineText", "html", "numeric", "date", "datetime", "optionList", "classificationList", "recordLink", "recordList", "userList", "userGroupList", "time" ], "description": "Determines the field type and which additional properties are valid" }, "scope": { "type": "string", "description": "e.g. recordContentGlobal, recordContentLocal, file, classification" }, "languageMode": { "type": "string", "enum": [ "single", "multiple" ] }, "indexed": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isUniqueIdentifier": { "type": "boolean", "description": "singleLineText only" }, "sortIndex": { "type": "integer" }, "defaultValue": { "type": "string" }, "inlineStyle": { "type": "string", "description": "CSS style for DAM UI display" }, "tag": { "type": "string" }, "labels": { "type": "array", "description": "Localized display labels", "items": { "type": "object", "properties": { "languageId": { "type": "string" }, "value": { "type": "string" } } } }, "enabledLanguages": { "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "memberships": { "type": "object", "description": "Field group memberships", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "maximumLength": { "type": "string", "description": "singleLineText, multiLineText, html" }, "minimumLength": { "type": "string", "description": "singleLineText, multiLineText, html" }, "regularExpression": { "type": "string", "description": "singleLineText, multiLineText, html" }, "accuracy": { "type": "string", "description": "numeric — decimal precision e.g. 0.001" }, "range": { "type": "string", "description": "numeric — valid range e.g. 0-100" }, "datePattern": { "type": "string", "description": "date, datetime" }, "acceptMultipleOptions": { "type": "boolean", "description": "optionList, classificationList" }, "rootId": { "type": "string", "format": "uuid", "description": "classificationList — root classification to browse from" } }, "example": { "name": "assetCost", "dataType": "numeric", "scope": "recordContentGlobal", "languageMode": "multiple", "indexed": false, "isRequired": false, "isReadOnly": false, "labels": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "Asset Cost" } ], "accuracy": "0.01", "range": "0-1000000" } }, "RecordSearchRequest": { "type": "object", "properties": { "searchExpression": { "$ref": "#/components/schemas/SearchExpression" }, "facets": { "type": "array", "maxItems": 12, "description": "Up to 12 facets for aggregated result counts.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identifier for this facet in the response" }, "type": { "type": "string", "enum": [ "classification", "classificationListField", "contentType", "createdBy", "modifiedBy", "createdOn", "modifiedOn", "numericField", "numericFieldRange", "numericFieldRangeFilter", "dateFieldRange", "dateTimeFieldRange", "timeFieldRange", "textField", "textListField", "optionListField", "fileType" ] }, "fieldId": { "type": "string", "format": "uuid", "description": "Required for field-based facets" }, "rangeStart": { "type": "number", "description": "numericFieldRange only" }, "rangeEnd": { "type": "number", "description": "numericFieldRange only" }, "spans": { "type": "array", "items": { "type": "number" }, "description": "numericFieldRange only" } } } }, "logRequest": { "type": "boolean", "description": "Log this search for analytics" }, "userQuery": { "type": "boolean", "nullable": true } }, "example": { "searchExpression": { "expression": "ContentType = 'Asset' AND Status = 'Released'", "defaultLogicalOperator": "AND" }, "logRequest": false } }, "ClassificationSearchRequest": { "type": "object", "properties": { "searchExpression": { "$ref": "#/components/schemas/SearchExpression" }, "logRequest": { "type": "boolean" }, "userQuery": { "type": "boolean", "nullable": true } }, "example": { "searchExpression": { "expression": "Name = 'Marketing*'", "supportWildcards": true }, "logRequest": false } } } }, "security": [ { "OAuth2": [ "api" ] } ], "tags": [ { "name": "Record" }, { "name": "Search" }, { "name": "Classification" }, { "name": "Collection" }, { "name": "Order" }, { "name": "Rendition" }, { "name": "PublicLink" }, { "name": "PublicUri" }, { "name": "File" }, { "name": "FileVersion" }, { "name": "FieldDefinition" }, { "name": "FieldGroup" } ] }