Automate & process files
Automate work on files with rules and maintenance jobs, configure automated checks, and set up watermarks and image overlays.
This area has 3 groups and 33 tools, 32 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 |
|---|---|---|---|
| Automate Rules & Maintenance Jobs | Can change data | Read the Content Model, Find & Discover Content, Look Up DAM Users & Groups | 16 |
| Configure Automated Checks | Can change data | Read the Content Model | 7 |
| Configure Watermarks & Image Overlays | Can change data | Find & Discover Content, Look Up DAM Users & Groups | 10 |
Automate Rules & Maintenance Jobs
Can change data · 16 tools · Group ID automate-rules-maintenance-jobs
Needs: Read the Content Model, Find & Discover Content, Look Up DAM Users & Groups
| Tool | What it does |
|---|---|
check_maintenance_job | Checks the status of a maintenance job created by create_maintenance_job. |
create_maintenance_job | Destructive. Creates an Aprimo maintenance job that bulk-applies one or more actions (e.g. append/replace/overwrite a field, change classification, change record/collection status, delete) across one or more record or collection targets. |
create_rule | Creates a new Aprimo automation rule. |
delete_rule | Destructive. Permanently deletes an Aprimo rule by id or by name. |
get_action_type | Gets one Aprimo action type's detail (id, name) by id. |
get_maintenance_job_target | Gets one target of an Aprimo maintenance job by maintenance job id and maintenance target id — the record/classification/rule/order it targets and its per-target status. |
get_rule | Gets one Aprimo rule's detail (target, trigger, enabled, custom tag, dates) by id or by name. |
get_rule_created_by | Gets the Aprimo user who created a rule, by id or by name. |
get_rule_modified_by | Gets the Aprimo user who last modified a rule, by id or by name. |
list_action_types | Lists the action types available in Aprimo for configuring checks (the kind of automated check a check performs against a file version, e.g. a virus scan or an image validation). |
list_maintenance_job_targets | Lists every target of an Aprimo maintenance job by maintenance job id — the records/classifications/rules/orders it targets and each one's per-target status. |
list_maintenance_jobs | Lists Aprimo maintenance jobs: id, job type, status, targets count, priority, and dates. |
list_rule_actions | Lists the actions of an Aprimo rule (what runs when the rule's conditions match), by id or by name. |
list_rule_conditions | Lists the conditions of an Aprimo rule (what must be true for the rule's actions to run), by id or by name. |
list_rules | Lists the automation rules configured in Aprimo — rules run a set of actions when their trigger fires and their conditions match (e.g. on record creation). |
update_rule | Edits an existing Aprimo rule by id or by name. |
check_maintenance_job
Checks the status of a maintenance job created by create_maintenance_job. Pending/Queued/Executing/Scheduled/AsyncPending/AsyncExecuting are normal in-progress states, not errors — tell the user it's still processing and offer to check again shortly. PartiallyFailed is a warning (not an error): some targets failed while others succeeded; failedTargetsCount shows how many failed. Failed is a tool error.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
maintenanceJobId | string | Yes | The maintenance job id returned by create_maintenance_job. |
Returns:
| Field | Type | Description |
|---|---|---|
maintenanceJobId | string | |
status | string | |
failedTargetsCount | integer | |
warning | string (optional) | |
message | string (optional) |
create_maintenance_job
Destructive
Creates an Aprimo maintenance job that bulk-applies one or more actions (e.g. append/replace/overwrite a field, change classification, change record/collection status, delete) across one or more record or collection targets. This modifies data; async — poll with check_maintenance_job; can be scheduled via earliestStartDate so not necessarily immediate. Always confirm the exact targets and action(s) with the user before calling this tool. Some actions (Delete, ClassificationMove, UnclassifyRecord, or a status change to Delete) are destructive and require an additional explicit confirmation beyond the routine write confirmation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Job type: "Record" (one target per id), "BulkRecord" (many record ids in one target), or "BulkCollection" (many collection ids in one target). |
targetIds | array of string | Yes | The record or collection ids (32-char hex) this job targets, matching the chosen type. |
actions | array of DamModels.MaintenanceActionRequest | Yes | The action(s) to apply, each as { action, parameters }. Allowed action values (record targets): AppendTextField, AppendToField, ClassificationCopy, ClassificationMove, ClassifyRecord, Delete, OverwriteField, RefreshFileRecord, RemoveFromField, ReplaceTextField, UnclassifyRecord, ChangeContentType, ChangeRecordStatus, RefreshUrlToPdf. Allowed action values (collection targets): ChangeCollectionOwner, ChangeCollectionStatus. Any other action value is rejected. |
priority | string | No | Optional job priority: "Medium" or "High". |
earliestStartDate | string | No | Optional ISO-8601 timestamp; the job will not start executing before this time. |
disableNotification | boolean | No | Optional; when true, suppresses the job-completion notification email. |
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 exact targets and action(s). |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) when the job includes a destructive action (Delete, ClassificationMove, UnclassifyRecord, or a status change to Delete). Set only after stating the destructive action and target count to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
maintenanceJobId | string |
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.
create_rule
Creates a new Aprimo automation rule. This modifies data. Always confirm the name, target, trigger, and any conditions/actions with the user before calling this tool. conditions/actions are JSON objects shaped like {"addOrUpdate": [ {"conditionType" or "actionType": ..., ...} ]} — use get_rule/list_rule_conditions/list_rule_actions on an existing similar rule as a shape reference, or the DAM rules documentation, if unsure of a variant's exact fields.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new rule, exactly as the user stated it. |
target | string | Yes | The entity type this rule applies to, e.g. "Record", "Collection", "Classification". One of: SettingDefinition, FieldDefinition, IndexerTask, Translation, SettingCategory, UserGroup, Watermark, FieldGroup, Collection, User, Classification, Record, Language, FileType, Organization, Site, Publication, Subscription, FileStore, SavedView. |
trigger | string | Yes | The event that triggers the rule. One of: WhenSavedOrDeleted, Daily. |
enabled | boolean | No | Whether the rule is enabled. Omit to use DAM's default. |
tag | string | No | Optional custom XML tag associated with the rule. |
includeDraftRecords | boolean | No | Whether this rule can execute on draft records. Only meaningful when target is "Record". Omit to use DAM's default. |
isInternal | boolean | No | Internal rules can only be edited by operators. Omit to use DAM's default. |
conditions | JsonElement | No | Required (not actually optional — DAM has no concept of a rule with zero conditions, for any target/trigger): at least one condition, JSON object {"addOrUpdate": [ {"conditionType": ..., ...}, ... ]} with a non-empty addOrUpdate array. DAM rejects creating a rule with zero conditions with HTTP 400 "An invalid value was specified for Conditions." Use get_rule/list_rule_conditions on an existing similar rule, or the DAM rules documentation, for a conditionType's exact fields. |
actions | JsonElement | No | Required (not actually optional — DAM has no concept of a rule with zero actions, for any target/trigger): at least one action, JSON object {"addOrUpdate": [ {"actionType": ..., ...}, ... ]} with a non-empty addOrUpdate array. DAM rejects creating a rule with zero actions with HTTP 400 "An invalid value was specified for Actions." Use get_rule/list_rule_actions on an existing similar rule, or the DAM rules documentation, for an actionType's exact fields. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_rule
Destructive
Permanently deletes an Aprimo rule by id or by name. This cannot be undone — the rule will no longer run its actions when its trigger fires. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact rule with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID) to delete. Provide this or name, not both. |
name | string | No | The rule's name (case-insensitive, exact match). Provide this or ruleId, not both. |
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 rule. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a rule is permanent and cannot be undone. Set only after stating the exact rule to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
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.
get_action_type
Gets one Aprimo action type's detail (id, name) by id. Use after list_action_types.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
actionTypeId | string | Yes | The action type id (GUID), from list_action_types. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
get_maintenance_job_target
Gets one target of an Aprimo maintenance job by maintenance job id and maintenance target id — the record/classification/rule/order it targets and its per-target status. Use after list_maintenance_job_targets, or when you already have both ids.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
maintenanceJobId | string | Yes | The maintenance job id (GUID). |
maintenanceTargetId | string | Yes | The maintenance target id (GUID), from list_maintenance_job_targets. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
recordId | string (optional) | |
classificationId | string (optional) | |
objectId | string (optional) | |
ruleTarget | string (optional) | |
status | string (optional) | |
message | string (optional) | |
errorDetails | string (optional) | |
attempt | integer (optional) |
get_rule
Gets one Aprimo rule's detail (target, trigger, enabled, custom tag, dates) by id or by name. Use after list_rules, or pass name directly when the user names the rule. Use list_rule_conditions/list_rule_actions to see the rule's conditions/actions. Not its creator (get_rule_created_by) or last modifier (get_rule_modified_by).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID), from list_rules. Provide this or name, not both. |
name | string | No | The rule's name (case-insensitive, exact match). Provide this or ruleId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
enabled | boolean (optional) | |
target | string (optional) | |
trigger | string (optional) | |
tag | string (optional) | |
version | integer (optional) | |
includeDraftRecords | boolean (optional) | |
expression | string (optional) | |
isInternal | boolean (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_rule_created_by
Gets the Aprimo user who created a rule, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID). Provide this or name, not both. |
name | string | No | The rule's name (case-insensitive, exact match). Provide this or ruleId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
firstName | string (optional) | |
lastName | string (optional) | |
email | string (optional) | |
isActive | boolean (optional) |
get_rule_modified_by
Gets the Aprimo user who last modified a rule, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID). Provide this or name, not both. |
name | string | No | The rule's name (case-insensitive, exact match). Provide this or ruleId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
firstName | string (optional) | |
lastName | string (optional) | |
email | string (optional) | |
isActive | boolean (optional) |
list_action_types
Lists the action types available in Aprimo for configuring checks (the kind of automated check a check performs against a file version, e.g. a virus scan or an image validation). Use when the user asks what action types exist, or to look up an action type's id before calling get_action_type.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every action 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 ActionTypePayload | |
items[].id | string | |
items[].name | string |
list_maintenance_job_targets
Lists every target of an Aprimo maintenance job by maintenance job id — the records/classifications/rules/orders it targets and each one's per-target status. Use to look up a maintenance target's id before calling get_maintenance_job_target.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
maintenanceJobId | string | Yes | The maintenance job id (GUID) whose targets to list. |
Returns:
| Field | Type | Description |
|---|---|---|
maintenanceJobId | string | |
count | integer | |
items | array of MaintenanceJobTargetPayload | |
items[].id | string | |
items[].recordId | string (optional) | |
items[].classificationId | string (optional) | |
items[].objectId | string (optional) | |
items[].ruleTarget | string (optional) | |
items[].status | string (optional) | |
items[].message | string (optional) | |
items[].errorDetails | string (optional) | |
items[].attempt | integer (optional) |
list_maintenance_jobs
Lists Aprimo maintenance jobs: id, job type, status, targets count, priority, and dates. Use when the user asks what maintenance jobs exist or their status, or to look up a maintenance job id before calling check_maintenance_job, get_maintenance_job_target, or list_maintenance_job_targets.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every maintenance job. |
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 MaintenanceJobSummaryPayload | |
items[].maintenanceJobId | string | |
items[].type | string (optional) | |
items[].status | string | |
items[].targetsCount | integer (optional) | |
items[].failedTargetsCount | integer | |
items[].priority | integer (optional) | /// DAM's MaintenancePriority enum value (0 = High, 1 = Medium, 2 = AuditArchiving, 3 = BuildSearchIndex) — see 's remarks for why this is a number, not the string other DAM status-style fields use. |
items[].createdOn | string (optional) | |
items[].startedOn | string (optional) | |
items[].creatorEmail | string (optional) | |
items[].message | string (optional) |
list_rule_actions
Lists the actions of an Aprimo rule (what runs when the rule's conditions match), by id or by name. Each item's index is what update_rule's actions.remove array expects to delete it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID). Provide this or name, not both. |
name | string | No | The rule's name (case-insensitive, exact match). Provide this or ruleId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
ruleId | string | |
count | integer | |
items | array of RuleActionPayload | |
items[].index | integer (optional) | |
items[].actionType | string (optional) | |
items[].executionTime | string (optional) | |
items[].details | object (optional) |
list_rule_conditions
Lists the conditions of an Aprimo rule (what must be true for the rule's actions to run), by id or by name. Each item's index is what update_rule's conditions.remove array expects to delete it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID). Provide this or name, not both. |
name | string | No | The rule's name (case-insensitive, exact match). Provide this or ruleId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
ruleId | string | |
count | integer | |
items | array of RuleConditionPayload | |
items[].index | integer (optional) | |
items[].conditionType | string (optional) | |
items[].details | object (optional) |
list_rules
Lists the automation rules configured in Aprimo — rules run a set of actions when their trigger fires and their conditions match (e.g. on record creation). Use when the user asks what rules exist, or to look up a rule's id/exact name before calling get_rule, update_rule, or delete_rule 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 rule. |
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 RulePayload | |
items[].id | string | |
items[].name | string | |
items[].enabled | boolean (optional) | |
items[].target | string (optional) | |
items[].trigger | string (optional) | |
items[].tag | string (optional) | |
items[].version | integer (optional) | |
items[].includeDraftRecords | boolean (optional) | |
items[].expression | string (optional) | |
items[].isInternal | boolean (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
update_rule
Edits an existing Aprimo rule by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact rule and the new values with the user before calling this tool. conditions/actions, if provided, replace entries by index and/or add new ones per DAM's {"addOrUpdate": [...], "remove": [index, ...]} shape — use list_rule_conditions/list_rule_actions first to find existing indexes.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ruleId | string | No | The rule id (GUID) to edit. Provide this or name, not both. |
name | string | No | The rule's current name (case-insensitive, exact match), used to look it up. Provide this or ruleId, not both. |
newName | string | No | New name for the rule. Omit to leave the name unchanged. |
target | string | No | New target entity type. One of: SettingDefinition, FieldDefinition, IndexerTask, Translation, SettingCategory, UserGroup, Watermark, FieldGroup, Collection, User, Classification, Record, Language, FileType, Organization, Site, Publication, Subscription, FileStore, SavedView. Omit to leave it unchanged. |
trigger | string | No | New trigger. One of: WhenSavedOrDeleted, Daily. Omit to leave it unchanged. |
enabled | boolean | No | New enabled flag. Omit to leave it unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
includeDraftRecords | boolean | No | New include-draft-records flag. Omit to leave it unchanged. |
isInternal | boolean | No | New is-internal flag. Omit to leave it unchanged. |
conditions | JsonElement | No | Conditions to add/update/remove: JSON object {"addOrUpdate": [...], "remove": [index, ...]}. Omit to leave conditions unchanged. |
actions | JsonElement | No | Actions to add/update/remove: JSON object {"addOrUpdate": [...], "remove": [index, ...]}. Omit to leave actions unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Configure Automated Checks
Can change data · 7 tools · Group ID configure-automated-checks
Needs: Read the Content Model
| Tool | What it does |
|---|---|
create_check | Creates a new Aprimo check. |
delete_check | Destructive. Permanently deletes an Aprimo check by id or by name. |
get_check | Gets one Aprimo check's detail (action type, check category, labels, creation date) by id or by name. |
get_check_category | Gets one Aprimo check category's detail (id, name) by id or by name. |
list_check_categories | Lists the check categories configured in Aprimo — named groupings used to organize check definitions for display/filtering (e.g. "Security", "Image Quality"). |
list_checks | Lists the automated checks configured in Aprimo — a check (of a given action type, e.g. a virus scan or an image validation, organized under a check category) that can run against file versions and record a pass/fail result. |
update_check | Edits an existing Aprimo check by id or by name. |
create_check
Creates a new Aprimo check. This modifies data. Always confirm the name, action type, and check category with the user before calling this tool. Use list_action_types/get_action_type and list_check_categories/get_check_category to find valid actionTypeId/checkCategoryId values.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new check, exactly as the user stated it. |
actionTypeId | string | Yes | The action type id (GUID) this check performs, from list_action_types/get_action_type. |
checkCategoryId | string | Yes | The check category id (GUID) this check belongs to, from list_check_categories/get_check_category. |
isActive | boolean | No | Whether the check is active. Omit to use DAM's default (true). |
isDeletable | boolean | No | Whether the check can be deleted later. Omit to use DAM's default (true). |
labels | object (map of string) | No | Multi-language labels for this check: a map of languageId (GUID) to label value. Omit for no labels. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_check
Destructive
Permanently deletes an Aprimo check by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact check with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkId | string | No | The check id (GUID) to delete. Provide this or name, not both. |
name | string | No | The check's name (case-insensitive, exact match). Provide this or checkId, not both. |
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 check. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a check is permanent and cannot be undone. Set only after stating the exact check to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
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.
get_check
Gets one Aprimo check's detail (action type, check category, labels, creation date) by id or by name. Use after list_checks, or pass name directly when the user names the check. Not its category (use get_check_category for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkId | string | No | The check id (GUID), from list_checks. Provide this or name, not both. |
name | string | No | The check's name (case-insensitive, exact match). Provide this or checkId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
actionTypeId | string (optional) | |
checkCategoryId | string (optional) | |
checkCategoryName | string (optional) | |
labels | array of CheckLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
createdOn | string (optional) |
get_check_category
Gets one Aprimo check category's detail (id, name) by id or by name. Use after list_check_categories.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkCategoryId | string | No | The check category id (GUID), from list_check_categories. Provide this or name, not both. |
name | string | No | The check category's name (case-insensitive, exact match), e.g. "Security". Provide this or checkCategoryId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
list_check_categories
Lists the check categories configured in Aprimo — named groupings used to organize check definitions for display/filtering (e.g. "Security", "Image Quality"). Use when the user asks what check categories exist, or to look up a check category's id/exact name before calling get_check_category by name, or before calling create_check/update_check with a checkCategoryId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "Name=Security". Omit to list every check category. |
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 CheckCategoryPayload | |
items[].id | string | |
items[].name | string |
list_checks
Lists the automated checks configured in Aprimo — a check (of a given action type, e.g. a virus scan or an image validation, organized under a check category) that can run against file versions and record a pass/fail result. Use when the user asks what checks exist, or to look up a check's id/exact name before calling get_check, update_check, or delete_check 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 check. |
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 CheckPayload | |
items[].id | string | |
items[].name | string | |
items[].actionTypeId | string (optional) | |
items[].checkCategoryId | string (optional) | |
items[].checkCategoryName | string (optional) | |
items[].labels | array of CheckLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].createdOn | string (optional) |
update_check
Edits an existing Aprimo check by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact check and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkId | string | No | The check id (GUID) to edit. Provide this or name, not both. |
name | string | No | The check's current name (case-insensitive, exact match), used to look it up. Provide this or checkId, not both. |
newName | string | No | New name for the check. Omit to leave the name unchanged. |
actionTypeId | string | No | New action type id (GUID). Omit to leave it unchanged. |
checkCategoryId | string | No | New check category id (GUID). Omit to leave it unchanged. |
isActive | boolean | No | New active flag. Omit to leave it unchanged. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Omit to leave labels unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Configure Watermarks & Image Overlays
Can change data · 10 tools (9 currently available) · Group ID configure-watermarks-image-overlays
Needs: Find & Discover Content, Look Up DAM Users & Groups
| Tool | What it does |
|---|---|
create_image_overlay | Creates a new Aprimo image overlay. |
create_watermark | Creates a new Aprimo watermark. |
delete_watermark | Destructive. Permanently deletes an Aprimo watermark by id or by name. |
get_image_overlay | Gets one Aprimo image overlay's detail (name, enabled, dates) by id or by name. |
get_watermark | Gets one Aprimo watermark's detail (position, custom tag, dates) by id or by name. |
list_image_overlay_classifications | Lists the classification ids an Aprimo image overlay applies to, by id or by name. |
list_image_overlay_user_groups | Lists the user group ids an Aprimo image overlay is scoped to (who can see it), by id or by name. |
list_image_overlays | Lists the image overlays configured in Aprimo — a configurable graphic a rule action can apply on top of an image rendition (e.g. to visually flag its status), shown only to the user groups it's scoped to. |
list_watermarks | Lists the watermarks configured in Aprimo: name, position, id, and dates. |
update_watermark | Not currently available. Edits an existing Aprimo watermark by id or by name. |
create_image_overlay
Creates a new Aprimo image overlay. This modifies data. Always confirm the name and which user groups/classifications it should apply to with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new image overlay, exactly as the user stated it. |
enabled | boolean | No | Whether the image overlay is enabled. Omit to use DAM's default. |
userGroupIds | array of string | No | Required (not actually optional — DAM rejects an image overlay with no user groups: "UserGroups: This collection can not be empty."). User group ids (GUIDs) this overlay is scoped to (only these groups will see it). |
classificationIds | array of string | No | Required (not actually optional — DAM rejects an image overlay with no classifications: "Classifications: This collection can not be empty."). Classification ids (GUIDs) this overlay applies to. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string |
create_watermark
Creates a new Aprimo watermark. This modifies data. Always confirm the name, position, and image with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new watermark, exactly as the user stated it. |
position | string | Yes | Where the watermark is placed on the asset. One of: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. |
imageBase64 | string | Yes | Base64-encoded watermark image (e.g. a transparent-background png/logo). |
tag | string | No | Optional custom XML tag associated with the watermark. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_watermark
Destructive
Permanently deletes an Aprimo watermark by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact watermark with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID) to delete. Provide this or name, not both. |
name | string | No | The watermark's name (case-insensitive, exact match). Provide this or watermarkId, not both. |
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 watermark. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a watermark is permanent and cannot be undone. Set only after stating the exact watermark to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
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.
get_image_overlay
Gets one Aprimo image overlay's detail (name, enabled, dates) by id or by name. Use after list_image_overlays, or pass name directly when the user names the overlay. Use list_image_overlay_classifications/list_image_overlay_user_groups to see what it applies to.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
imageOverlayId | integer | No | The image overlay id (integer), from list_image_overlays. Provide this or name, not both. |
name | string | No | The image overlay's name (case-insensitive, exact match). Provide this or imageOverlayId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
enabled | boolean (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_watermark
Gets one Aprimo watermark's detail (position, custom tag, dates) by id or by name. Use after list_watermarks, or pass name directly when the user names the watermark. Not its image (use get_watermark_image for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID), from list_watermarks. Provide this or name, not both. |
name | string | No | The watermark's name (case-insensitive, exact match), e.g. "Confidential". Provide this or watermarkId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
position | string | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
list_image_overlay_classifications
Lists the classification ids an Aprimo image overlay applies to, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
imageOverlayId | integer | No | The image overlay id (integer). Provide this or name, not both. |
name | string | No | The image overlay's name (case-insensitive, exact match). Provide this or imageOverlayId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
imageOverlayId | integer | |
count | integer | |
items | array of ImageOverlayClassificationPayload | |
items[].classificationId | string |
list_image_overlay_user_groups
Lists the user group ids an Aprimo image overlay is scoped to (who can see it), by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
imageOverlayId | integer | No | The image overlay id (integer). Provide this or name, not both. |
name | string | No | The image overlay's name (case-insensitive, exact match). Provide this or imageOverlayId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
imageOverlayId | integer | |
count | integer | |
items | array of ImageOverlayUserGroupPayload | |
items[].userGroupId | string |
list_image_overlays
Lists the image overlays configured in Aprimo — a configurable graphic a rule action can apply on top of an image rendition (e.g. to visually flag its status), shown only to the user groups it's scoped to. Use when the user asks what image overlays exist, or to look up an image overlay's id/exact name before calling get_image_overlay 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 image overlay. |
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 ImageOverlayPayload | |
items[].id | integer | |
items[].name | string | |
items[].enabled | boolean (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_watermarks
Lists the watermarks configured in Aprimo: name, position, id, and dates. Use when the user asks what watermarks exist, or to look up a watermark's id/exact name before calling get_watermark, update_watermark, or delete_watermark by name.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of WatermarkPayload | |
items[].id | string | |
items[].name | string | |
items[].position | string | |
items[].tag | string (optional) | |
items[].createdOn | string | |
items[].modifiedOn | string |
update_watermark
Not currently available
Edits an existing Aprimo watermark by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact watermark and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID) to edit. Provide this or name, not both. |
name | string | No | The watermark's current name (case-insensitive, exact match), used to look it up. Provide this or watermarkId, not both. |
newName | string | No | New name for the watermark. Omit to leave the name unchanged. |
position | string | No | New position. One of: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. Omit to leave the position unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
imageBase64 | string | No | New base64-encoded watermark image. Omit to leave the image unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |