Find & read content
Search, browse and read DAM content: records and their metadata, files and versions, previews, downloads, and public links. Most groups in this area only read.
This area has 8 groups and 118 tools, 101 of them currently available.
- Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
- Needs. Enabling a group also enables every group it needs. Each group below lists them.
- Read-only groups are intended for look-up access without the ability to change data.
- Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Not currently available tools are registered but are not offered in any tool list at this time.
- Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Groups in this area
| Group | Access | Needs | Tools |
|---|---|---|---|
| Find & Discover Content | Read-only | None | 18 |
| View Asset Metadata & History | Read-only | Find & Discover Content, Read the Content Model | 9 |
| View Files & Versions | Read-only | Find & Discover Content | 16 |
| Get Previews, Thumbnails & Renditions | Read-only | View Files & Versions | 16 |
| Read the Content Model | Read-only | None | 20 |
| View Processing, Check & Watermark Results | Can change data | View Files & Versions | 12 |
| Download & Order Files | Can change data | Find & Discover Content, View Files & Versions | 23 |
| View Public Links | Read-only | View Files & Versions | 4 |
Find & Discover Content
Read-only · 18 tools (17 currently available) · Group ID find-discover-content
Needs: no other groups.
| Tool | What it does |
|---|---|
browse_classifications | Browses the Aprimo classification tree (category folders that organize assets). |
get_classification | Gets one Aprimo classification's full detail (identifier, sort order, labels, registered fields/field groups, root/parent status) by id, by leaf name, or by full name path. |
get_classification_by_name_path | Gets one Aprimo classification by its full name path (e.g. "/Brands/Europe/Digital Images"), or by a unique field's name and value (e.g. fieldName="identifier"). |
get_classification_parent | Gets the direct parent of one Aprimo classification, by id, name, or name path. |
get_collection | Gets one Aprimo collection's full detail (name, description, type, status, owner) by id or by name. |
get_collection_records | Lists the assets (records) inside one Aprimo collection: title, deep link, dates, content type, metadata fields. |
get_record_by_field_or_file | Not currently available. Looks up a single Aprimo record either by a file id (the id of one of its files) or by an arbitrary field name/value pair (e.g. a unique external identifier field). |
get_search_field_value_suggestions | Gets field-value autocomplete suggestions for Aprimo given partial input text and a set of field ids, grouped by language. |
get_search_phrase_suggestions | Gets phrase-level search-box suggestions for Aprimo for a piece of input text (e.g. as the user types a search query). |
list_classification_ancestors | Lists every ancestor (parent, grandparent, ... up to the root) of one Aprimo classification, by id, name, or name path — ordered from the top-level ancestor (depth 0) down. |
list_classification_children | Lists the direct children of one Aprimo classification, by id, name, or name path — full detail per child. |
list_collections | Lists the Aprimo collections visible to the user: name, description, type, id. |
list_record_associated_collections | Lists the Aprimo collections a record belongs to (static collections it was manually added to, or dynamic collections whose search criteria it currently matches). |
list_records | Lists Aprimo records as a plain paged listing (not relevance-ranked — use search_aprimo for keyword/relevance search). |
search_aprimo | Searches Aprimo assets by keyword with optional filters. |
search_classifications | Searches Aprimo classifications with the filter expression sent in the request body instead of the query string — functionally similar to browse_classifications, but usable when the filter expression is too long for a header/query string, or to page through a large result set. |
search_collections | Searches Aprimo collections with a filter expression sent in the request body (equivalent to list_collections, but usable when the filter is too large for a query string). |
start_image_similarity_search | Starts an asynchronous Aprimo job that searches for images similar to the image at a given URL, and returns the job's id. |
browse_classifications
Browses the Aprimo classification tree (category folders that organize assets). Without a parentId it returns top-level (root) classifications; with a parentId it returns that node's children. Use when the user wants to explore categories or narrow down where assets live. Display format: one line per classification — name in bold, then the full path.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
parentId | string | No | Optional parent classification id (32-char hex / GUID) to list children of. Omit for top-level (root) classifications. |
Returns:
| Field | Type | Description |
|---|---|---|
parentId | string (optional) | |
count | integer | |
items | array of ClassificationPayload | |
items[].id | string | |
items[].name | string | |
items[].namePath | string (optional) | |
items[].parentId | string (optional) |
get_classification
Gets one Aprimo classification's full detail (identifier, sort order, labels, registered fields/field groups, root/parent status) by id, by leaf name, or by full name path. Use after browse_classifications, or pass name/namePath directly when the user names the classification. Not any of its sub-resources (fields, image URL, parent, tree permissions, etc.) or the dedicated name-path lookup (get_classification_by_name_path) -- each has its own get_classification_* tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match) — not guaranteed unique across the tree; ambiguous matches hard-fail. Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path (e.g. "/Brands/Europe/Digital Images"), which is unique. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
identifier | string (optional) | |
name | string | |
namePath | string (optional) | |
labelPath | string (optional) | |
sortIndex | integer (optional) | |
sortOrder | string (optional) | |
disabledInDamUi | boolean (optional) | |
labels | array of ClassificationLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
registeredFieldIds | array of string | |
registeredFieldGroupIds | array of string | |
isRoot | boolean (optional) | |
parentId | string (optional) | |
hasChildren | boolean (optional) | |
tag | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
get_classification_by_name_path
Gets one Aprimo classification by its full name path (e.g. "/Brands/Europe/Digital Images"), or by a unique field's name and value (e.g. fieldName="identifier"). Use when the user gives a full path or a unique identifier rather than a classification id — pass exactly one of namePath or the fieldName+fieldValue pair.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
namePath | string | No | The classification's full name path, e.g. "/Brands/Europe/Digital Images". Provide this or fieldName+fieldValue, not both. |
fieldName | string | No | Name of a unique field to look up by (e.g. "identifier"). Requires fieldValue. Provide this pair or namePath, not both. |
fieldValue | string | No | Value of the unique field named by fieldName. Requires fieldName. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
identifier | string (optional) | |
name | string | |
namePath | string (optional) | |
labelPath | string (optional) | |
sortIndex | integer (optional) | |
sortOrder | string (optional) | |
disabledInDamUi | boolean (optional) | |
labels | array of ClassificationLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
registeredFieldIds | array of string | |
registeredFieldGroupIds | array of string | |
isRoot | boolean (optional) | |
parentId | string (optional) | |
hasChildren | boolean (optional) | |
tag | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
get_classification_parent
Gets the direct parent of one Aprimo classification, by id, name, or name path. Fails with a friendly message if the classification is a root (it has no parent).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
identifier | string (optional) | |
name | string | |
namePath | string (optional) | |
labelPath | string (optional) | |
sortIndex | integer (optional) | |
sortOrder | string (optional) | |
disabledInDamUi | boolean (optional) | |
labels | array of ClassificationLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
registeredFieldIds | array of string | |
registeredFieldGroupIds | array of string | |
isRoot | boolean (optional) | |
parentId | string (optional) | |
hasChildren | boolean (optional) | |
tag | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
get_collection
Gets one Aprimo collection's full detail (name, description, type, status, owner) by id or by name. Use after list_collections, or pass name directly when the user names the collection. Not a comment (get_collection_comment), comments status (get_collection_comments_status), or its records (get_collection_records).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | No | The collection id (32-char hex / GUID). Provide exactly one of collectionId or name. |
name | string | No | The collection's exact name (case-insensitive) — not guaranteed unique; ambiguous matches hard-fail. Provide exactly one of collectionId or name. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
description | string | |
type | string | |
status | string (optional) | |
ownerId | string (optional) | |
createdOn | string | |
modifiedOn | string |
get_collection_records
Lists the assets (records) inside one Aprimo collection: title, deep link, dates, content type, metadata fields. Use after list_collections when the user wants to see a collection's contents. Display format: one block per record — title in bold, then deep link, status, content type, and dates as bullets.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID, from list_collections). |
Returns:
| Field | Type | Description |
|---|---|---|
collectionId | string | |
count | integer | |
items | array of RecordPayload | |
items[].id | string | |
items[].title | string | |
items[].status | string | |
items[].contentType | string | |
items[].createdOn | string | |
items[].modifiedOn | string | |
items[].deepLink | string | |
items[].fields | map of string |
get_record_by_field_or_file
Not currently available
Looks up a single Aprimo record either by a file id (the id of one of its files) or by an arbitrary field name/value pair (e.g. a unique external identifier field). This is a lookup, not a keyword search — use search_aprimo for relevance-ranked keyword/filter search instead. Provide either fileId, or both fieldName and fieldValue (not all three).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | No | A file id (32-char hex / GUID) belonging to the record's files. Provide this or fieldName+fieldValue, not both. |
fieldName | string | No | The internal field name to match on (e.g. an external-id field name). Requires fieldValue. Provide this pair or fileId, not both. |
fieldValue | string | No | The value to match fieldName against. Requires fieldName. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
title | string | |
status | string | |
contentType | string | |
createdOn | string | |
modifiedOn | string | |
deepLink | string | |
fields | map of string |
get_search_field_value_suggestions
Gets field-value autocomplete suggestions for Aprimo given partial input text and a set of field ids, grouped by language. Use to power metadata-field autocomplete.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | Yes | The partial text typed by the user to get suggestions for. |
fieldIds | array of string | Yes | The field ids (32-char hex / GUID) to generate suggestions from, e.g. from list_field_definitions. |
languageIds | // Bug fix: DAM's suggestion endpoint unconditionally loops over languageIds with no null-check // (an immediate nre, the same for every field/input, confirmed via direct dam-repo trace -- see // docs/internal/pm-dam-qa-followups.md) -- there was never a working "omit for all languages" // path to begin with. Kept nullable/optional at the C# signature level (not a non-nullable // required parameter) deliberately -- confirmed live that the MCP sdk's own parameter binding // rejects a call that omits a non-nullable required parameter with a generic "error occurred // invoking" message before this method body (and its validation check below) ever runs. Nullable // + the explicit check below is what actually produces the clean "at least one language id is // required" message a caller can act on. List<string> | No | The language ids (32-char hex / GUID) to search within. Required -- DAM has no "all languages" default for this; get language ids from list_languages. |
fuzziness | string | No | Optional fuzziness (edit-distance) setting for the suggestion match. |
numberOfSuggestions | integer | No | Optional maximum number of suggestions to return per language. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of LanguageSuggestionsPayload | |
items[].languageId | string | |
items[].suggestions | array of SuggestionPayload | |
items[].suggestions[].text | string | |
items[].suggestions[].score | number (optional) |
get_search_phrase_suggestions
Gets phrase-level search-box suggestions for Aprimo for a piece of input text (e.g. as the user types a search query). Use to power search-as-you-type suggestions.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
text | string | Yes | The input text to generate phrase suggestions for. |
maxSuggestions | integer | No | Optional maximum number of suggestions to return. |
languageIds | array of string | No | Optional language ids (32-char hex / GUID) to search suggestions within. Omit to search all configured languages. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
suggestions | array of string |
list_classification_ancestors
Lists every ancestor (parent, grandparent, ... up to the root) of one Aprimo classification, by id, name, or name path — ordered from the top-level ancestor (depth 0) down. Use to show a classification's full breadcrumb trail.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
count | integer | |
items | array of LinkedClassificationPayload | |
items[].id | string | |
items[].depth | integer | |
items[].labels | array of ClassificationLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) |
list_classification_children
Lists the direct children of one Aprimo classification, by id, name, or name path — full detail per child. Use browse_classifications instead for a lighter-weight id/name/namePath-only view.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
count | integer | |
items | array of ClassificationDetailPayload | |
items[].id | string | |
items[].identifier | string (optional) | |
items[].name | string | |
items[].namePath | string (optional) | |
items[].labelPath | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].sortOrder | string (optional) | |
items[].disabledInDamUi | boolean (optional) | |
items[].labels | array of ClassificationLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].registeredFieldIds | array of string | |
items[].registeredFieldGroupIds | array of string | |
items[].isRoot | boolean (optional) | |
items[].parentId | string (optional) | |
items[].hasChildren | boolean (optional) | |
items[].tag | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (optional) |
list_collections
Lists the Aprimo collections visible to the user: name, description, type, id. Use when the user asks what collections exist or wants to pick one. Display format: one line per collection — name in bold, then type and description.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CollectionPayload | |
items[].id | string | |
items[].name | string | |
items[].description | string | |
items[].type | string | |
items[].createdOn | string | |
items[].modifiedOn | string |
list_record_associated_collections
Lists the Aprimo collections a record belongs to (static collections it was manually added to, or dynamic collections whose search criteria it currently matches). Use get_collection_records for the reverse direction (a collection's records).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Defaults to 10. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
count | integer | |
items | array of CollectionPayload | |
items[].id | string | |
items[].name | string | |
items[].description | string | |
items[].type | string | |
items[].createdOn | string | |
items[].modifiedOn | string |
list_records
Lists Aprimo records as a plain paged listing (not relevance-ranked — use search_aprimo for keyword/relevance search). Use filter/sort with DAM query syntax to narrow the list, e.g. filter="Status = 'Released'", sort="ModifiedOn desc".
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "Status = 'Released'". Omit to list every record. |
sort | string | No | Optional sort expression, e.g. "ModifiedOn desc". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of RecordPayload | |
items[].id | string | |
items[].title | string | |
items[].status | string | |
items[].contentType | string | |
items[].createdOn | string | |
items[].modifiedOn | string | |
items[].deepLink | string | |
items[].fields | map of string |
search_aprimo
Searches Aprimo assets by keyword with optional filters. Returns structured JSON data for each matching asset. Supports filtering by date range (created/modified) and file type in addition to keyword search. Display format: For each result, show the title in bold, then list the deep link, content type, file type, dates, preview URI (as a plain URL, never as an HTML img tag), and custom fields as bullet points underneath. Separate results with a blank line. Important: Always display all returned results and all custom fields for every result. Never summarize, truncate, or omit results or fields. Custom fields display: For each custom field, show only the label and value as "label: value". Do not show the id, fieldName, or dataType — those are internal metadata for follow-up tool calls, not for the user. If the user asks for specific custom fields (e.g. "show keywords", "include the status"), pass their terms via includeFields — matching is case-insensitive and partial, so "keyword" matches a field labeled "Keywords". At the end, always show the search results page link. Use this tool for finding images, documents, videos, and other digital assets — not for asking questions (use ask_content_coach for questions). Do not use ask_content_coach as a fallback. Examples: query="product brochure", query="logo" limit=5 sort="title_asc", query="banner" createdAfter="2026-01-01", query="card" fileType="png", query="report" modifiedAfter="2026-03-01" modifiedBefore="2026-03-15" sort="modified_desc".
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The exact search keywords. Only include the relevant search terms — no filler text, instructions, or conversational phrasing. Extract only the core search terms the user wants to find. Bad: 'find me some product brochures', 'can you search for logos', 'I need banner images'. Good: 'product brochure', 'logo', 'banner image'. If the term is pluralized, use its singular form. Important: If the user refers to Aprimo by name (e.g. 'Find Aprimo PNGs'), do not include 'Aprimo' as a keyword — it is the system name, not a search term. Use '*' as the query to match all assets when the user's intent is to browse or filter without a specific keyword. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sort | string | No | Sort order for results. Options: "relevance" (default), "modified_desc", "modified_asc", "created_desc", "created_asc", "title_asc", "title_desc", "popularity". Use "modified_desc" when the user wants the newest/latest, "created_desc" for recently added, "title_asc" for alphabetical, "popularity" for most popular. |
createdAfter | string | No | Filter to assets created on or after this date (ISO 8601 format, e.g. "2026-01-15"). Use for queries like "created last week" or "added after January". |
createdBefore | string | No | Filter to assets created on or before this date (ISO 8601 format, e.g. "2026-03-01"). Use with createdAfter for a date range. |
modifiedAfter | string | No | Filter to assets modified on or after this date (ISO 8601 format, e.g. "2026-03-01"). Use for queries like "updated recently" or "changed this month". |
modifiedBefore | string | No | Filter to assets modified on or before this date (ISO 8601 format, e.g. "2026-03-15"). |
fileType | string | No | Filter by file extension (e.g. "jpg", "pdf", "png", "mp4", "docx"). Use when the user specifies a file type like "find me PDF reports" or "show png logos". |
includeFields | string | No | Optional comma-separated list of custom field terms to include for each result. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "status", "brand,campaign". Omit to return all custom fields. |
Returns:
| Field | Type | Description |
|---|---|---|
context | string | |
total_count | integer | |
count | integer | |
offset | integer | |
has_more | boolean | |
next_offset | integer (optional) | |
searchResultsLink | string (optional) | |
items | array of SearchAprimoItem | |
items[].title | string | |
items[].deepLink | string (optional) | |
items[].customFields | array of SearchAprimoFieldValue | |
items[].customFields[].id | string | |
items[].customFields[].fieldName | string (optional) | |
items[].customFields[].label | string (optional) | |
items[].customFields[].dataType | string (optional) | |
items[].customFields[].value | string (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedDate | string (optional) | |
items[].contentType | string (optional) | |
items[].fileExtension | string (optional) | |
items[].previewUri | string (optional) |
search_classifications
Searches Aprimo classifications with the filter expression sent in the request body instead of the query string — functionally similar to browse_classifications, but usable when the filter expression is too long for a header/query string, or to page through a large result set. This is a read: it never modifies data, so no confirmation is needed.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
expression | string | No | DAM search-expression string, e.g. "Name Contains 'Digital'". Omit to match every classification (bounded by skip/take). |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of ClassificationDetailPayload | |
items[].id | string | |
items[].identifier | string (optional) | |
items[].name | string | |
items[].namePath | string (optional) | |
items[].labelPath | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].sortOrder | string (optional) | |
items[].disabledInDamUi | boolean (optional) | |
items[].labels | array of ClassificationLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].registeredFieldIds | array of string | |
items[].registeredFieldGroupIds | array of string | |
items[].isRoot | boolean (optional) | |
items[].parentId | string (optional) | |
items[].hasChildren | boolean (optional) | |
items[].tag | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (optional) |
search_collections
Searches Aprimo collections with a filter expression sent in the request body (equivalent to list_collections, but usable when the filter is too large for a query string). Use when the user wants collections matching a specific filter, optionally including archived ones.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to match every collection. |
sort | string | No | Optional sort expression, e.g. "Name". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
includeArchived | boolean | No | When true, includes archived collections in the results. Defaults to false. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CollectionPayload | |
items[].id | string | |
items[].name | string | |
items[].description | string | |
items[].type | string | |
items[].createdOn | string | |
items[].modifiedOn | string |
start_image_similarity_search
Starts an asynchronous Aprimo job that searches for images similar to the image at a given URL, and returns the job's id. Important limitation: the DAM rest API documents no endpoint to retrieve this job's results (no poll/status/result endpoint exists for this job type) — this tool can only confirm the job was accepted, not report matches. This modifies data (creates a job). Tell the user about this limitation before using it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | The URL of the image to search for similar images to. |
maxResults | integer | No | Optional maximum number of results the job should collect. |
userAgent | string | No | Optional user agent to use when fetching the image at the URL. |
sift | string | No | Optional sift (feature-matching) options for the search. |
pHash | string | No | Optional perceptual-hash matching options for the search. |
creatorEmail | string | No | Optional email address of the user the job is created on behalf of. |
disableNotification | boolean | No | When true, suppresses job-completion notifications. Omit for the endpoint's default. |
earliestStartDate | string | No | Optional ISO-8601 timestamp; the job will not start executing before this time. |
priority | string | No | Optional job priority: "High" or "Medium". |
Returns:
| Field | Type | Description |
|---|---|---|
jobId | string | |
note | string |
View Asset Metadata & History
Read-only · 9 tools · Group ID view-asset-metadata-history
Needs: Find & Discover Content, Read the Content Model
| Tool | What it does |
|---|---|
get_record_audit_trail_entry | Gets the full detail for one audit trail entry of an Aprimo record — who made the change, when, and the individual field/file changes it contains — by the record's id and the entry's id (from list_record_audit_trail). |
get_record_classification | Gets one classification assigned to an Aprimo record (sort order among the record's other classifications, and whether it was assigned manually or automatically via classification mappings), by the record's id and the classification's id (from list_record_classifications or browse_classifications). |
get_record_duplicate_info | Gets duplicate-detection info for an Aprimo record's master file: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to. |
get_record_field | Gets one custom field value on an Aprimo record, by the record's id and the field's id (from list_record_fields or get_custom_field_definition). |
get_record_metadata | Retrieves the full metadata for a single Aprimo record by its ID. |
get_record_permissions | Gets the calling user's own effective permissions on an Aprimo record: read, read-all-versions, modify, delete, download, and full control. |
list_record_audit_trail | Lists the audit trail (change history) for an Aprimo record: who changed what and when, one summary entry per change event. |
list_record_classifications | Lists every classification assigned to an Aprimo record, in sort order, with whether each was assigned manually or automatically via classification mappings. |
list_record_fields | Lists the custom field values on an Aprimo record, by the record's id. |
get_record_audit_trail_entry
Gets the full detail for one audit trail entry of an Aprimo record — who made the change, when, and the individual field/file changes it contains — by the record's id and the entry's id (from list_record_audit_trail).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record id (32-char hex / GUID) — the audit trail's object id. |
entryId | integer | Yes | The audit entry's id (an integer, from list_record_audit_trail), e.g. 4. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
objectId | string | |
userId | string (optional) | |
externalUserName | string (optional) | |
createdOn | string (optional) | |
changeCount | integer | |
changes | array of string |
get_record_classification
Gets one classification assigned to an Aprimo record (sort order among the record's other classifications, and whether it was assigned manually or automatically via classification mappings), by the record's id and the classification's id (from list_record_classifications or browse_classifications).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
classificationId | string | Yes | The classification id (32-char hex / GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
classificationId | string | |
name | string (optional) | |
sortIndex | integer (optional) | |
isManual | boolean (optional) |
get_record_duplicate_info
Gets duplicate-detection info for an Aprimo record's master file: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to. Pass newFileName to check as if the master file were being renamed to that name (useful before an upload that would add a new version).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
newFileName | string | No | Optional — check duplicates as if the master file were renamed to this file name instead of its current name. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
duplicateInfo | FileVersionDuplicateInfoPayload | |
duplicateInfo.detectionMode | string | |
duplicateInfo.status | string | |
duplicateInfo.totalCount | integer | |
duplicateInfo.duplicates | array of DuplicatePayload | |
duplicateInfo.duplicates[].recordId | string | |
duplicateInfo.duplicates[].fileVersionId | string | |
duplicateInfo.duplicates[].reason | string |
get_record_field
Gets one custom field value on an Aprimo record, by the record's id and the field's id (from list_record_fields or get_custom_field_definition). Not the field's list of allowed values (use get_record_field_list_values for that). get_record_metadata is usually more convenient for reading several fields at once. Display the result as "label: value" — never show the id/fieldName/dataType to the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
fieldId | string | Yes | The field definition id (GUID) whose value to read. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
id | string | |
fieldName | string (optional) | |
label | string (optional) | |
dataType | string (optional) | |
value | string (optional) |
get_record_metadata
Retrieves the full metadata for a single Aprimo record by its ID. Returns system properties (title, status, content type, dates), master file info (filename, extension, size, version), and all custom field values. Use this tool when you need detailed information about a specific asset. The record ID is a GUID — you can get it from search_aprimo results. If the user asks for specific custom fields (e.g. "show me the keywords", "what's the status"), pass their terms via includeFields — matching is case-insensitive and partial, so "keyword" matches a field labeled "Keywords". Display format: Show the title in bold, then list all properties and custom fields as bullet points. For custom fields, display only "label: value" — never show id, fieldName, or dataType to the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record ID (GUID format, e.g. "a1b2c3d4-e5f6-7890-abcd-ef1234567890"). Obtain from search_aprimo results. |
includeFields | string | No | Optional comma-separated list of custom field terms to include. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "Status", "brand,campaign". Omit to return all fields. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
title | string (optional) | |
status | string (optional) | |
contentType | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) | |
deepLink | string (optional) | |
masterFile | RecordFileInfo (optional) | |
masterFile.fileName | string (optional) | |
masterFile.extension | string (optional) | |
masterFile.fileSize | integer (optional) | |
masterFile.versionNumber | integer (optional) | |
fields | array of RecordFieldValue | |
fields[].id | string | |
fields[].fieldName | string (optional) | |
fields[].label | string (optional) | |
fields[].dataType | string (optional) | |
fields[].localizedValues | array of RecordLocalizedValue | |
fields[].localizedValues[].languageId | string (optional) | |
fields[].localizedValues[].value | string (optional) | |
fields[].localizedValues[].values | array of string (optional) |
get_record_permissions
Gets the calling user's own effective permissions on an Aprimo record: read, read-all-versions, modify, delete, download, and full control. Use when the user asks what they're allowed to do with a specific asset.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
canRead | boolean (optional) | |
canReadAllVersions | boolean (optional) | |
canModify | boolean (optional) | |
canDelete | boolean (optional) | |
hasFullControl | boolean (optional) | |
canDownload | boolean (optional) |
list_record_audit_trail
Lists the audit trail (change history) for an Aprimo record: who changed what and when, one summary entry per change event. Pass filter="Change" or filter="Download" to narrow to just modifications or just download events. Use get_record_audit_trail_entry (by an entry's id from this list) for the individual field changes within one entry.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record id (32-char hex / GUID) — the audit trail's object id. |
filter | string | No | Optional — restrict to "Change" or "Download" events. Omit for every event type. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
objectId | string | |
entryCount | integer | |
count | integer | |
items | array of RecordAuditTrailEntrySummaryPayload | |
items[].id | integer | |
items[].type | string (optional) | |
items[].userId | string (optional) | |
items[].createdOn | string (optional) | |
items[].changeCount | integer (optional) |
list_record_classifications
Lists every classification assigned to an Aprimo record, in sort order, with whether each was assigned manually or automatically via classification mappings.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
sort | string | No | Optional sort expression, e.g. "sortIndex asc". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
count | integer | |
items | array of RecordClassificationPayload | |
items[].recordId | string | |
items[].classificationId | string | |
items[].name | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].isManual | boolean (optional) |
list_record_fields
Lists the custom field values on an Aprimo record, by the record's id. Use includeFields to filter to specific fields (matches by id exactly, or by fieldName/label substring). get_record_metadata also returns fields alongside the record's system properties — use that when you need both. Display each as "label: value" — never show id/fieldName/dataType to the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
includeFields | string | No | Optional comma-separated list of custom field terms to include. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "Status", "brand,campaign". Omit to return all fields. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
count | integer | |
items | array of RecordFieldPayload | |
items[].recordId | string | |
items[].id | string | |
items[].fieldName | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].value | string (optional) |
View Files & Versions
Read-only · 16 tools (15 currently available) · Group ID view-files-versions
Needs: Find & Discover Content
| Tool | What it does |
|---|---|
get_additional_file | Gets one additional file (rendition, crop, still, subtitle, etc.) of an Aprimo asset by its id: type, label, file name, size, and usages/purposes. |
get_additional_file_public_link | Not currently available. Gets the public link associated with an additional file of an Aprimo asset, by its id. |
get_file | Gets a file on an Aprimo asset by its id: checkout status, checkout date, watermark, and creation date. |
get_file_field | Gets one custom field value set on a file (not the asset/record) of an Aprimo asset, by the file's id and the field's id (from list_file_fields or get_custom_field_definition). |
get_file_latest_version | Gets the latest file version of a file (not the record) on an Aprimo asset: version id, label, file name, size, and creation date. |
get_file_version_detail | Gets full detail for one file version of an Aprimo asset: all base fields plus the opt-in duplicate detection info, annotation info, and metadata that get_file_versions and get_record_master_file_version do not include. |
get_file_version_duplicate_info | Gets the full duplicate-detection info for an Aprimo file version: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to. |
get_file_version_file_type | Gets the Aprimo file type detail (extension, MIME type, engine/preview format, supported operations) for a specific file version. |
get_file_versions | Lists all versions of a file on an Aprimo asset: version label/number, file name, size, and which is latest. |
get_record_master_file | Gets the master file of an Aprimo record (checkout status, checkout date, watermark, creation date) — the file id itself, distinct from get_record_master_file_version's file version id. |
get_record_master_file_version | Gets the latest file version of an Aprimo asset's (record's) master file: version id, label, file name, size, and creation date. |
list_additional_files | Lists the additional files (renditions, crops, stills, subtitles, etc.) attached to a file version of an Aprimo asset: type, label, file name, size, and usages/purposes. |
list_file_fields | Lists the custom field values set on a file (not the asset/record) of an Aprimo asset, by the file's id. |
list_file_version_linked_versions | Lists the publications an Aprimo file version is used in (or contains), by file version id and link type. |
list_file_version_permissions | Gets the calling user's calculated download/delete permissions on an Aprimo file version, by file version id. |
list_record_files | Lists every file attached to an Aprimo record (typically just the master file, but a record can have more): checkout status, checkout date, watermark, and creation date per file. |
get_additional_file
Gets one additional file (rendition, crop, still, subtitle, etc.) of an Aprimo asset by its id: type, label, file name, size, and usages/purposes. Use list_additional_files first to find the id from a file version. Not its preview (get_additional_file_preview), preview URL (get_additional_file_preview_url), or public link (get_additional_file_public_link).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
type | string | |
isManual | boolean | |
label | string | |
fileSize | integer | |
fileName | string | |
extension | string | |
usages | array of string | |
purposes | array of string |
get_additional_file_public_link
Not currently available
Gets the public link associated with an additional file of an Aprimo asset, by its id. Returns a not-found error if the additional file has no public link.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
status | string (optional) | |
canDelete | boolean (optional) | |
provider | string (optional) | |
recordId | string (optional) | |
fileVersionId | string (optional) | |
additionalFileId | string (optional) | |
fileSize | integer (optional) | |
renditionName | string (optional) | |
origin | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
get_file
Gets a file on an Aprimo asset by its id: checkout status, checkout date, watermark, and creation date. Use when the user asks about a file's checkout or watermark state rather than its content or version history. Returns only this base file record — not any file sub-resource (previews, versions, thumbnails, process actions, etc.), each of which has its own get_file_* tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
checkedOut | boolean | |
checkedOutOn | string | |
watermarkId | string | |
watermarkType | string | |
createdOn | string |
get_file_field
Gets one custom field value set on a file (not the asset/record) of an Aprimo asset, by the file's id and the field's id (from list_file_fields or get_custom_field_definition). Display it as "label: value" — never show the id/fieldName/dataType to the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
fieldId | string | Yes | The field definition id (GUID) whose value to read. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
id | string | |
fieldName | string (optional) | |
label | string (optional) | |
dataType | string (optional) | |
value | string (optional) |
get_file_latest_version
Gets the latest file version of a file (not the record) on an Aprimo asset: version id, label, file name, size, and creation date. Same shape as get_record_master_file_version, but scoped to a specific file id rather than a record's master file.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileName | string | |
versionLabel | string | |
versionNumber | integer | |
fileSize | integer | |
fileExtension | string | |
isLatest | boolean | |
createdOn | string |
get_file_version_detail
Gets full detail for one file version of an Aprimo asset: all base fields plus the opt-in duplicate detection info, annotation info, and metadata that get_file_versions and get_record_master_file_version do not include. Use when the user asks about duplicates, annotations, or file-version-level metadata for a specific file version id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
versionLabel | string | |
versionNumber | integer | |
fileName | string | |
fileSize | integer | |
fileExtension | string | |
fileCreatedOn | string | |
fileModifiedOn | string | |
comment | string | |
crc32 | integer | |
sha256 | string | |
preventDownload | boolean | |
isLatest | boolean | |
fileProcessingState | string | |
aiInfluenced | string | |
watermarkId | string | |
watermarkType | string | |
fileState | string | |
hasSmartActionFindings | boolean (optional) | |
createdOn | string | |
metadata | map of FileVersionMetadataEntryPayload | |
metadata.contentType | string | |
metadata.value | string | |
duplicateInfo | FileVersionDuplicateInfoPayload | |
duplicateInfo.detectionMode | string | |
duplicateInfo.status | string | |
duplicateInfo.totalCount | integer | |
duplicateInfo.duplicates | array of DuplicatePayload | |
duplicateInfo.duplicates[].recordId | string | |
duplicateInfo.duplicates[].fileVersionId | string | |
duplicateInfo.duplicates[].reason | string | |
annotationInfo | FileVersionAnnotationInfoPayload | |
annotationInfo.totalCount | integer | |
annotationInfo.annotations | array of FileVersionAnnotationPayload | |
annotationInfo.annotations[].id | string | |
annotationInfo.annotations[].comments | string | |
annotationInfo.annotations[].pageNumber | integer | |
annotationInfo.annotations[].createdBy | string | |
annotationInfo.annotations[].createdOn | string |
get_file_version_duplicate_info
Gets the full duplicate-detection info for an Aprimo file version: duplicate status, detection mode, and the list of duplicate file versions the caller has read access to. Use when the user asks whether a file version has duplicates elsewhere in the system.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
detectionMode | string | |
status | string | |
totalCount | integer | |
duplicates | array of DuplicatePayload | |
duplicates[].recordId | string | |
duplicates[].fileVersionId | string | |
duplicates[].reason | string |
get_file_version_file_type
Gets the Aprimo file type detail (extension, MIME type, engine/preview format, supported operations) for a specific file version. Same shape as get_file_type, but resolved from a file version id rather than a file type id/name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | string (optional) | |
extension | string (optional) | |
mimeType | string (optional) | |
engineFormat | string (optional) | |
isCatalogable | boolean | |
mediaEngines | array of string | |
previewFormat | string (optional) | |
previewPlayers | array of string | |
previewRequired | boolean | |
previewKeepDimensions | boolean | |
supportAssetResize | boolean | |
supportAssetWatermark | boolean | |
preferredExtension | boolean | |
tag | string (optional) | |
registeredFieldIds | array of string | |
registeredFieldGroupIds | array of string | |
labels | array of FileTypeLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_file_versions
Lists all versions of a file on an Aprimo asset: version label/number, file name, size, and which is latest. Use when the user asks about version history of an asset's file.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
count | integer | |
items | array of FileVersionPayload | |
items[].id | string | |
items[].fileName | string | |
items[].versionLabel | string | |
items[].versionNumber | integer | |
items[].fileSize | integer | |
items[].fileExtension | string | |
items[].isLatest | boolean | |
items[].createdOn | string |
get_record_master_file
Gets the master file of an Aprimo record (checkout status, checkout date, watermark, creation date) — the file id itself, distinct from get_record_master_file_version's file version id. Use get_file (by this file id) for the same shape scoped generically to any file.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
checkedOut | boolean | |
checkedOutOn | string | |
watermarkId | string | |
watermarkType | string | |
createdOn | string |
get_record_master_file_version
Gets the latest file version of an Aprimo asset's (record's) master file: version id, label, file name, size, and creation date. Use when the caller only has a record id and needs the file version id (e.g. before calling get_file_versions or other file-version-scoped tools).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex, from a search result or a user-provided link). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileName | string | |
versionLabel | string | |
versionNumber | integer | |
fileSize | integer | |
fileExtension | string | |
isLatest | boolean | |
createdOn | string |
list_additional_files
Lists the additional files (renditions, crops, stills, subtitles, etc.) attached to a file version of an Aprimo asset: type, label, file name, size, and usages/purposes. Use when the user asks about renditions or other files beyond the master file for a specific file version.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of AdditionalFilePayload | |
items[].id | string | |
items[].type | string | |
items[].isManual | boolean | |
items[].label | string | |
items[].fileSize | integer | |
items[].fileName | string | |
items[].extension | string | |
items[].usages | array of string | |
items[].purposes | array of string |
list_file_fields
Lists the custom field values set on a file (not the asset/record) of an Aprimo asset, by the file's id. Use includeFields to filter to specific fields (matches by id exactly, or by fieldName/label substring). Display each as "label: value" — never show id/fieldName/dataType to the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
includeFields | string | No | Optional comma-separated list of custom field terms to include. Matching is case-insensitive: an exact match on field id, or a substring match on fieldName or label. Examples: "keywords", "Status", "brand,campaign". Omit to return all fields. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
count | integer | |
items | array of FileFieldPayload | |
items[].fileId | string | |
items[].id | string | |
items[].fieldName | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].value | string (optional) |
list_file_version_linked_versions
Lists the publications an Aprimo file version is used in (or contains), by file version id and link type. Use "Contains" to see the publication items a publication file version contains, or "UsedIn" to see the publications a file version is used in.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
linkedVersionType | string | Yes | The link direction: "Contains" or "UsedIn". |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
linkedVersionType | string | |
count | integer | |
items | array of FileVersionLinkedVersionPayload | |
items[].recordId | string (optional) | |
items[].fileId | string (optional) | |
items[].fileVersionId | string (optional) | |
items[].linkSourceVersionId | string (optional) | |
items[].linkType | string (optional) |
list_file_version_permissions
Gets the calling user's calculated download/delete permissions on an Aprimo file version, by file version id. Distinct from list_user_permissions/list_user_group_permissions, which read named-permission grants rather than these two per-file-version flags.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
canDownload | boolean | |
canDelete | boolean |
list_record_files
Lists every file attached to an Aprimo record (typically just the master file, but a record can have more): checkout status, checkout date, watermark, and creation date per file. Use get_record_master_file for just the master file, or get_file_versions (by file id) for a file's version history.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
count | integer | |
items | array of FilePayload | |
items[].id | string | |
items[].checkedOut | boolean | |
items[].checkedOutOn | string | |
items[].watermarkId | string | |
items[].watermarkType | string | |
items[].createdOn | string |
Get Previews, Thumbnails & Renditions
Read-only · 16 tools (15 currently available) · Group ID previews-renditions
Needs: View Files & Versions
| Tool | What it does |
|---|---|
get_additional_file_preview | Gets one preview of an additional file of an Aprimo asset, by the additional file's id and the preview's integer id (from list_additional_file_previews). |
get_additional_file_preview_url | Returns the main preview image URL (plus width/height/size/extension) for an additional file of an Aprimo asset, by its id. |
get_file_preview | Gets one preview of a file version on an Aprimo asset by its id: page number, name, and whether it's the master preview or manually added. |
get_file_preview_image_url | Returns the preview image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. |
get_file_preview_thumbnail_url | Returns the thumbnail image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. |
get_file_preview_url | Returns the preview image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. |
get_file_thumbnail_url | Returns the thumbnail image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. |
get_file_version_master_preview | Gets the master preview of an Aprimo file version: page number, name, and whether it was added manually. |
get_file_version_preview_url | Returns the preview image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. |
get_file_version_thumbnail_url | Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. |
get_record_preview_url | Returns the preview image URL for an Aprimo record. |
get_record_thumbnail_url | Returns the thumbnail image URL for an Aprimo record. |
get_rendition | Gets one Aprimo rendition's detail (name, type, extension, uri, preview, published uri) by id. |
list_additional_file_previews | Not currently available. Lists the generated preview pages for an additional file of an Aprimo asset: integer preview id and metadata. |
list_file_previews | Lists the previews generated for a file version of an Aprimo asset: page number, name, and whether each is the master preview or manually added. |
list_file_version_renditions | Lists the Aprimo renditions (generated derivatives — thumbnails, resized previews, converted formats) for a file version, by file version id. |
get_additional_file_preview
Gets one preview of an additional file of an Aprimo asset, by the additional file's id and the preview's integer id (from list_additional_file_previews). Returns metadata; use get_additional_file_preview_url instead if you just need the image URL.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
filePreviewId | integer | Yes | The preview's integer id (from list_additional_file_previews) — not a GUID, unlike the standalone file-preview resource used by get_file_preview. |
Returns:
| Field | Type | Description |
|---|---|---|
additionalFileId | string | |
id | integer | |
metadata | array of string | |
uri | string (optional) |
get_additional_file_preview_url
Returns the main preview image URL (plus width/height/size/extension) for an additional file of an Aprimo asset, by its id. The URL remains valid for twenty-four hours. Returns a friendly message if no preview has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
Returns:
| Field | Type | Description |
|---|---|---|
additionalFileId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_preview
Gets one preview of a file version on an Aprimo asset by its id: page number, name, and whether it's the master preview or manually added. Use list_file_previews first to find the id from a file version. Not its image URL (get_file_preview_image_url), thumbnail URL (get_file_preview_thumbnail_url), or preview URL (get_file_preview_url).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
pageNumber | integer | |
name | string | |
isMaster | boolean | |
isManual | boolean | |
createdOn | string |
get_file_preview_image_url
Returns the preview image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews or get_file_preview). |
Returns:
| Field | Type | Description |
|---|---|---|
filePreviewId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_preview_thumbnail_url
Returns the thumbnail image URL (plus width/height/size/extension) for a file preview on an Aprimo asset, by its id. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews or get_file_preview). |
Returns:
| Field | Type | Description |
|---|---|---|
filePreviewId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_preview_url
Returns the preview image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. The URL remains valid for twenty-four hours. Returns a friendly message if no preview has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_thumbnail_url
Returns the thumbnail image URL (plus width/height/size/extension) for a file on an Aprimo asset, by file id. The URL remains valid for twenty-four hours. Returns a friendly message if no thumbnail has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_version_master_preview
Gets the master preview of an Aprimo file version: page number, name, and whether it was added manually. Use list_file_previews to see every preview, or this tool when only the master (primary) preview is needed.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
pageNumber | integer | |
name | string | |
isMaster | boolean | |
isManual | boolean | |
createdOn | string |
get_file_version_preview_url
Returns the preview image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. The URL remains valid for twenty-four hours. Returns a friendly message if no preview has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_version_thumbnail_url
Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file version's file preview, by file version id. The URL remains valid for twenty-four hours. Returns a friendly message if no thumbnail has been generated yet. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_record_preview_url
Returns the preview image URL for an Aprimo record. Previews are larger images (typically 800x600) suitable for detail views. The URL contains a time-limited SAS token (typically 24 hours). Returns a user-friendly message if no preview exists. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record ID (GUID format). Obtain from search_aprimo results. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
title | string (optional) | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
extension | string (optional) |
get_record_thumbnail_url
Returns the thumbnail image URL for an Aprimo record. Thumbnails are small images (typically 150x150) suitable for list/grid displays. The URL contains a time-limited SAS token (typically 24 hours). Returns a user-friendly message if no thumbnail exists. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record ID (GUID format). Obtain from search_aprimo results. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
title | string (optional) | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
extension | string (optional) |
get_rendition
Gets one Aprimo rendition's detail (name, type, extension, uri, preview, published uri) by id. A rendition is a generated derivative of a file version — a thumbnail, resized preview, or converted format — produced by DAM's media processing pipeline. Use list_rendition_public_links to find any public links pointing at this rendition.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
renditionId | string | Yes | The rendition id (GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
type | string (optional) | |
name | string (optional) | |
extension | string (optional) | |
preview | string (optional) | |
publishedUri | string (optional) |
list_additional_file_previews
Not currently available
Lists the generated preview pages for an additional file of an Aprimo asset: integer preview id and metadata. Use when the user asks about preview images/pages for a specific additional file (not a file version — use list_file_previews for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
additionalFileId | string | Yes | The additional file id (32-char hex, from list_additional_files or get_additional_file). |
Returns:
| Field | Type | Description |
|---|---|---|
additionalFileId | string | |
count | integer | |
items | array of AdditionalFilePreviewPayload | |
items[].additionalFileId | string | |
items[].id | integer | |
items[].metadata | array of string | |
items[].uri | string (optional) |
list_file_previews
Lists the previews generated for a file version of an Aprimo asset: page number, name, and whether each is the master preview or manually added. Use when the user asks about preview images/pages for a specific file version.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of FilePreviewPayload | |
items[].id | string | |
items[].pageNumber | integer | |
items[].name | string | |
items[].isMaster | boolean | |
items[].isManual | boolean | |
items[].createdOn | string |
list_file_version_renditions
Lists the Aprimo renditions (generated derivatives — thumbnails, resized previews, converted formats) for a file version, by file version id. Use to look up a rendition's id before calling get_rendition.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of RenditionPayload | |
items[].id | string | |
items[].uri | string (optional) | |
items[].type | string (optional) | |
items[].name | string (optional) | |
items[].extension | string (optional) | |
items[].preview | string (optional) | |
items[].publishedUri | string (optional) |
Read the Content Model
Read-only · 20 tools · Group ID read-content-model
Needs: no other groups.
| Tool | What it does |
|---|---|
get_classification_field | Gets one custom field's value on an Aprimo classification, by classification id/name/namePath plus the field id. |
get_content_type | Gets one Aprimo content type's detail (purpose, parent, registered fields, labels, dates) by id. |
get_content_type_by_name | Gets one Aprimo content type's detail by its exact name, via DAM's dedicated by-name lookup (distinct from get_content_type, which looks up by id). |
get_content_type_parent | Gets the parent content type of an Aprimo content type, by id or by name. |
get_custom_field_definition | Returns the definition of a custom field in Aprimo, including its data type, validation rules, and available values for option list fields. |
get_field_definition_list_values | Lists the classifications selectable as values on a classification-list Aprimo field definition, by id or by name. |
get_field_group | Gets one Aprimo field group's detail (name, custom tag, dates) by id or by name. |
get_file_type | Gets one Aprimo file type's detail (extension, MIME type, engine/preview format, registered fields, supported operations, labels) by id or by name. |
get_file_type_icon | Returns the icon image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name. |
get_file_type_thumbnail | Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name. |
get_language | Gets one Aprimo language's detail (name, culture, custom tag, enabled-for-fields/UI flags, dates) by id or by name. |
list_classification_fields | Lists every custom field value set on one Aprimo classification, by id, name, or name path. |
list_content_types | Lists the content types configured in Aprimo: name, purpose, parent, registered fields, labels, and dates. |
list_content_types_info | Lists every Aprimo content type's basic info only: id, name, and parent id — a lighter-weight alternative to list_content_types when the caller doesn't need fields/labels/config, e.g. to build a content-type hierarchy or a quick id lookup. |
list_field_definitions | Lists the custom metadata field definitions configured in Aprimo: name, label, data type, scope, validation, and dates. |
list_field_group_members | Lists the custom metadata field definitions that are members of an Aprimo field group, by id or by name. |
list_field_groups | Lists the field groups configured in Aprimo — named groupings of custom metadata field definitions, used to organize related fields for display in the DAM UI. |
list_file_types | Lists the file types configured in Aprimo (e.g. Jpeg, PDF, MP4) — name, extension, MIME type, engine/preview format, and supported operations. |
list_languages | Lists the languages enabled in Aprimo for multi-language fields/labels: name, culture, enabled-for-fields/UI flags, and dates. |
search_field_definitions | Searches custom metadata field definitions in Aprimo with the filter sent in the request body instead of the query string — functionally equivalent to list_field_definitions, but usable when the filter expression is too long for a header/query string. |
get_classification_field
Gets one custom field's value on an Aprimo classification, by classification id/name/namePath plus the field id. Use after list_classification_fields to look up a field's id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldId | string | Yes | The field id (GUID), from list_classification_fields. |
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fieldName | string (optional) | |
label | string (optional) | |
dataType | string (optional) | |
value | string (optional) |
get_content_type
Gets one Aprimo content type's detail (purpose, parent, registered fields, labels, dates) by id. Use after list_content_types, or use get_content_type_by_name when the user names the content type directly. Not its parent either (use get_content_type_parent for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentTypeId | string | Yes | The content type id (GUID), from list_content_types. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
purpose | string (optional) | |
parentId | string (optional) | |
isManual | boolean | |
isNoFile | boolean | |
fileMode | string (optional) | |
inheritanceConfiguration | string (optional) | |
inheritanceFieldId | string (optional) | |
registeredFieldIds | array of string | |
inheritableFieldIds | array of string | |
defaultFileExtensions | array of string | |
labels | array of ContentTypeLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
titleConfigurationOption | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_content_type_by_name
Gets one Aprimo content type's detail by its exact name, via DAM's dedicated by-name lookup (distinct from get_content_type, which looks up by id). Use when the user names the content type directly (e.g. "Video", "Image").
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The content type's exact name (case-insensitive), e.g. "Video". |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
purpose | string (optional) | |
parentId | string (optional) | |
isManual | boolean | |
isNoFile | boolean | |
fileMode | string (optional) | |
inheritanceConfiguration | string (optional) | |
inheritanceFieldId | string (optional) | |
registeredFieldIds | array of string | |
inheritableFieldIds | array of string | |
defaultFileExtensions | array of string | |
labels | array of ContentTypeLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
titleConfigurationOption | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_content_type_parent
Gets the parent content type of an Aprimo content type, by id or by name. Returns an error if the content type doesn't exist or has no parent (e.g. it is a root content type like "Record").
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentTypeId | string | No | The content type id (GUID) whose parent to fetch. Provide this or name, not both. |
name | string | No | The content type's name (case-insensitive, exact match). Provide this or contentTypeId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
purpose | string (optional) | |
parentId | string (optional) | |
isManual | boolean | |
isNoFile | boolean | |
fileMode | string (optional) | |
inheritanceConfiguration | string (optional) | |
inheritanceFieldId | string (optional) | |
registeredFieldIds | array of string | |
inheritableFieldIds | array of string | |
defaultFileExtensions | array of string | |
labels | array of ContentTypeLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
titleConfigurationOption | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_custom_field_definition
Returns the definition of a custom field in Aprimo, including its data type, validation rules, and available values for option list fields. Use this before update_record_metadata_field to understand a field's type and constraints. The field definition ID is a GUID — get it from the field's 'id' property in get_record_metadata results. For option list fields, the response includes the list of valid option values (name/label pairs).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | Yes | The field definition ID (GUID format). Get from get_record_metadata results: each field in the 'fields' array has an 'id' property. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
label | string (optional) | |
dataType | string (optional) | |
isRequired | boolean | |
isReadOnly | boolean | |
acceptMultipleOptions | boolean (optional) | |
helpText | string (optional) | |
items | array of FieldOptionItem (optional) | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) |
get_field_definition_list_values
Lists the classifications selectable as values on a classification-list Aprimo field definition, by id or by name. Only meaningful for fields whose dataType is ClassificationList.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | No | The field definition id (GUID). Provide this or name, not both. |
name | string | No | The field definition's name (case-insensitive, exact match). Provide this or fieldDefinitionId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldDefinitionId | string | |
count | integer | |
items | array of ClassificationListFieldItemPayload | |
items[].id | string | |
items[].identifier | string (optional) | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].namePath | string (optional) | |
items[].labelPath | string (optional) | |
items[].parentId | string (optional) | |
items[].disabledInDamUi | boolean (optional) | |
items[].hasChildren | boolean (optional) |
get_field_group
Gets one Aprimo field group's detail (name, custom tag, dates) by id or by name. Use after list_field_groups, or pass name directly when the user names the group. Not its creator (get_field_group_created_by) or last modifier (get_field_group_modified_by).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID), from list_field_groups. Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
tag | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_file_type
Gets one Aprimo file type's detail (extension, MIME type, engine/preview format, registered fields, supported operations, labels) by id or by name. Use after list_file_types, or pass name directly when the user names the file type. Not its icon (get_file_type_icon) or thumbnail (get_file_type_thumbnail).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileTypeId | string | No | The file type id (GUID), from list_file_types. Provide this or name, not both. |
name | string | No | The file type's name (case-insensitive, exact match), e.g. "Archive (zip)". Provide this or fileTypeId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | string (optional) | |
extension | string (optional) | |
mimeType | string (optional) | |
engineFormat | string (optional) | |
isCatalogable | boolean | |
mediaEngines | array of string | |
previewFormat | string (optional) | |
previewPlayers | array of string | |
previewRequired | boolean | |
previewKeepDimensions | boolean | |
supportAssetResize | boolean | |
supportAssetWatermark | boolean | |
preferredExtension | boolean | |
tag | string (optional) | |
registeredFieldIds | array of string | |
registeredFieldGroupIds | array of string | |
labels | array of FileTypeLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_file_type_icon
Returns the icon image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileTypeId | string | No | The file type id (GUID). Provide this or name, not both. |
name | string | No | The file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
fileTypeId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_file_type_thumbnail
Returns the thumbnail image URL (plus width/height/size/extension) for an Aprimo file type, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileTypeId | string | No | The file type id (GUID). Provide this or name, not both. |
name | string | No | The file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
fileTypeId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
get_language
Gets one Aprimo language's detail (name, culture, custom tag, enabled-for-fields/UI flags, dates) by id or by name. Use after list_languages, or pass name directly when the user names the language. Not its image (get_language_image) or synonyms (get_language_synonyms).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId | string | No | The language id (GUID), from list_languages. Provide this or name, not both. |
name | string | No | The language's name (case-insensitive, exact match), e.g. "Dutch". Provide this or languageId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
culture | string | |
isEnabledForFields | boolean | |
isEnabledForUI | boolean | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
list_classification_fields
Lists every custom field value set on one Aprimo classification, by id, name, or name path. Use to see a classification's full metadata beyond its core attributes.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
count | integer | |
items | array of SearchAprimoFieldValue | |
items[].id | string | |
items[].fieldName | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].value | string (optional) |
list_content_types
Lists the content types configured in Aprimo: name, purpose, parent, registered fields, labels, and dates. Every Aprimo record has exactly one content type (e.g. Image, Video, Document). Use when the user asks what content types exist, or to look up a content type's id/exact name before calling get_content_type, update_content_type, or delete_content_type by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional partial-name filter (DAM only supports a partial name match for this filter). Omit to list every content type. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of ContentTypePayload | |
items[].id | string | |
items[].name | string | |
items[].purpose | string (optional) | |
items[].parentId | string (optional) | |
items[].isManual | boolean | |
items[].isNoFile | boolean | |
items[].fileMode | string (optional) | |
items[].inheritanceConfiguration | string (optional) | |
items[].inheritanceFieldId | string (optional) | |
items[].registeredFieldIds | array of string | |
items[].inheritableFieldIds | array of string | |
items[].defaultFileExtensions | array of string | |
items[].labels | array of ContentTypeLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].titleConfigurationOption | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_content_types_info
Lists every Aprimo content type's basic info only: id, name, and parent id — a lighter-weight alternative to list_content_types when the caller doesn't need fields/labels/config, e.g. to build a content-type hierarchy or a quick id lookup.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of ContentTypeInfoPayload | |
items[].id | string | |
items[].name | string | |
items[].parentId | string (optional) |
list_field_definitions
Lists the custom metadata field definitions configured in Aprimo: name, label, data type, scope, validation, and dates. Use when the user asks what fields exist, or to look up a field's id/exact name before calling update_field_definition or delete_field_definition by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every field definition. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldDefinitionPayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].scope | string (optional) | |
items[].scopeCategory | string (optional) | |
items[].indexed | boolean (optional) | |
items[].languageMode | string (optional) | |
items[].isRequired | boolean | |
items[].isReadOnly | boolean | |
items[].isUniqueIdentifier | boolean (optional) | |
items[].inlineStyle | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].tag | string (optional) | |
items[].defaultValue | string (optional) | |
items[].resetToDefaultTriggers | array of string | |
items[].resetToDefaultFieldIds | array of string | |
items[].validation | string (optional) | |
items[].validationErrorMessage | string (optional) | |
items[].validationTrigger | string (optional) | |
items[].storageMode | string (optional) | |
items[].helpText | string (optional) | |
items[].helpTexts | array of FieldDefinitionLabelPayload | |
items[].helpTexts[].value | string (optional) | |
items[].helpTexts[].languageId | string | |
items[].labels | array of FieldDefinitionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].enabledLanguageIds | array of string | |
items[].membershipFieldGroupIds | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_field_group_members
Lists the custom metadata field definitions that are members of an Aprimo field group, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID). Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldGroupId | string | |
count | integer | |
items | array of FieldDefinitionPayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].scope | string (optional) | |
items[].scopeCategory | string (optional) | |
items[].indexed | boolean (optional) | |
items[].languageMode | string (optional) | |
items[].isRequired | boolean | |
items[].isReadOnly | boolean | |
items[].isUniqueIdentifier | boolean (optional) | |
items[].inlineStyle | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].tag | string (optional) | |
items[].defaultValue | string (optional) | |
items[].resetToDefaultTriggers | array of string | |
items[].resetToDefaultFieldIds | array of string | |
items[].validation | string (optional) | |
items[].validationErrorMessage | string (optional) | |
items[].validationTrigger | string (optional) | |
items[].storageMode | string (optional) | |
items[].helpText | string (optional) | |
items[].helpTexts | array of FieldDefinitionLabelPayload | |
items[].helpTexts[].value | string (optional) | |
items[].helpTexts[].languageId | string | |
items[].labels | array of FieldDefinitionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].enabledLanguageIds | array of string | |
items[].membershipFieldGroupIds | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_field_groups
Lists the field groups configured in Aprimo — named groupings of custom metadata field definitions, used to organize related fields for display in the DAM UI. Use when the user asks what field groups exist, or to look up a group's id/exact name before calling get_field_group, update_field_group, or delete_field_group by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every field group. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldGroupPayload | |
items[].id | string | |
items[].name | string | |
items[].tag | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_file_types
Lists the file types configured in Aprimo (e.g. Jpeg, PDF, MP4) — name, extension, MIME type, engine/preview format, and supported operations. Use when the user asks what file types exist, or to look up a file type's id/exact name before calling get_file_type, update_file_type, or delete_file_type by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every file type. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FileTypePayload | |
items[].id | string | |
items[].name | string | |
items[].kind | string (optional) | |
items[].extension | string (optional) | |
items[].mimeType | string (optional) | |
items[].engineFormat | string (optional) | |
items[].isCatalogable | boolean | |
items[].mediaEngines | array of string | |
items[].previewFormat | string (optional) | |
items[].previewPlayers | array of string | |
items[].previewRequired | boolean | |
items[].previewKeepDimensions | boolean | |
items[].supportAssetResize | boolean | |
items[].supportAssetWatermark | boolean | |
items[].preferredExtension | boolean | |
items[].tag | string (optional) | |
items[].registeredFieldIds | array of string | |
items[].registeredFieldGroupIds | array of string | |
items[].labels | array of FileTypeLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_languages
Lists the languages enabled in Aprimo for multi-language fields/labels: name, culture, enabled-for-fields/UI flags, and dates. Use when the user asks what languages exist, or to look up a language's id/exact name before calling get_language, update_language, or delete_language by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "Name=Dutch". Omit to list every language. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of LanguagePayload | |
items[].id | string | |
items[].name | string | |
items[].culture | string | |
items[].isEnabledForFields | boolean | |
items[].isEnabledForUI | boolean | |
items[].tag | string (optional) | |
items[].createdOn | string | |
items[].modifiedOn | string |
search_field_definitions
Searches custom metadata field definitions in Aprimo with the filter sent in the request body instead of the query string — functionally equivalent to list_field_definitions, but usable when the filter expression is too long for a header/query string. This is a read: it never modifies data.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ScopeCategory=Record Indexed=true". Omit to match every field definition. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
checkEditPermission | boolean | No | When true, only field definitions the current user is allowed to edit are returned. Defaults to false. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldDefinitionPayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].scope | string (optional) | |
items[].scopeCategory | string (optional) | |
items[].indexed | boolean (optional) | |
items[].languageMode | string (optional) | |
items[].isRequired | boolean | |
items[].isReadOnly | boolean | |
items[].isUniqueIdentifier | boolean (optional) | |
items[].inlineStyle | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].tag | string (optional) | |
items[].defaultValue | string (optional) | |
items[].resetToDefaultTriggers | array of string | |
items[].resetToDefaultFieldIds | array of string | |
items[].validation | string (optional) | |
items[].validationErrorMessage | string (optional) | |
items[].validationTrigger | string (optional) | |
items[].storageMode | string (optional) | |
items[].helpText | string (optional) | |
items[].helpTexts | array of FieldDefinitionLabelPayload | |
items[].helpTexts[].value | string (optional) | |
items[].helpTexts[].languageId | string | |
items[].labels | array of FieldDefinitionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].enabledLanguageIds | array of string | |
items[].membershipFieldGroupIds | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
View Processing, Check & Watermark Results
Can change data · 12 tools (5 currently available) · Group ID view-processing-results
Needs: View Files & Versions
| Tool | What it does |
|---|---|
get_file_process_action | Not currently available. Gets one Aprimo file process action's detail (stage, type, sort index, enabled/allowed flags, conditions, labels) by id. |
get_file_version_check_result | Not currently available. Gets a specific Aprimo file version check result by its own id — this relays an already-computed scanner/check outcome. |
get_file_version_check_result_finding | Not currently available. Gets a single finding (by occurrence number) for one Aprimo file version check result — this relays an already-computed scanner finding: what was found, an explanation, and a recommendation. |
get_file_version_check_result_latest | Not currently available. Gets the latest Aprimo file version check result for a specific check type — this relays an already-computed scanner/check outcome, it never runs a new check. |
get_file_version_watermark | Gets the watermark applied to an Aprimo file version, by file version id: name, position, custom tag, and dates. |
get_file_watermark | Gets the watermark applied to a file on an Aprimo asset, by file id: name, position, custom tag, and dates. |
get_watermark_image | Returns the image URL (plus width/height/size/extension) for an Aprimo watermark, by id or by name. |
list_file_process_actions | Not currently available. Lists the file process actions configured in Aprimo — the configurable steps (e.g. virus scan, preview render) that run at each stage of a file's processing pipeline, in a fixed sort order, and can be individually enabled or disabled. |
list_file_version_check_result_findings | Not currently available. Lists every finding for one Aprimo file version check result — this relays already-computed scanner findings (e.g. a specific security or compliance issue detected). |
list_file_version_check_results | Lists every Aprimo check result recorded for a file version — this relays already-computed scanner/check outcomes. |
list_file_version_process_action_log | Lists the file process action log entries for an Aprimo file version: which pipeline actions ran (e.g. virus scan, preview render), their status, and timing. |
update_file_process_action | Not currently available. Edits an existing Aprimo file process action by id. |
get_file_process_action
Not currently available
Gets one Aprimo file process action's detail (stage, type, sort index, enabled/allowed flags, conditions, labels) by id. Use after list_file_process_actions.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileProcessActionId | string | Yes | The file process action id (GUID), from list_file_process_actions. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
fileProcessActionStageId | string (optional) | |
fileProcessActionType | integer (optional) | /// DAM's FileProcessActionType enum value — see 's remarks for why this is a number, not a string. |
sortIndex | integer | |
isConfigurable | boolean | |
enabled | boolean | |
allowed | boolean | |
label | string (optional) | |
labels | array of FileProcessActionLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
description | string (optional) | |
descriptions | array of FileProcessActionLabelPayload | |
descriptions[].value | string (optional) | |
descriptions[].languageId | string (optional) | |
conditions | array of string | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_file_version_check_result
Not currently available
Gets a specific Aprimo file version check result by its own id — this relays an already-computed scanner/check outcome. Distinct from get_file_version_check_result_latest, which looks up the latest result for a check type rather than a specific result id. Also distinct from get_file_version_check_result_finding, which returns one specific finding within a result, not the result itself.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkResultId | string | Yes | The check result id (GUID, from list_file_version_check_results). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileVersionId | string | |
checkId | string (optional) | |
description | string (optional) | |
outcome | string (optional) | |
createdById | string (optional) | |
createdOn | string (optional) |
get_file_version_check_result_finding
Not currently available
Gets a single finding (by occurrence number) for one Aprimo file version check result — this relays an already-computed scanner finding: what was found, an explanation, and a recommendation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkResultId | string | Yes | The check result id (GUID, from list_file_version_check_results). |
occurrence | integer | Yes | The finding's occurrence number (from list_file_version_check_result_findings), e.g. 1. |
Returns:
| Field | Type | Description |
|---|---|---|
occurrence | integer | |
fileVersionCheckId | string (optional) | |
finding | string (optional) | |
explanation | string (optional) | |
recommendation | string (optional) | |
additionalData | string (optional) | |
outcome | string (optional) |
get_file_version_check_result_latest
Not currently available
Gets the latest Aprimo file version check result for a specific check type — this relays an already-computed scanner/check outcome, it never runs a new check. checkId (from list_checks) is required — confirmed live against DAM: omitting it returns HTTP 400 ("CheckId query parameter is required"), it does not fall back to "any check type". Use list_file_version_check_result_findings for the individual findings behind this result.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkId | string | Yes | The check type id (GUID, from list_checks) to select which check's latest result to read. Required — DAM 400s without it. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileVersionId | string | |
checkId | string (optional) | |
description | string (optional) | |
outcome | string (optional) | |
createdById | string (optional) | |
createdOn | string (optional) |
get_file_version_watermark
Gets the watermark applied to an Aprimo file version, by file version id: name, position, custom tag, and dates. Returns a not-found error if the file version has no watermark assigned.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
position | string | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
get_file_watermark
Gets the watermark applied to a file on an Aprimo asset, by file id: name, position, custom tag, and dates. Returns a not-found error if the file has no watermark assigned.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
position | string | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
get_watermark_image
Returns the image URL (plus width/height/size/extension) for an Aprimo watermark, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID). Provide this or name, not both. |
name | string | No | The watermark's name (case-insensitive, exact match). Provide this or watermarkId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
watermarkId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
list_file_process_actions
Not currently available
Lists the file process actions configured in Aprimo — the configurable steps (e.g. virus scan, preview render) that run at each stage of a file's processing pipeline, in a fixed sort order, and can be individually enabled or disabled. Use when the user asks what processing steps exist, or to look up a file process action's id before calling get_file_process_action or update_file_process_action.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FileProcessActionPayload | |
items[].id | string | |
items[].name | string | |
items[].fileProcessActionStageId | string (optional) | |
items[].fileProcessActionType | integer (optional) | /// DAM's FileProcessActionType enum value — see 's remarks for why this is a number, not a string. |
items[].sortIndex | integer | |
items[].isConfigurable | boolean | |
items[].enabled | boolean | |
items[].allowed | boolean | |
items[].label | string (optional) | |
items[].labels | array of FileProcessActionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].description | string (optional) | |
items[].descriptions | array of FileProcessActionLabelPayload | |
items[].descriptions[].value | string (optional) | |
items[].descriptions[].languageId | string (optional) | |
items[].conditions | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_file_version_check_result_findings
Not currently available
Lists every finding for one Aprimo file version check result — this relays already-computed scanner findings (e.g. a specific security or compliance issue detected). Use get_file_version_check_result_finding to read a single finding by its occurrence number.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
checkResultId | string | Yes | The check result id (GUID, from list_file_version_check_results). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
checkResultId | string | |
count | integer | |
items | array of FileVersionCheckResultFindingPayload | |
items[].occurrence | integer | |
items[].fileVersionCheckId | string (optional) | |
items[].finding | string (optional) | |
items[].explanation | string (optional) | |
items[].recommendation | string (optional) | |
items[].additionalData | string (optional) | |
items[].outcome | string (optional) |
list_file_version_check_results
Lists every Aprimo check result recorded for a file version — this relays already-computed scanner/check outcomes. Use to look up a check result's id before calling get_file_version_check_result or list_file_version_check_result_findings.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of FileVersionCheckResultPayload | |
items[].id | string | |
items[].fileVersionId | string | |
items[].checkId | string (optional) | |
items[].description | string (optional) | |
items[].outcome | string (optional) | |
items[].createdById | string (optional) | |
items[].createdOn | string (optional) |
list_file_version_process_action_log
Lists the file process action log entries for an Aprimo file version: which pipeline actions ran (e.g. virus scan, preview render), their status, and timing. Use when the user asks what processing happened to a file version or why a processing step failed.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of FileVersionProcessActionLogPayload | |
items[].id | string | |
items[].fileVersionId | string | |
items[].label | string (optional) | |
items[].description | string (optional) | |
items[].status | string (optional) | |
items[].details | string (optional) | |
items[].createdOn | string (optional) | |
items[].completedOn | string (optional) |
update_file_process_action
Not currently available
Edits an existing Aprimo file process action by id. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact file process action and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileProcessActionId | string | Yes | The file process action id (GUID) to edit, from list_file_process_actions/get_file_process_action. |
name | string | No | New name for the file process action. Omit to leave the name unchanged. |
sortIndex | integer | No | New sort index within its stage. Omit to leave it unchanged. |
enabled | boolean | No | New enabled flag. Omit to leave it unchanged. |
conditions | array of string | No | New conditions collection — replaces the entire existing collection (not merged). Omit to leave conditions unchanged. |
label | string | No | New name label in the current user's language. Omit to leave it unchanged. |
labels | object (map of string) | No | New multi-language name labels: a map of languageId (GUID) to label value. Omit to leave labels unchanged. |
description | string | No | New description in the current user's language. Omit to leave it unchanged. |
descriptions | object (map of string) | No | New multi-language descriptions: a map of languageId (GUID) to description value. Omit to leave descriptions unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Download & Order Files
Can change data · 23 tools (17 currently available) · Group ID download-order-files
Needs: Find & Discover Content, View Files & Versions
| Tool | What it does |
|---|---|
accept_download_link_agreement | Not currently available. Records the calling user's acceptance of a download's applicable download agreement, confirming they accept the terms in their language version of it. |
accept_record_download_agreement | Records the calling user's acceptance of a record's download agreement, confirming they accept the terms in their language version of it. |
check_download_order_status | Checks the status of a download order created by get_record_download_url — including one that handed off after a poll timeout — and returns the download URL once ready. |
check_shared_download_link | Not currently available. Checks the status of a shared download link order created by submit_shared_download_link, and returns the shareable link once ready. |
get_download_link | Gets one Aprimo download link's detail (status, delivered files, applicable download agreement ids) by id — the result of a maintenance job that generates downloadable files (a download order, export, or contact sheet). |
get_order_target | Gets one target of an Aprimo order by order id and order target id — which record/file was ordered, its asset type, and its per-target status. |
get_record_download_agreement | Gets the applicable Aprimo download agreement's content (title + terms-of-use text) for a record, in the calling user's own language. |
get_record_download_url | Places a download order for the original file of an Aprimo record and returns the download URL. |
get_shared_download_link | Not currently available. Gets one Aprimo shared download link's detail (verification requirement, whether it was emailed, expiration) by id -- not the download URI itself (use get_shared_download_link_file_uri for that). |
get_shared_download_link_file_uri | Not currently available. Gets the download URI (not the file's bytes) for one file attached to an Aprimo shared download link, by shared download link id and file id. |
list_download_link_targets | Lists the target ids of an Aprimo download link by id — which records/files it covers. |
list_download_links | Lists the download links in Aprimo — the results of maintenance jobs that generate downloadable files (download orders, exports, contact sheets). |
list_order_targets | Lists every target of an Aprimo order by order id — which records/files were ordered and each one's per-target status. |
list_orders | Lists Aprimo orders (download/publicCdn/shareDownloadLink/email/ftp/etc.): id, order type, status, dates, and delivered files. |
request_shared_download_link_verification_code | Not currently available. Requests a verification code for an Aprimo shared download link and emails it to the given recipient. |
search_download_agreements | Searches for the Aprimo download agreements applicable to a given set of records. |
submit_shared_download_link | Not currently available. Generates a DAM shared download link for one or more Aprimo assets, optionally emailing it to recipients. |
update_order | Edits an existing Aprimo order's status and/or delivered files, by order id. |
list_shared_download_link_downloads | Lists the download-activity events (which file, which recipient, when) for an Aprimo shared download link, newest first. |
list_shared_download_links | Lists Aprimo shared download links -- by default only the ones created by the current user. |
revoke_shared_download_link | Revokes an Aprimo shared download link. |
search_shared_download_link_recipients | Searches distinct recipient email addresses across Aprimo shared download links (by default only recipients of links created by the current user) -- powers a recipient-filter autocomplete. |
update_shared_download_link_expiration | Changes the expiration date of an Aprimo shared download link. |
accept_download_link_agreement
Not currently available
Records the calling user's acceptance of a download's applicable download agreement, confirming they accept the terms in their language version of it. This modifies data. Always show the user the agreement's content (via get_download_agreement_content or get_record_download_agreement) and confirm they accept it, then call again with confirmed=true.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadId | string | Yes | The download's id (the download link's own id, 32-char hex or GUID) whose download agreement is being accepted. |
contentId | integer | Yes | The download agreement content id being accepted. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed they accept the agreement's content. |
Returns:
| Field | Type | Description |
|---|---|---|
downloadId | string | |
contentId | integer | |
accepted | boolean |
accept_record_download_agreement
Records the calling user's acceptance of a record's download agreement, confirming they accept the terms in their language version of it. This modifies data. Always show the user the agreement's content (via get_record_download_agreement) and confirm they accept it before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex or GUID) whose download agreement is being accepted. |
contentId | integer | Yes | The download agreement content id being accepted, from get_record_download_agreement. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
contentId | integer | |
accepted | boolean |
check_download_order_status
Checks the status of a download order created by get_record_download_url — including one that handed off after a poll timeout — and returns the download URL once ready. If the order is still processing, this is a normal outcome, not an error: tell the user it's still processing and offer to check again shortly, then call this tool again later with the same order id. If the order failed, this call returns a tool error explaining why. Do not resubmit get_record_download_url while waiting — that creates a new, separate order.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order id returned by get_record_download_url (including from its poll-timeout hand-off). |
Returns:
| Field | Type | Description |
|---|---|---|
downloadUrl | string (optional) | |
orderId | string (optional) | |
totalFileSize | integer (optional) | |
status | string (optional) | /// Order status hand-off field (Phase 10a, #44b): "completed" once is populated, "processing" when the order hasn't reached a terminal state yet (returned on get_record_download_url's poll-timeout hand-off, and by check_download_order_status while still running) — a normal, actionable, non-error outcome. Null on the original immediate-completion shape so existing callers that only read / are unaffected. |
check_shared_download_link
Not currently available
Checks the status of a shared download link order created by submit_shared_download_link, and returns the shareable link once ready. If the order is still processing, this is a normal outcome, not an error: tell the user it's still processing and offer to check again shortly, then call this tool again later with the same order id. If the order failed, this call returns a tool error explaining why. Expiry and verification settings live on the separate shared-download-link resource, not here. Display format: when ready, show the shared link as a plain URL.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order id returned by submit_shared_download_link. |
Returns:
| Field | Type | Description |
|---|---|---|
orderId | string | |
status | string | |
shareUri | string (optional) | |
sharedDownloadLinkId | string (optional) | |
message | string (optional) |
get_download_link
Gets one Aprimo download link's detail (status, delivered files, applicable download agreement ids) by id — the result of a maintenance job that generates downloadable files (a download order, export, or contact sheet). Use after list_download_links, or when you already have the id from another tool's output. Use list_download_link_targets to see which records/files it covers.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadLinkId | string | Yes | The download link id (32-char hex or GUID), from list_download_links. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
type | string (optional) | |
status | string (optional) | |
title | string (optional) | |
description | string (optional) | |
errorDescription | string (optional) | |
deliveredFiles | array of string (optional) | |
failedTargetsCount | integer (optional) | |
succeededRecordsCount | integer (optional) | |
failedRecordsCount | integer (optional) | |
downloadAgreementIds | array of integer (optional) | |
createdOn | string (optional) |
get_order_target
Gets one target of an Aprimo order by order id and order target id — which record/file was ordered, its asset type, and its per-target status. Use after list_order_targets, or when you already have both ids.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order id (GUID). |
orderTargetId | string | Yes | The order target id (GUID), from list_order_targets. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
recordId | string (optional) | |
itemId | string (optional) | |
recordIds | array of string (optional) | |
assetType | string (optional) | |
fileName | string (optional) | |
status | string (optional) | |
message | string (optional) | |
errorDetails | string (optional) | |
attempt | integer (optional) |
get_record_download_agreement
Gets the applicable Aprimo download agreement's content (title + terms-of-use text) for a record, in the calling user's own language. Use before accept_record_download_agreement, to show the user what they're accepting and to get its content id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex or GUID) to get the applicable download agreement for. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
languageId | string (optional) | |
version | integer (optional) | |
title | string (optional) | |
termsOfUse | string (optional) |
get_record_download_url
Places a download order for the original file of an Aprimo record and returns the download URL. Downloads the latest version of the master file without transformations. The download URL contains a time-limited SAS token. Each call creates a new download order — results are not cached. Use get_record_metadata first to verify the record exists and has a master file.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record ID (GUID format). Obtain from search_aprimo or get_record_metadata results. |
Returns:
| Field | Type | Description |
|---|---|---|
downloadUrl | string (optional) | |
orderId | string (optional) | |
totalFileSize | integer (optional) | |
status | string (optional) | /// Order status hand-off field (Phase 10a, #44b): "completed" once is populated, "processing" when the order hasn't reached a terminal state yet (returned on get_record_download_url's poll-timeout hand-off, and by check_download_order_status while still running) — a normal, actionable, non-error outcome. Null on the original immediate-completion shape so existing callers that only read / are unaffected. |
get_shared_download_link
Not currently available
Gets one Aprimo shared download link's detail (verification requirement, whether it was emailed, expiration) by id -- not the download URI itself (use get_shared_download_link_file_uri for that). A shared download link is a controlled alternative to a plain public link for sharing a set of files with a named recipient by email. Use get_shared_download_link_file_uri to get the download URI for one of its files.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID), from submit_shared_download_link/check_shared_download_link. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
useVerification | boolean (optional) | |
sendEmail | boolean (optional) | |
expiresOn | string (optional) | |
createdOn | string (optional) |
get_shared_download_link_file_uri
Not currently available
Gets the download URI (not the file's bytes) for one file attached to an Aprimo shared download link, by shared download link id and file id. If the link requires verification (see get_shared_download_link), pass the recipient's email and the verification code from request_shared_download_link_verification_code.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
fileId | integer | Yes | The file id, from the shared download link's files. |
email | string | No | The recipient's email, for verification. Only required when the link is configured to require verification. |
verificationCode | string | No | The verification code, from request_shared_download_link_verification_code. Only required when the link is configured to require verification. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | integer | |
sharedDownloadLinkId | string (optional) | |
downloadUri | string (optional) |
list_download_link_targets
Lists the target ids of an Aprimo download link by id — which records/files it covers.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadLinkId | string | Yes | The download link id (32-char hex or GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
downloadLinkId | string | |
count | integer | |
items | array of string |
list_download_links
Lists the download links in Aprimo — the results of maintenance jobs that generate downloadable files (download orders, exports, contact sheets). Use when the user asks what downloads exist or their status, or to look up a download link's id before calling get_download_link, list_download_link_targets, or accept_download_link_agreement.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every download link. |
sort | string | No | Optional sort expression, e.g. "createdon". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of DownloadLinkPayload | |
items[].id | string | |
items[].type | string (optional) | |
items[].status | string (optional) | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].errorDescription | string (optional) | |
items[].deliveredFiles | array of string (optional) | |
items[].failedTargetsCount | integer (optional) | |
items[].succeededRecordsCount | integer (optional) | |
items[].failedRecordsCount | integer (optional) | |
items[].downloadAgreementIds | array of integer (optional) | |
items[].createdOn | string (optional) |
list_order_targets
Lists every target of an Aprimo order by order id — which records/files were ordered and each one's per-target status. Use to look up an order target's id before calling get_order_target.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order id (GUID) whose targets to list. |
Returns:
| Field | Type | Description |
|---|---|---|
orderId | string | |
count | integer | |
items | array of OrderTargetPayload | |
items[].id | string | |
items[].recordId | string (optional) | |
items[].itemId | string (optional) | |
items[].recordIds | array of string (optional) | |
items[].assetType | string (optional) | |
items[].fileName | string (optional) | |
items[].status | string (optional) | |
items[].message | string (optional) | |
items[].errorDetails | string (optional) | |
items[].attempt | integer (optional) |
list_orders
Lists Aprimo orders (download/publicCdn/shareDownloadLink/email/ftp/etc.): id, order type, status, dates, and delivered files. Use when the user asks what orders exist or their status, or to look up an order id before calling update_order, list_order_targets, check_public_link, or check_shared_download_link.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every order. |
sort | string | No | Optional sort expression, e.g. "createdOn desc". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of OrderSummaryPayload | |
items[].orderId | string | |
items[].orderType | string (optional) | |
items[].status | string (optional) | |
items[].createdOn | string (optional) | |
items[].startedOn | string (optional) | |
items[].message | string (optional) | |
items[].failedTargetsCount | integer (optional) | |
items[].deliveredFiles | array of DeliveredFilePayload (optional) | |
items[].deliveredFiles[].deliveredPath | string (optional) | |
items[].deliveredFiles[].recordId | string (optional) | |
items[].deliveredFiles[].renditionName | string (optional) | |
items[].deliveredFiles[].status | string (optional) | |
items[].totalFileSize | integer (optional) |
request_shared_download_link_verification_code
Not currently available
Requests a verification code for an Aprimo shared download link and emails it to the given recipient. This sends an email. Use when a shared download link requires verification (see get_shared_download_link) and the recipient needs a new code, e.g. before calling get_shared_download_link_file_uri.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
email | string | Yes | Email address of the recipient who should receive the verification code. |
Returns:
| Field | Type | Description |
|---|---|---|
sharedDownloadLinkId | string | |
requested | boolean |
search_download_agreements
Searches for the Aprimo download agreements applicable to a given set of records. This is a lookup (read-only), even though DAM exposes it as a POST — no confirmation is required.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordIds | array of string | Yes | The record ids (32-char hex or GUID) to find applicable download agreements for. |
filter | string | No | Optional filter expression (DAM query syntax). Omit to apply no additional filter. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of DownloadAgreementPayload | |
items[].id | integer | |
items[].enabled | boolean (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
submit_shared_download_link
Not currently available
Generates a DAM shared download link for one or more Aprimo assets, optionally emailing it to recipients. This modifies data (creates a DAM order) and makes the asset(s) accessible via a shareable link, optionally emailed to the given recipients. Always confirm with the user that the asset(s) should be shared this way before calling this tool. Does not return the link immediately — Aprimo processes shareDownloadLink orders asynchronously. This tool only returns an order id: after calling it, call check_shared_download_link with that same order id to find out when the link is ready and get it. Expiry and verification settings live on the separate shared-download-link resource, not on this order — out of scope for this tool. Use when the user asks to share, send a download link for, or email a link to one or more assets. Do not tell the user the link is ready until check_shared_download_link confirms it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordIds | array of string | Yes | The record ids (32-char hex) of the assets to generate a shared download link for. |
emailRecipients | array of string | No | Optional email addresses to send the shared download link to. |
emailMessage | string | No | Optional email message text to include when sending the link by email. |
sendEmail | boolean | No | Whether to email the shared download link to emailRecipients once ready. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user explicitly confirms the asset(s) should be shared this way. |
Returns:
| Field | Type | Description |
|---|---|---|
orderId | string | |
status | string |
update_order
Edits an existing Aprimo order's status and/or delivered files, by order id. Only the fields provided are changed — omitted fields are expected to keep their current value (this assumes DAM merges the edit rather than fully replacing the order; unverified for this endpoint). This modifies data. Always confirm the exact order and the new values with the user before calling this tool. Valid status values: Pending, Success, Failed, PartiallyFailed, Executing, Cancelled, Scheduled, Queued, AsyncPending, AsyncExecuting.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order id (GUID) to edit. |
status | string | No | New lifecycle status for the order. Omit to leave the status unchanged. |
deliveredFiles | array of string | No | New list of delivered files for the order. Omit to leave delivered files unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
orderId | string | |
status | string (optional) | |
deliveredFiles | array of string (optional) |
list_shared_download_link_downloads
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
skip | integer | No | Number of activity events to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of activity events to return. Omit for the endpoint's default page size. |
list_shared_download_links
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
allUsers | boolean | No | When true, returns links created by any user in the tenant. Requires the caller to be a member of the Administrators user group. Defaults to false. |
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every shared download link in scope. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
revoke_shared_download_link
Destructive
Revokes an Aprimo shared download link. THIS IS IRREVERSIBLE -- a revoked link no longer grants downloads to anyone, and there is no way to un-revoke it. Requires confirmed=true and confirmedDestructive=true; call again with both set to true only after the user has explicitly confirmed.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact shared download link. |
confirmedDestructive | boolean | No | Must ALSO be true (in addition to confirmed) -- revoking a shared download link is irreversible. Set only after stating the exact shared download link to the user and getting explicit go-ahead. |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
search_shared_download_link_recipients
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Free text to match against recipient email (contains, case-insensitive). |
allUsers | boolean | No | When true, searches recipients across every link in the tenant. Requires the caller to be a member of the Administrators user group. Defaults to false. |
skip | integer | No | Number of distinct emails to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of distinct emails to return. Omit for the endpoint's default page size. |
update_shared_download_link_expiration
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
expiresOn | string | Yes | The new expiration date/time, in UTC, ISO 8601 (e.g. "2026-09-01T00:00:00Z"). Must be in the future. |
View Public Links
Read-only · 4 tools (3 currently available) · Group ID view-public-links
Needs: View Files & Versions
| Tool | What it does |
|---|---|
check_public_link | Checks the status of a public CDN link order created by submit_public_link, and returns the public link once ready. |
get_public_link | Not currently available. Gets one Aprimo public link's detail (uri, status, provider, the record/file version it targets) by id. |
list_file_version_public_links | Lists the Aprimo public links pointing at a file version, by file version id. |
list_rendition_public_links | Lists the Aprimo public links pointing at a rendition, by rendition id. |
check_public_link
Checks the status of a public CDN link order created by submit_public_link, and returns the public link once ready. If the order is still processing, this is a normal outcome, not an error: tell the user it's still processing and offer to check again shortly, then call this tool again later with the same order id. If the order failed, this call returns a tool error explaining why. Display format: when ready, show each delivered link as a plain URL, one per line.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order id returned by submit_public_link. |
Returns:
| Field | Type | Description |
|---|---|---|
orderId | string | |
status | string | |
deliveredFiles | array of DeliveredFilePayload (optional) | |
deliveredFiles[].deliveredPath | string (optional) | |
deliveredFiles[].recordId | string (optional) | |
deliveredFiles[].renditionName | string (optional) | |
deliveredFiles[].status | string (optional) | |
message | string (optional) |
get_public_link
Not currently available
Gets one Aprimo public link's detail (uri, status, provider, the record/file version it targets) by id. A public link is a shareable, tokenized URL granting unauthenticated access to a specific file version's content. Use list_rendition_public_links to find a public link's id starting from a rendition.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
publicLinkId | string | Yes | The public link id (GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
status | string (optional) | |
canDelete | boolean (optional) | |
provider | string (optional) | |
recordId | string (optional) | |
fileVersionId | string (optional) | |
additionalFileId | string (optional) | |
fileSize | integer (optional) | |
renditionName | string (optional) | |
origin | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
list_file_version_public_links
Lists the Aprimo public links pointing at a file version, by file version id. Use to look up a public link's id before calling get_public_link.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The file version id (32-char hex, from get_file_versions or get_record_master_file_version). |
Returns:
| Field | Type | Description |
|---|---|---|
fileVersionId | string | |
count | integer | |
items | array of PublicLinkPayload | |
items[].id | string | |
items[].uri | string (optional) | |
items[].status | string (optional) | |
items[].canDelete | boolean (optional) | |
items[].provider | string (optional) | |
items[].recordId | string (optional) | |
items[].fileVersionId | string (optional) | |
items[].additionalFileId | string (optional) | |
items[].fileSize | integer (optional) | |
items[].renditionName | string (optional) | |
items[].origin | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (optional) |
list_rendition_public_links
Lists the Aprimo public links pointing at a rendition, by rendition id. Use to look up a public link's id before calling get_public_link.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
renditionId | string | Yes | The rendition id (GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
renditionId | string | |
count | integer | |
items | array of PublicLinkPayload | |
items[].id | string | |
items[].uri | string (optional) | |
items[].status | string (optional) | |
items[].canDelete | boolean (optional) | |
items[].provider | string (optional) | |
items[].recordId | string (optional) | |
items[].fileVersionId | string (optional) | |
items[].additionalFileId | string (optional) | |
items[].fileSize | integer (optional) | |
items[].renditionName | string (optional) | |
items[].origin | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (optional) |