Orders
Tools for download orders and their targets, and for checking or submitting public and shared download links.
This page covers 8 tools, all of them available on request rather than in the default tool list.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. 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. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
check_public_link | On request | Checks the status of a public CDN link order created by submit_public_link, and returns the public link once ready. |
check_shared_download_link | On request | Checks the status of a shared download link order created by submit_shared_download_link, and returns the shareable link once ready. |
get_order_target | On request | 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. |
list_order_targets | On request | Lists every target of an Aprimo order by order id — which records/files were ordered and each one's per-target status. |
list_orders | On request | Lists Aprimo orders (download/publicCdn/shareDownloadLink/email/ftp/etc.): id, order type, status, dates, and delivered files. |
submit_public_link | On request | Generates a DAM public CDN link for one Aprimo asset. |
submit_shared_download_link | On request | Generates a DAM shared download link for one or more Aprimo assets, optionally emailing it to recipients. |
update_order | On request | Edits an existing Aprimo order's status and/or delivered files, by order id. |
check_public_link
Available on request
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) |
check_shared_download_link
Available on request
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_order_target
Available on request
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) |
list_order_targets
Available on request
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
Available on request
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) |
submit_public_link
Available on request
Generates a DAM public CDN link for one Aprimo asset. This modifies data (creates a DAM order) and makes the asset publicly accessible via an unauthenticated CDN link that stays live until deleted. Always confirm with the user that the asset should be made publicly accessible before calling this tool. Does not return the link immediately — Aprimo processes public CDN orders asynchronously. This tool only returns an order id: after calling it, call check_public_link with that same order id to find out when the link is ready and get it. Use when the user asks for a public link, CDN link, or a shareable direct link to an asset. Do not tell the user the link is ready until check_public_link confirms it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex) of the asset to generate a public CDN link for. |
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 should be made publicly accessible. |
Returns:
| Field | Type | Description |
|---|---|---|
orderId | string | |
status | string |
submit_shared_download_link
Available on request
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
Available on request
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) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent