Skip to main content

Classifications

Tools for the classification tree — browsing and resolving nodes by id or name path, reading and editing classifications, and inspecting the permissions attached to them.

This page covers 18 tools, 17 of them in the default tool list, and 1 destructive.

How to read this page
  • 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 confirmed and confirmedDestructive to true.
  • Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Why isn't every tool in the default list?

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

ToolStatusWhat it does
browse_classificationsDefaultBrowses the Aprimo classification tree (category folders that organize assets).
create_classificationDefaultCreates a new Aprimo classification (taxonomy node).
delete_classificationDefaultDestructive. Permanently deletes an Aprimo classification by id, leaf name, or name path.
get_classificationDefaultGets 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_pathDefaultGets 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_fieldDefaultGets one custom field's value on an Aprimo classification, by classification id/name/namePath plus the field id.
get_classification_image_urlOn requestReturns the image URL (plus width/height/size/extension) for an Aprimo classification, by id, name, or name path.
get_classification_parentDefaultGets the direct parent of one Aprimo classification, by id, name, or name path.
get_classification_tree_permissionDefaultGets the calling user's own classification-tree rights (read/classify/modify/delete) on one Aprimo classification, by id, name, or name path.
list_classification_ancestorsDefaultLists 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_childrenDefaultLists the direct children of one Aprimo classification, by id, name, or name path — full detail per child.
list_classification_download_permissionsDefaultLists the download permissions (per-user-group download rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path.
list_classification_fieldsDefaultLists every custom field value set on one Aprimo classification, by id, name, or name path.
list_classification_follower_classificationsDefaultLists the follower classifications of one Aprimo classification (other classifications linked to receive updates/notifications from this one), by id, name, or name path.
list_classification_record_permissionsDefaultLists the record permissions (per-user-group record access rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path.
list_classification_tree_permissionsDefaultLists the classification-tree permissions (per-user-group access rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path.
search_classificationsDefaultSearches 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.
update_classificationDefaultEdits an existing Aprimo classification by id, leaf name, or name path.

browse_classifications

In the default tool list

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:

ParameterTypeRequiredDescription
parentIdstringNoOptional parent classification id (32-char hex / GUID) to list children of. Omit for top-level (root) classifications.

Returns:

FieldTypeDescription
parentIdstring (optional)
countinteger
itemsarray of ClassificationPayload
items[].idstring
items[].namestring
items[].namePathstring (optional)
items[].parentIdstring (optional)

create_classification

In the default tool list

Creates a new Aprimo classification (taxonomy node). Exactly one of parentId/parentNamePath/isRoot=true must be given, to say where the new node attaches. This modifies data. Always confirm the name and placement with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
namestringYesThe name for the new classification, exactly as the user stated it.
parentIdstringNoId (GUID) of the parent classification to create this node under. Provide exactly one of parentId, parentNamePath, or isRoot=true.
parentNamePathstringNoFull name path of the parent classification to create this node under, e.g. "/Brands/Europe". Provide exactly one of parentId, parentNamePath, or isRoot=true.
isRootbooleanNoSet true to create this as a top-level (root) classification. Provide exactly one of parentId, parentNamePath, or isRoot=true.
identifierstringNoOptional unique identifier string for the new classification.
sortIndexintegerNoOptional sort index among sibling classifications.
sortOrderstringNoOptional sort order for this classification's children.
disabledInDamUibooleanNoWhether the classification is disabled in the DAM UI. Omit to use DAM's default.
tagstringNoOptional custom XML tag for the new classification.
labelsobject (map of string)NoMulti-language labels for the name of this classification: a map of languageId (GUID) to label value.
registeredFieldIdsarray of stringNoField ids (GUIDs) to register on this classification.
registeredFieldGroupIdsarray of stringNoField group ids (GUIDs) to register on this classification.
followerClassificationIdsarray of stringNoClassification ids (GUIDs) to set as followers of this classification.

Returns:

FieldTypeDescription
idstring
namestring

delete_classification

In the default tool list · Destructive

Permanently deletes an Aprimo classification by id, leaf name, or name path. This cannot be undone and may affect every record classified under it. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact classification with the user.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID) to delete. Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.
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 classification.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a classification is permanent, cannot be undone, and may affect every record classified under it. Set only after stating the exact classification 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_classification

In the default tool list

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:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe 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.
namePathstringNoThe classification's full name path (e.g. "/Brands/Europe/Digital Images"), which is unique. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
idstring
identifierstring (optional)
namestring
namePathstring (optional)
labelPathstring (optional)
sortIndexinteger (optional)
sortOrderstring (optional)
disabledInDamUiboolean (optional)
labelsarray of ClassificationLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
isRootboolean (optional)
parentIdstring (optional)
hasChildrenboolean (optional)
tagstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_classification_by_name_path

In the default tool list

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:

ParameterTypeRequiredDescription
namePathstringNoThe classification's full name path, e.g. "/Brands/Europe/Digital Images". Provide this or fieldName+fieldValue, not both.
fieldNamestringNoName of a unique field to look up by (e.g. "identifier"). Requires fieldValue. Provide this pair or namePath, not both.
fieldValuestringNoValue of the unique field named by fieldName. Requires fieldName.

Returns:

FieldTypeDescription
idstring
identifierstring (optional)
namestring
namePathstring (optional)
labelPathstring (optional)
sortIndexinteger (optional)
sortOrderstring (optional)
disabledInDamUiboolean (optional)
labelsarray of ClassificationLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
isRootboolean (optional)
parentIdstring (optional)
hasChildrenboolean (optional)
tagstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_classification_field

In the default tool list

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:

ParameterTypeRequiredDescription
fieldIdstringYesThe field id (GUID), from list_classification_fields.
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
idstring
fieldNamestring (optional)
labelstring (optional)
dataTypestring (optional)
valuestring (optional)

get_classification_image_url

Available on request

Returns the image URL (plus width/height/size/extension) for an Aprimo classification, by id, name, or name path. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
uristring (optional)
widthinteger (optional)
heightinteger (optional)
sizeinteger (optional)
extensionstring (optional)

get_classification_parent

In the default tool list

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:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
idstring
identifierstring (optional)
namestring
namePathstring (optional)
labelPathstring (optional)
sortIndexinteger (optional)
sortOrderstring (optional)
disabledInDamUiboolean (optional)
labelsarray of ClassificationLabelPayload
labels[].valuestring (optional)
labels[].languageIdstring (optional)
registeredFieldIdsarray of string
registeredFieldGroupIdsarray of string
isRootboolean (optional)
parentIdstring (optional)
hasChildrenboolean (optional)
tagstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)

get_classification_tree_permission

In the default tool list

Gets the calling user's own classification-tree rights (read/classify/modify/delete) on one Aprimo classification, by id, name, or name path. For the full per-user-group permission list instead, use list_classification_tree_permissions.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
canReadboolean (optional)
canClassifyboolean (optional)
canModifyboolean (optional)
canDeleteboolean (optional)

list_classification_ancestors

In the default tool list

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:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of LinkedClassificationPayload
items[].idstring
items[].depthinteger
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)

