Skip to main content

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.

How to read this page
  • 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 confirmed and confirmedDestructive to true.
  • 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​

GroupAccessNeedsTools
Automate Rules & Maintenance JobsCan change dataRead the Content Model, Find & Discover Content, Look Up DAM Users & Groups16
Configure Automated ChecksCan change dataRead the Content Model7
Configure Watermarks & Image OverlaysCan change dataFind & Discover Content, Look Up DAM Users & Groups10

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

ToolWhat it does
check_maintenance_jobChecks the status of a maintenance job created by create_maintenance_job.
create_maintenance_jobDestructive. 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_ruleCreates a new Aprimo automation rule.
delete_ruleDestructive. Permanently deletes an Aprimo rule by id or by name.
get_action_typeGets one Aprimo action type's detail (id, name) by id.
get_maintenance_job_targetGets 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_ruleGets one Aprimo rule's detail (target, trigger, enabled, custom tag, dates) by id or by name.
get_rule_created_byGets the Aprimo user who created a rule, by id or by name.
get_rule_modified_byGets the Aprimo user who last modified a rule, by id or by name.
list_action_typesLists 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_targetsLists 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_jobsLists Aprimo maintenance jobs: id, job type, status, targets count, priority, and dates.
list_rule_actionsLists the actions of an Aprimo rule (what runs when the rule's conditions match), by id or by name.
list_rule_conditionsLists the conditions of an Aprimo rule (what must be true for the rule's actions to run), by id or by name.
list_rulesLists 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_ruleEdits 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:

ParameterTypeRequiredDescription
maintenanceJobIdstringYesThe maintenance job id returned by create_maintenance_job.

Returns:

FieldTypeDescription
maintenanceJobIdstring
statusstring
failedTargetsCountinteger
warningstring (optional)
messagestring (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:

ParameterTypeRequiredDescription
typestringYesJob type: "Record" (one target per id), "BulkRecord" (many record ids in one target), or "BulkCollection" (many collection ids in one target).
targetIdsarray of stringYesThe record or collection ids (32-char hex) this job targets, matching the chosen type.
actionsarray of DamModels.MaintenanceActionRequestYesThe 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.
prioritystringNoOptional job priority: "Medium" or "High".
earliestStartDatestringNoOptional ISO-8601 timestamp; the job will not start executing before this time.
disableNotificationbooleanNoOptional; when true, suppresses the job-completion notification email.
confirmedbooleanNoMust 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).
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
maintenanceJobIdstring
Destructive operation

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:

ParameterTypeRequiredDescription
namestringYesThe name for the new rule, exactly as the user stated it.
targetstringYesThe 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.
triggerstringYesThe event that triggers the rule. One of: WhenSavedOrDeleted, Daily.
enabledbooleanNoWhether the rule is enabled. Omit to use DAM's default.
tagstringNoOptional custom XML tag associated with the rule.
includeDraftRecordsbooleanNoWhether this rule can execute on draft records. Only meaningful when target is "Record". Omit to use DAM's default.
isInternalbooleanNoInternal rules can only be edited by operators. Omit to use DAM's default.
conditionsJsonElementNoRequired (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.
actionsJsonElementNoRequired (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:

FieldTypeDescription
idstring
namestring

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:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID) to delete. Provide this or name, not both.
namestringNoThe rule's name (case-insensitive, exact match). Provide this or ruleId, not both.
confirmedbooleanNoMust 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.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idstring
namestring (optional)
deletedboolean
Destructive operation

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:

ParameterTypeRequiredDescription
actionTypeIdstringYesThe action type id (GUID), from list_action_types.

Returns:

FieldTypeDescription
idstring
namestring

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:

ParameterTypeRequiredDescription
maintenanceJobIdstringYesThe maintenance job id (GUID).
maintenanceTargetIdstringYesThe maintenance target id (GUID), from list_maintenance_job_targets.

Returns:

FieldTypeDescription
idstring
recordIdstring (optional)
classificationIdstring (optional)
objectIdstring (optional)
ruleTargetstring (optional)
statusstring (optional)
messagestring (optional)
errorDetailsstring (optional)
attemptinteger (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:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID), from list_rules. Provide this or name, not both.
namestringNoThe rule's name (case-insensitive, exact match). Provide this or ruleId, not both.

Returns:

FieldTypeDescription
idstring
namestring
enabledboolean (optional)
targetstring (optional)
triggerstring (optional)
tagstring (optional)
versioninteger (optional)
includeDraftRecordsboolean (optional)
expressionstring (optional)
isInternalboolean (optional)
createdOnstring (optional)
modifiedOnstring (optional)

get_rule_created_by​

Gets the Aprimo user who created a rule, by id or by name.

Parameters:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID). Provide this or name, not both.
namestringNoThe rule's name (case-insensitive, exact match). Provide this or ruleId, not both.

Returns:

FieldTypeDescription
idstring
namestring (optional)
firstNamestring (optional)
lastNamestring (optional)
emailstring (optional)
isActiveboolean (optional)

get_rule_modified_by​

Gets the Aprimo user who last modified a rule, by id or by name.

Parameters:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID). Provide this or name, not both.
namestringNoThe rule's name (case-insensitive, exact match). Provide this or ruleId, not both.

Returns:

FieldTypeDescription
idstring
namestring (optional)
firstNamestring (optional)
lastNamestring (optional)
emailstring (optional)
isActiveboolean (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:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every action type.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of ActionTypePayload
items[].idstring
items[].namestring

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:

ParameterTypeRequiredDescription
maintenanceJobIdstringYesThe maintenance job id (GUID) whose targets to list.

Returns:

FieldTypeDescription
maintenanceJobIdstring
countinteger
itemsarray of MaintenanceJobTargetPayload
items[].idstring
items[].recordIdstring (optional)
items[].classificationIdstring (optional)
items[].objectIdstring (optional)
items[].ruleTargetstring (optional)
items[].statusstring (optional)
items[].messagestring (optional)
items[].errorDetailsstring (optional)
items[].attemptinteger (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:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every maintenance job.
sortstringNoOptional sort expression, e.g. "createdon desc". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of MaintenanceJobSummaryPayload
items[].maintenanceJobIdstring
items[].typestring (optional)
items[].statusstring
items[].targetsCountinteger (optional)
items[].failedTargetsCountinteger
items[].priorityinteger (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[].createdOnstring (optional)
items[].startedOnstring (optional)
items[].creatorEmailstring (optional)
items[].messagestring (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:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID). Provide this or name, not both.
namestringNoThe rule's name (case-insensitive, exact match). Provide this or ruleId, not both.

Returns:

FieldTypeDescription
ruleIdstring
countinteger
itemsarray of RuleActionPayload
items[].indexinteger (optional)
items[].actionTypestring (optional)
items[].executionTimestring (optional)
items[].detailsobject (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:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID). Provide this or name, not both.
namestringNoThe rule's name (case-insensitive, exact match). Provide this or ruleId, not both.

Returns:

FieldTypeDescription
ruleIdstring
countinteger
itemsarray of RuleConditionPayload
items[].indexinteger (optional)
items[].conditionTypestring (optional)
items[].detailsobject (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:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every rule.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of RulePayload
items[].idstring
items[].namestring
items[].enabledboolean (optional)
items[].targetstring (optional)
items[].triggerstring (optional)
items[].tagstring (optional)
items[].versioninteger (optional)
items[].includeDraftRecordsboolean (optional)
items[].expressionstring (optional)
items[].isInternalboolean (optional)
items[].createdOnstring (optional)
items[].modifiedOnstring (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:

ParameterTypeRequiredDescription
ruleIdstringNoThe rule id (GUID) to edit. Provide this or name, not both.
namestringNoThe rule's current name (case-insensitive, exact match), used to look it up. Provide this or ruleId, not both.
newNamestringNoNew name for the rule. Omit to leave the name unchanged.
targetstringNoNew 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.
triggerstringNoNew trigger. One of: WhenSavedOrDeleted, Daily. Omit to leave it unchanged.
enabledbooleanNoNew enabled flag. Omit to leave it unchanged.
tagstringNoNew custom XML tag. Omit to leave the tag unchanged.
includeDraftRecordsbooleanNoNew include-draft-records flag. Omit to leave it unchanged.
isInternalbooleanNoNew is-internal flag. Omit to leave it unchanged.
conditionsJsonElementNoConditions to add/update/remove: JSON object {"addOrUpdate": [...], "remove": [index, ...]}. Omit to leave conditions unchanged.
actionsJsonElementNoActions to add/update/remove: JSON object {"addOrUpdate": [...], "remove": [index, ...]}. Omit to leave actions unchanged.

Returns:

FieldTypeDescription
idstring
namestring (optional)

Configure Automated Checks​

Can change data · 7 tools · Group ID configure-automated-checks

Needs: Read the Content Model

ToolWhat it does
create_checkCreates a new Aprimo check.
delete_checkDestructive. Permanently deletes an Aprimo check by id or by name.
get_checkGets one Aprimo check's detail (action type, check category, labels, creation date) by id or by name.
get_check_categoryGets one Aprimo check category's detail (id, name) by id or by name.
list_check_categoriesLists the check categories configured in Aprimo — named groupings used to organize check definitions for display/filtering (e.g. "Security", "Image Quality").
list_checksLists 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_checkEdits 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:

ParameterTypeRequiredDescription
namestringYesThe name for the new check, exactly as the user stated it.
actionTypeIdstringYesThe action type id (GUID) this check performs, from list_action_types/get_action_type.
checkCategoryIdstringYesThe check category id (GUID) this check belongs to, from list_check_categories/get_check_category.
isActivebooleanNoWhether the check is active. Omit to use DAM's default (true).
isDeletablebooleanNoWhether the check can be deleted later. Omit to use DAM's default (true).
labelsobject (map of string)NoMulti-language labels for this check: a map of languageId (GUID) to label value. Omit for no labels.

Returns:

FieldTypeDescription
idstring
namestring

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:

ParameterTypeRequiredDescription
checkIdstringNoThe check id (GUID) to delete. Provide this or name, not both.
namestringNoThe check's name (case-insensitive, exact match). Provide this or checkId, not both.
confirmedbooleanNoMust 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.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idstring
namestring (optional)
deletedboolean
Destructive operation

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:

ParameterTypeRequiredDescription
checkIdstringNoThe check id (GUID), from list_checks. Provide this or name, not both.
namestringNoThe check's name (case-insensitive, exact match). Provide this or checkId, not both.

Returns:

FieldTypeDescription
idstring
namestring
actionTypeIdstring (optional)
checkCategoryIdstring (optional)
checkCategoryNamestring (optional)
labelsarray of CheckLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
createdOnstring (optional)

get_check_category​

Gets one Aprimo check category's detail (id, name) by id or by name. Use after list_check_categories.

Parameters:

ParameterTypeRequiredDescription
checkCategoryIdstringNoThe check category id (GUID), from list_check_categories. Provide this or name, not both.
namestringNoThe check category's name (case-insensitive, exact match), e.g. "Security". Provide this or checkCategoryId, not both.

Returns:

FieldTypeDescription
idstring
namestring

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:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "Name=Security". Omit to list every check category.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of CheckCategoryPayload
items[].idstring
items[].namestring

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:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every check.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of CheckPayload
items[].idstring
items[].namestring
items[].actionTypeIdstring (optional)
items[].checkCategoryIdstring (optional)
items[].checkCategoryNamestring (optional)
items[].labelsarray of CheckLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].createdOnstring (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:

ParameterTypeRequiredDescription
checkIdstringNoThe check id (GUID) to edit. Provide this or name, not both.
namestringNoThe check's current name (case-insensitive, exact match), used to look it up. Provide this or checkId, not both.
newNamestringNoNew name for the check. Omit to leave the name unchanged.
actionTypeIdstringNoNew action type id (GUID). Omit to leave it unchanged.
checkCategoryIdstringNoNew check category id (GUID). Omit to leave it unchanged.
isActivebooleanNoNew active flag. Omit to leave it unchanged.
labelsobject (map of string)NoLabel values to set: a map of languageId (GUID) to label value. Omit to leave labels unchanged.

Returns:

FieldTypeDescription
idstring
namestring (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

ToolWhat it does
create_image_overlayCreates a new Aprimo image overlay.
create_watermarkCreates a new Aprimo watermark.
delete_watermarkDestructive. Permanently deletes an Aprimo watermark by id or by name.
get_image_overlayGets one Aprimo image overlay's detail (name, enabled, dates) by id or by name.
get_watermarkGets one Aprimo watermark's detail (position, custom tag, dates) by id or by name.
list_image_overlay_classificationsLists the classification ids an Aprimo image overlay applies to, by id or by name.
list_image_overlay_user_groupsLists the user group ids an Aprimo image overlay is scoped to (who can see it), by id or by name.
list_image_overlaysLists 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_watermarksLists the watermarks configured in Aprimo: name, position, id, and dates.
update_watermarkNot 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:

ParameterTypeRequiredDescription
namestringYesThe name for the new image overlay, exactly as the user stated it.
enabledbooleanNoWhether the image overlay is enabled. Omit to use DAM's default.
userGroupIdsarray of stringNoRequired (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).
classificationIdsarray of stringNoRequired (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:

FieldTypeDescription
idinteger
namestring

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:

ParameterTypeRequiredDescription
namestringYesThe name for the new watermark, exactly as the user stated it.
positionstringYesWhere the watermark is placed on the asset. One of: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight.
imageBase64stringYesBase64-encoded watermark image (e.g. a transparent-background png/logo).
tagstringNoOptional custom XML tag associated with the watermark.

Returns:

FieldTypeDescription
idstring
namestring

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:

ParameterTypeRequiredDescription
watermarkIdstringNoThe watermark id (GUID) to delete. Provide this or name, not both.
namestringNoThe watermark's name (case-insensitive, exact match). Provide this or watermarkId, not both.
confirmedbooleanNoMust 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.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idstring
namestring (optional)
deletedboolean
Destructive operation

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:

ParameterTypeRequiredDescription
imageOverlayIdintegerNoThe image overlay id (integer), from list_image_overlays. Provide this or name, not both.
namestringNoThe image overlay's name (case-insensitive, exact match). Provide this or imageOverlayId, not both.

Returns:

FieldTypeDescription
idinteger
namestring
enabledboolean (optional)
createdOnstring (optional)
modifiedOnstring (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:

ParameterTypeRequiredDescription
watermarkIdstringNoThe watermark id (GUID), from list_watermarks. Provide this or name, not both.
namestringNoThe watermark's name (case-insensitive, exact match), e.g. "Confidential". Provide this or watermarkId, not both.

Returns:

FieldTypeDescription
idstring
namestring
positionstring
tagstring (optional)
createdOnstring
modifiedOnstring

list_image_overlay_classifications​

Lists the classification ids an Aprimo image overlay applies to, by id or by name.

Parameters:

ParameterTypeRequiredDescription
imageOverlayIdintegerNoThe image overlay id (integer). Provide this or name, not both.
namestringNoThe image overlay's name (case-insensitive, exact match). Provide this or imageOverlayId, not both.

Returns:

FieldTypeDescription
imageOverlayIdinteger
countinteger
itemsarray of ImageOverlayClassificationPayload
items[].classificationIdstring

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:

ParameterTypeRequiredDescription
imageOverlayIdintegerNoThe image overlay id (integer). Provide this or name, not both.
namestringNoThe image overlay's name (case-insensitive, exact match). Provide this or imageOverlayId, not both.

Returns:

FieldTypeDescription
imageOverlayIdinteger
countinteger
itemsarray of ImageOverlayUserGroupPayload
items[].userGroupIdstring

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:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every image overlay.
sortstringNoOptional sort expression, e.g. "createdOn". Omit for the endpoint's default order.
skipintegerNoNumber of items to skip, for paging. Defaults to 0.
takeintegerNoMaximum number of items to return. Omit for the endpoint's default page size.

Returns:

FieldTypeDescription
countinteger
itemsarray of ImageOverlayPayload
items[].idinteger
items[].namestring
items[].enabledboolean (optional)
items[].createdOnstring (optional)
items[].modifiedOnstring (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:

FieldTypeDescription
countinteger
itemsarray of WatermarkPayload
items[].idstring
items[].namestring
items[].positionstring
items[].tagstring (optional)
items[].createdOnstring
items[].modifiedOnstring

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:

ParameterTypeRequiredDescription
watermarkIdstringNoThe watermark id (GUID) to edit. Provide this or name, not both.
namestringNoThe watermark's current name (case-insensitive, exact match), used to look it up. Provide this or watermarkId, not both.
newNamestringNoNew name for the watermark. Omit to leave the name unchanged.
positionstringNoNew position. One of: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. Omit to leave the position unchanged.
tagstringNoNew custom XML tag. Omit to leave the tag unchanged.
imageBase64stringNoNew base64-encoded watermark image. Omit to leave the image unchanged.

Returns:

FieldTypeDescription
idstring
namestring (optional)