list_classification_children

In the default tool list

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:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of ClassificationDetailPayload
items[].idstring
items[].identifierstring (optional)
items[].namestring
items[].namePathstring (optional)
items[].labelPathstring (optional)
items[].sortIndexinteger (optional)
items[].sortOrderstring (optional)
items[].disabledInDamUiboolean (optional)
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].registeredFieldIdsarray of string
items[].registeredFieldGroupIdsarray of string
items[].isRootboolean (optional)
items[].parentIdstring (optional)
items[].hasChildrenboolean (optional)
items[].tagstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)

list_classification_download_permissions

In the default tool list

Lists the download permissions (per-user-group download rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path. This is a read; to change these permissions use preview_classification_permissions/apply_classification_permissions with kind="download".

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
kindstring
breakInheritanceboolean (optional)
permissionsarray of ClassificationGroupPermissionEntryPayload
permissions[].userGroupIdstring
permissions[].accessRightstring

list_classification_fields

In the default tool list

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:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of SearchAprimoFieldValue
items[].idstring
items[].fieldNamestring (optional)
items[].labelstring (optional)
items[].dataTypestring (optional)
items[].valuestring (optional)

list_classification_follower_classifications

In the default tool list

Lists the follower classifications of one Aprimo classification (other classifications linked to receive updates/notifications from this one), by id, name, or name path.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
countinteger
itemsarray of ClassificationDetailPayload
items[].idstring
items[].identifierstring (optional)
items[].namestring
items[].namePathstring (optional)
items[].labelPathstring (optional)
items[].sortIndexinteger (optional)
items[].sortOrderstring (optional)
items[].disabledInDamUiboolean (optional)
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].registeredFieldIdsarray of string
items[].registeredFieldGroupIdsarray of string
items[].isRootboolean (optional)
items[].parentIdstring (optional)
items[].hasChildrenboolean (optional)
items[].tagstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)

list_classification_record_permissions

In the default tool list

Lists the record permissions (per-user-group record access rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path. This is a read; to change these permissions use preview_classification_permissions/apply_classification_permissions with kind="record".

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
kindstring
breakInheritanceboolean (optional)
permissionsarray of ClassificationGroupPermissionEntryPayload
permissions[].userGroupIdstring
permissions[].accessRightstring

list_classification_tree_permissions

In the default tool list

Lists the classification-tree permissions (per-user-group access rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path. This is a read; to change these permissions use preview_classification_permissions/apply_classification_permissions with kind="tree".

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID). Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's full name path. Provide exactly one of classificationId, name, or namePath.

Returns:

FieldTypeDescription
classificationIdstring
kindstring
breakInheritanceboolean (optional)
permissionsarray of ClassificationGroupPermissionEntryPayload
permissions[].userGroupIdstring
permissions[].accessRightstring

search_classifications

In the default tool list

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:

ParameterTypeRequiredDescription
expressionstringNoDAM search-expression string, e.g. "Name Contains 'Digital'". Omit to match every classification (bounded by skip/take).
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 ClassificationDetailPayload
items[].idstring
items[].identifierstring (optional)
items[].namestring
items[].namePathstring (optional)
items[].labelPathstring (optional)
items[].sortIndexinteger (optional)
items[].sortOrderstring (optional)
items[].disabledInDamUiboolean (optional)
items[].labelsarray of ClassificationLabelPayload
items[].labels[].valuestring (optional)
items[].labels[].languageIdstring (optional)
items[].registeredFieldIdsarray of string
items[].registeredFieldGroupIdsarray of string
items[].isRootboolean (optional)
items[].parentIdstring (optional)
items[].hasChildrenboolean (optional)
items[].tagstring (optional)
items[].modifiedOnstring (optional)
items[].createdOnstring (optional)

update_classification

In the default tool list

Edits an existing Aprimo classification by id, leaf name, or name path. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact classification and the new values with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
classificationIdstringNoThe classification id (GUID) to edit. Provide exactly one of classificationId, name, or namePath.
namestringNoThe classification's current leaf name (case-insensitive, exact match), used to look it up. Provide exactly one of classificationId, name, or namePath.
namePathstringNoThe classification's current full name path, used to look it up. Provide exactly one of classificationId, name, or namePath.
newNamestringNoNew name for the classification. Omit to leave the name unchanged.
identifierstringNoNew unique identifier string. Omit to leave it unchanged.
sortIndexintegerNoNew sort index among sibling classifications. Omit to leave it unchanged.
sortOrderstringNoNew sort order for this classification's children. Omit to leave it unchanged.
disabledInDamUibooleanNoNew "disabled in DAM UI" setting. Omit to leave it unchanged.
tagstringNoNew custom XML tag. 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.
registeredFieldIdsToAddarray of stringNoField ids (GUIDs) to register on this classification.
registeredFieldIdsToRemovearray of stringNoField ids (GUIDs) to unregister from this classification.
registeredFieldGroupIdsToAddarray of stringNoField group ids (GUIDs) to register on this classification.
registeredFieldGroupIdsToRemovearray of stringNoField group ids (GUIDs) to unregister from this classification.
followerClassificationIdsToAddarray of stringNoClassification ids (GUIDs) to add as followers of this classification.
followerClassificationIdsToRemovearray of stringNoClassification ids (GUIDs) to remove as followers of this classification.

Returns:

FieldTypeDescription
idstring
namestring (optional)