Skip to main content

Configure the content model

Define the structures that shape your DAM: custom metadata fields, content types, file types, classifications, and languages.

This area has 4 groups and 37 tools, 36 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
Configure Custom Metadata FieldsCan change dataRead the Content Model10
Configure Content Types & File TypesCan change dataRead the Content Model6
Govern the Classification TaxonomyCan change dataFind & Discover Content, Look Up DAM Users & Groups9
Manage Languages & TranslationsCan change dataRead the Content Model12

Configure Custom Metadata Fields​

Can change data · 10 tools · Group ID configure-custom-metadata-fields

Needs: Read the Content Model

ToolWhat it does
create_field_definitionCreates a new custom metadata field definition in Aprimo.
create_field_groupCreates a new Aprimo field group.
delete_field_definitionDestructive. Permanently deletes an Aprimo custom metadata field definition by id or by name.
delete_field_groupDestructive. Permanently deletes an Aprimo field group by id or by name.
get_field_group_created_byGets the Aprimo user who created a field group, by id or by name.
get_field_group_modified_byGets the Aprimo user who last modified a field group, by id or by name.
get_field_population_log_recentLists recent ai-predicted values for one Aprimo field: the record each prediction was made for, the initial and updated values, and whether the prediction was accepted or overwritten.
list_field_population_log_summaryLists aggregate ai metadata-prediction stats for every Aprimo field that has them: how often a value was predicted versus attempted, and how often the prediction was retained (accepted) rather than overwritten.
update_field_definitionEdits an existing Aprimo custom metadata field definition by id or by name.
update_field_groupEdits an existing Aprimo field group by id or by name.

create_field_definition​

Creates a new custom metadata field definition in Aprimo. This modifies data. Always confirm the name, data type, and scope with the user before calling this tool. Covers cross-data-type attributes only — data-type-specific configuration (e.g. option-list items, numeric range) is not supported by this tool.

Parameters:

ParameterTypeRequiredDescription
namestringYesThe name for the new field definition, exactly as the user stated it.
dataTypestringYesThe field's data type. One of: SingleLineText, MultiLineText, Numeric, DateTime, Date, Time, OptionList, Duration, UserList, UserGroupList, Html, Json, ClassificationList, RecordList, RecordLink, LanguageList, TextList, HyperlinkList.
scopestringNoOptional scope. One of: RecordContentGlobal, RecordContentClassDependent, RecordContentFloating, ClassificationProfileClassDependent, UserGlobal, FileFileTypeDependent, FileFloating, IndexerTaskGlobal, FileGlobal, ClassificationProfileFloating, RecordContentContentTypeDependent.
labelsobject (map of string)NoMulti-language labels for the field's name: a map of languageId (GUID) to label value.
helpTextsobject (map of string)NoMulti-language help texts for the field: a map of languageId (GUID) to help-text value.
isRequiredbooleanNoWhether the field is required. Defaults to false.
isReadOnlybooleanNoWhether the field is read-only. Defaults to false.
isUniqueIdentifierbooleanNoWhether the field's value must be unique across records. Defaults to false.
indexedbooleanNoWhether searching on this field is enabled. Defaults to false.
inlineStylestringNoOptional inline css style applied to the field in the DAM UI.
sortIndexintegerNoOptional sort index used to order the field relative to other fields.
tagstringNoOptional custom XML tag associated with the field.
languageModestringNoOptional language mode. One of: Single, Multiple.
defaultValuestringNoOptional default value assigned to the field.
resetToDefaultTriggersarray of stringNoOptional triggers that reset the field to its default value. Each one of: None, OnNewField, OnLoad, OnSave, OnAnyFileChange, OnReclassifyRecord, OnAnyChange, OnFieldChange, OnMasterFileChange, OnCurrentFileChange, OnFieldDefinitionChanged, OnDuplicateRecord, OnRecordStatusChange.
resetToDefaultFieldIdsarray of stringNoField ids (GUIDs) that trigger this field to be reset to its default value — only used when resetToDefaultTriggers includes "OnFieldChange".
validationTriggerstringNoOptional validation trigger. One of: None, WhenNeeded, Always.
validationstringNoOptional validation expression applied to the field's value.
validationErrorMessagestringNoOptional error message shown when validation fails.
storageModestringNoOptional storage mode. One of: None, NonEmptyValues, AllValues, LogChanges.
enabledLanguageIdsarray of stringNoLanguage ids (GUIDs) in which this field is enabled.
membershipFieldGroupIdsarray of stringNoField group ids (GUIDs) this field should be a member of.

Returns:

FieldTypeDescription
idstring
namestring

create_field_group​

Creates a new Aprimo field group. This modifies data. Always confirm the name and member field definitions with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
namestringYesThe name for the new field group, exactly as the user stated it.
tagstringNoOptional custom XML tag associated with the group.
memberFieldIdsarray of stringNoField definition ids (GUIDs) to add as members of the new group.

Returns:

FieldTypeDescription
idstring
namestring

delete_field_definition​

Destructive

Permanently deletes an Aprimo custom metadata field definition by id or by name. This cannot be undone and removes the field's values from every record that had one. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact field with the user.

Parameters:

ParameterTypeRequiredDescription
fieldDefinitionIdstringNoThe field definition id (GUID) to delete. Provide this or name, not both.
namestringNoThe field definition's name (case-insensitive, exact match). Provide this or fieldDefinitionId, 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 field.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a field definition is permanent and cannot be undone. Set only after stating the exact field 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.


delete_field_group​

Destructive

Permanently deletes an Aprimo field group by id or by name. This cannot be undone — member field definitions themselves are not deleted, only the grouping. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact group with the user.

Parameters:

ParameterTypeRequiredDescription
fieldGroupIdstringNoThe field group id (GUID) to delete. Provide this or name, not both.
namestringNoThe field group's name (case-insensitive, exact match). Provide this or fieldGroupId, 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 group.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a field group is permanent and cannot be undone. Set only after stating the exact group 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_field_group_created_by​

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

Parameters:

ParameterTypeRequiredDescription
fieldGroupIdstringNoThe field group id (GUID). Provide this or name, not both.
namestringNoThe field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both.

Returns:

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

get_field_group_modified_by​

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

Parameters:

ParameterTypeRequiredDescription
fieldGroupIdstringNoThe field group id (GUID). Provide this or name, not both.
namestringNoThe field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both.

Returns:

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

get_field_population_log_recent​

Lists recent ai-predicted values for one Aprimo field: the record each prediction was made for, the initial and updated values, and whether the prediction was accepted or overwritten.

Parameters:

ParameterTypeRequiredDescription
fieldIdstringYesThe field definition id (GUID) to fetch recent predictions for, from list_field_definitions.

Returns:

FieldTypeDescription
fieldIdstring
countinteger
itemsarray of FieldPopulationLogPredictionPayload
items[].contentItemIdstring (optional)
items[].contentItemTitlestring (optional)
items[].contentItemPreviewImagestring (optional)
items[].logDatestring (optional)
items[].initialValuestring (optional)
items[].lastChangeDatestring (optional)
items[].statusstring (optional)
items[].updatedValuestring (optional)

list_field_population_log_summary​

Lists aggregate ai metadata-prediction stats for every Aprimo field that has them: how often a value was predicted versus attempted, and how often the prediction was retained (accepted) rather than overwritten. Use to gauge how well ai field prediction is working across fields.

Parameters: none.

Returns:

FieldTypeDescription
countinteger
itemsarray of FieldPopulationLogSummaryPayload
items[].fieldIdstring
items[].fieldNamestring (optional)
items[].hintsstring (optional)
items[].predictedPercentnumber (optional)
items[].predictedCountinteger (optional)
items[].attemptedCountinteger (optional)
items[].retainedPercentnumber (optional)
items[].retainedCountinteger (optional)

update_field_definition​

Edits an existing Aprimo custom metadata field definition by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact field and the new values with the user before calling this tool. The field's data type cannot be changed after creation.

Parameters:

ParameterTypeRequiredDescription
fieldDefinitionIdstringNoThe field definition id (GUID) to edit. Provide this or name, not both.
namestringNoThe field definition's current name (case-insensitive, exact match), used to look it up. Provide this or fieldDefinitionId, not both.
newNamestringNoNew name for the field definition. Omit to leave the name unchanged.
scopestringNoNew scope. One of: RecordContentGlobal, RecordContentClassDependent, RecordContentFloating, ClassificationProfileClassDependent, UserGlobal, FileFileTypeDependent, FileFloating, IndexerTaskGlobal, FileGlobal, ClassificationProfileFloating, RecordContentContentTypeDependent. Omit to leave it unchanged.
labelsobject (map of string)NoLabel values to set: a map of languageId (GUID) to label value. Only the languages provided are changed.
helpTextsobject (map of string)NoHelp-text values to set: a map of languageId (GUID) to help-text value. Only the languages provided are changed.
isRequiredbooleanNoNew required setting. Omit to leave it unchanged.
isReadOnlybooleanNoNew read-only setting. Omit to leave it unchanged.
isUniqueIdentifierbooleanNoNew unique-identifier setting. Omit to leave it unchanged.
indexedbooleanNoNew indexed setting. Omit to leave it unchanged.
inlineStylestringNoNew inline css style. Omit to leave it unchanged.
sortIndexintegerNoNew sort index. Omit to leave it unchanged.
tagstringNoNew custom XML tag. Omit to leave it unchanged.
defaultValuestringNoNew default value. Omit to leave it unchanged.
resetToDefaultTriggersarray of stringNoNew reset-to-default triggers (full replacement list). Each one of: None, OnNewField, OnLoad, OnSave, OnAnyFileChange, OnReclassifyRecord, OnAnyChange, OnFieldChange, OnMasterFileChange, OnCurrentFileChange, OnFieldDefinitionChanged, OnDuplicateRecord, OnRecordStatusChange. Omit to leave it unchanged.
resetToDefaultFieldIdsarray of stringNoNew reset-to-default field ids (GUIDs, full replacement list). Omit to leave it unchanged.
validationTriggerstringNoNew validation trigger. One of: None, WhenNeeded, Always. Omit to leave it unchanged.
validationstringNoNew validation expression. Omit to leave it unchanged.
validationErrorMessagestringNoNew validation error message. Omit to leave it unchanged.
storageModestringNoNew storage mode. One of: None, NonEmptyValues, AllValues, LogChanges. Omit to leave it unchanged.
enabledLanguageIdsToAddarray of stringNoLanguage ids (GUIDs) to enable this field for.
enabledLanguageIdsToRemovearray of stringNoLanguage ids (GUIDs) to disable this field for.
membershipFieldGroupIdsToAddarray of stringNoField group ids (GUIDs) to add this field to.
membershipFieldGroupIdsToRemovearray of stringNoField group ids (GUIDs) to remove this field from.

Returns:

FieldTypeDescription
idstring
namestring (optional)

update_field_group​

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

Parameters:

ParameterTypeRequiredDescription
fieldGroupIdstringNoThe field group id (GUID) to edit. Provide this or name, not both.
namestringNoThe field group's current name (case-insensitive, exact match), used to look it up. Provide this or fieldGroupId, not both.
newNamestringNoNew name for the field group. Omit to leave the name unchanged.
tagstringNoNew custom XML tag. Omit to leave the tag unchanged.
memberFieldIdsToAddarray of stringNoField definition ids (GUIDs) to add as members.
memberFieldIdsToRemovearray of stringNoField definition ids (GUIDs) to remove from the group.

Returns:

FieldTypeDescription
idstring
namestring (optional)

Configure Content Types & File Types​

Can change data · 6 tools · Group ID configure-content-types-file-types

Needs: Read the Content Model

ToolWhat it does
create_content_typeCreates a new Aprimo content type.
create_file_typeCreates a new Aprimo file type.
delete_content_typeDestructive. Permanently deletes an Aprimo content type by id or by name.
delete_file_typeDestructive. Permanently deletes an Aprimo file type by id or by name.
update_content_typeEdits an existing Aprimo content type by id or by name.
update_file_typeEdits an existing Aprimo file type by id or by name.

create_content_type​

Creates a new Aprimo content type. This modifies data. Always confirm the name and any other settings with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
namestringYesThe name for the new content type, exactly as the user stated it.
purposestringNoOptional description of the content type's purpose.
parentIdstringNoOptional parent content type id (GUID) this content type inherits from.
isNoFilebooleanNoWhen true, records of this content type have no file (a "no-file" content type). Defaults to false.
fileModestringNoOptional file mode. One of: UploadFile, NoFile, CreateFromUrl, CreateFromSmartAgent, ManagedInDam.
titleConfigurationOptionstringNoOptional title-resolution option. One of: FileName, Field.
titleConfigurationFieldIdstringNoField id (GUID) used to resolve the title, when titleConfigurationOption is "Field".
titleConfigurationShowExtensionbooleanNoWhen true, the file extension is included in the title, when titleConfigurationOption is "FileName".
registeredFieldIdsarray of stringNoField ids (GUIDs) to register on this content type.
inheritableFieldIdsarray of stringNoField ids (GUIDs) that can be inherited from the parent content type.
defaultFileExtensions.")] List<string>NoDefault file extensions associated with this content type, e.g. ["avi", "MP4"].
labelsobject (map of string)NoMulti-language labels for the name of this content type: a map of languageId (GUID) to label value.
inheritanceConfigurationstringNoOptional inheritance configuration. One of: None, Parent, Custom.
inheritanceFieldIdstringNoField id (GUID) used to resolve the parent record for inheritance, when inheritanceConfiguration is "Custom".

Returns:

FieldTypeDescription
idstring
namestring

create_file_type​

Creates a new Aprimo file type. This modifies data. Always confirm the name and any other settings with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
namestringYesThe name for the new file type, exactly as the user stated it.
kindstringNoThe kind of the file type, e.g. "Image", "Video", "Document".
extensionstringNoThe file extension associated with this file type, e.g. "PDF".
mimeTypestringNoThe MIME type associated with this file type, e.g. "application/pdf".
engineFormatstringNoRequired (not actually optional — DAM's FileType.OnValidateChanges rejects an empty EngineFormat on every save, and a newly-created file type's EngineFormat starts empty, so omitting this always fails server-side with an opaque "An invalid value was specified for EngineFormat" error). The engine format used to process files of this type, e.g. "default" (the built-in passthrough format) — call list_file_types to see engine formats already used in this tenant.
isCatalogablebooleanNoWhether files of this type can be cataloged. Omit to use DAM's default.
previewFormatstringNoThe preview format used for this file type, e.g. "Jpg", "None".
previewRequiredbooleanNoWhether a preview is required for files of this type. Omit to use DAM's default.
previewKeepDimensionsbooleanNoWhether the preview should keep the original dimensions. Omit to use DAM's default.
supportAssetResizebooleanNoWhether asset resize is supported for this file type. Omit to use DAM's default.
supportAssetWatermarkbooleanNoWhether asset watermarking is supported for this file type. Omit to use DAM's default.
preferredExtensionbooleanNoWhether this file type's extension is the preferred one for its kind. Omit to use DAM's default.
tagstringNoOptional custom XML tag for this file type.
registeredFieldIdsarray of stringNoField ids (GUIDs) to register on this file type.
registeredFieldGroupIdsarray of stringNoField group ids (GUIDs) to register on this file type.
mediaEngines.")] List<string>NoMedia engines used for this file type, e.g. ["Exif", "Text"].
previewPlayers.")] List<string>NoPreview render web controls used for this file type, e.g. ["Adam.PdfPreviewPlayer"].
labelsobject (map of string)NoMulti-language labels for the name of this file type: a map of languageId (GUID) to label value.

Returns:

FieldTypeDescription
idstring
namestring

delete_content_type​

Destructive

Permanently deletes an Aprimo content type by id or by name. This cannot be undone. DAM only allows deleting a content type if no records of that type exist and it is not a predefined content type. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact content type with the user.

Parameters:

ParameterTypeRequiredDescription
contentTypeIdstringNoThe content type id (GUID) to delete. Provide this or name, not both.
namestringNoThe content type's name (case-insensitive, exact match). Provide this or contentTypeId, 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 content type.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a content type is permanent and cannot be undone. Set only after stating the exact content type 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.


delete_file_type​

Destructive

Permanently deletes an Aprimo file type by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact file type with the user.

Parameters:

ParameterTypeRequiredDescription
fileTypeIdstringNoThe file type id (GUID) to delete. Provide this or name, not both.
namestringNoThe file type's name (case-insensitive, exact match). Provide this or fileTypeId, 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 file type.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a file type is permanent and cannot be undone. Set only after stating the exact file type 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.


update_content_type​

Edits an existing Aprimo content type by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact content type and the new values with the user before calling this tool. Note: DAM only allows renaming a content type if no records of that type exist yet.

Parameters:

ParameterTypeRequiredDescription
contentTypeIdstringNoThe content type id (GUID) to edit. Provide this or name, not both.
namestringNoThe content type's current name (case-insensitive, exact match), used to look it up. Provide this or contentTypeId, not both.
newNamestringNoNew name for the content type. Omit to leave the name unchanged.
purposestringNoNew purpose/description. Omit to leave it unchanged.
parentIdstringNoNew parent content type id (GUID). Omit to leave it unchanged.
isNoFilebooleanNoNew "no-file" setting. Omit to leave it unchanged.
fileModestringNoNew file mode. One of: UploadFile, NoFile, CreateFromUrl, CreateFromSmartAgent, ManagedInDam. Omit to leave it unchanged.
titleConfigurationOptionstringNoNew title-resolution option. One of: FileName, Field. Omit to leave it unchanged.
titleConfigurationFieldIdstringNoNew field id (GUID) for title resolution, when titleConfigurationOption is "Field".
titleConfigurationShowExtensionbooleanNoNew value for including the file extension in the title, when titleConfigurationOption is "FileName".
registeredFieldIdsToAddarray of stringNoField ids (GUIDs) to register on this content type.
registeredFieldIdsToRemovearray of stringNoField ids (GUIDs) to unregister from this content type.
inheritableFieldIdsToAddarray of stringNoField ids (GUIDs) to add as inheritable from the parent content type.
inheritableFieldIdsToRemovearray of stringNoField ids (GUIDs) to remove from the inheritable set.
defaultFileExtensionsToAdd.")] List<string>NoDefault file extensions to add, e.g. ["avi", "MP4"].
defaultFileExtensionsToRemovearray of stringNoDefault file extensions to remove.
labelsobject (map of string)NoLabel values to set: a map of languageId (GUID) to label value. Only the languages provided are changed.
inheritanceConfigurationstringNoNew inheritance configuration. One of: None, Parent, Custom. Omit to leave it unchanged.
inheritanceFieldIdstringNoNew field id (GUID) for inheritance resolution, when inheritanceConfiguration is "Custom".

Returns:

FieldTypeDescription
idstring
namestring (optional)

update_file_type​

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

Parameters:

ParameterTypeRequiredDescription
fileTypeIdstringNoThe file type id (GUID) to edit. Provide this or name, not both.
namestringNoThe file type's current name (case-insensitive, exact match), used to look it up. Provide this or fileTypeId, not both.
newNamestringNoNew name for the file type. Omit to leave the name unchanged.
kindstringNoNew kind. Omit to leave it unchanged.
extensionstringNoNew file extension. Omit to leave it unchanged.
mimeTypestringNoNew MIME type. Omit to leave it unchanged.
engineFormatstringNoNew engine format. Omit to leave it unchanged.
isCatalogablebooleanNoNew "is catalogable" setting. Omit to leave it unchanged.
previewFormatstringNoNew preview format. Omit to leave it unchanged.
previewRequiredbooleanNoNew "preview required" setting. Omit to leave it unchanged.
previewKeepDimensionsbooleanNoNew "preview keep dimensions" setting. Omit to leave it unchanged.
supportAssetResizebooleanNoNew "support asset resize" setting. Omit to leave it unchanged.
supportAssetWatermarkbooleanNoNew "support asset watermark" setting. Omit to leave it unchanged.
preferredExtensionbooleanNoNew "preferred extension" setting. Omit to leave it unchanged.
tagstringNoNew custom XML tag. Omit to leave it unchanged.
registeredFieldIdsToAddarray of stringNoField ids (GUIDs) to register on this file type.
registeredFieldIdsToRemovearray of stringNoField ids (GUIDs) to unregister from this file type.
registeredFieldGroupIdsToAddarray of stringNoField group ids (GUIDs) to register on this file type.
registeredFieldGroupIdsToRemovearray of stringNoField group ids (GUIDs) to unregister from this file type.
mediaEnginesToAdd.")] List<string>NoMedia engines to add, e.g. ["Xmp"].
mediaEnginesToRemove.")] List<string>NoMedia engines to remove, e.g. ["Exif", "Text"].
previewPlayersToAddarray of stringNoPreview render web controls to add.
previewPlayersToRemovearray of stringNoPreview render web controls to remove.
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)

Govern the Classification Taxonomy​

Can change data · 9 tools (8 currently available) · Group ID govern-the-classification-taxonomy

Needs: Find & Discover Content, Look Up DAM Users & Groups

ToolWhat it does
create_classificationCreates a new Aprimo classification (taxonomy node).
delete_classificationDestructive. Permanently deletes an Aprimo classification by id, leaf name, or name path.
get_classification_image_urlNot currently available. Returns the image URL (plus width/height/size/extension) for an Aprimo classification, by id, name, or name path.
get_classification_tree_permissionGets the calling user's own classification-tree rights (read/classify/modify/delete) on one Aprimo classification, by id, name, or name path.
list_classification_download_permissionsLists 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_follower_classificationsLists 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_permissionsLists 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_permissionsLists the classification-tree permissions (per-user-group access rights, plus whether inheritance is broken) on one Aprimo classification, by id, name, or name path.
update_classificationEdits an existing Aprimo classification by id, leaf name, or name path.

create_classification​

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​

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_image_url​

Not currently available

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_tree_permission​

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_download_permissions​

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_follower_classifications​

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​

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​

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

update_classification​

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)

Manage Languages & Translations​

Can change data · 12 tools · Group ID manage-languages-translations

Needs: Read the Content Model

ToolWhat it does
create_languageCreates a new Aprimo language for multi-language fields/labels.
create_translationCreates a new Aprimo translation under a studio/module/name key.
delete_languageDestructive. Permanently deletes an Aprimo language by id or by name.
delete_translationDestructive. Permanently deletes an Aprimo translation by id or by name.
get_language_imageReturns the image URL (plus width/height/size/extension) for an Aprimo language, by id or by name.
get_language_synonymsExports the solr-formatted synonyms list for an Aprimo language, by id or by name.
get_translationGets one Aprimo translation's detail (studio, module, name, custom tag, localized values, dates) by id or by name.
get_translation_by_keyGets one Aprimo translation by its exact studio/module/name key (DAM's own unique-key lookup — all three are required together).
list_translationsLists the translations configured in Aprimo: studio, module, name, and dates.
update_languageEdits an existing Aprimo language by id or by name.
update_language_synonymsImports (replaces) the entire solr-formatted synonyms list for an Aprimo language, by id or by name.
update_translationEdits an existing Aprimo translation by id or by name.

create_language​

Creates a new Aprimo language for multi-language fields/labels. This modifies data. Always confirm the name and culture with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
namestringYesThe name for the new language, exactly as the user stated it, e.g. "Dutch".
culturestringYesThe culture code for the language, e.g. "nl-be".
enabledForFieldsbooleanNoWhether this language is enabled for field values. Omit to use DAM's default.
enabledForUIbooleanNoWhether this language is enabled for the user interface. Omit to use DAM's default.
tagstringNoOptional custom XML tag associated with the language.

Returns:

FieldTypeDescription
idstring
namestring

create_translation​

Creates a new Aprimo translation under a studio/module/name key. This modifies data. Always confirm the studio, module, name, and localized values with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
studiostringYesThe studio the translation belongs to, e.g. "Core".
modulestringYesThe module the translation belongs to, e.g. "Search".
namestringYesThe name of the element being translated, exactly as the user stated it, e.g. "SaveButtonLabel".
tagstringNoOptional custom XML tag associated with the translation.
localizedValuesarray of DamModels.TranslationLocalizedValueNoThe localized values for the translation, one per language (languageId + value). Omit to create with no localized values yet.

Returns:

FieldTypeDescription
idstring
studiostring
modulestring
namestring

delete_language​

Destructive

Permanently deletes an Aprimo language by id or by name. This cannot be undone — any field/label values localized into this language are affected. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact language with the user.

Parameters:

ParameterTypeRequiredDescription
languageIdstringNoThe language id (GUID) to delete. Provide this or name, not both.
namestringNoThe language's name (case-insensitive, exact match). Provide this or languageId, 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 language.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a language is permanent and cannot be undone. Set only after stating the exact language 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.


delete_translation​

Destructive

Permanently deletes an Aprimo translation by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact translation with the user.

Parameters:

ParameterTypeRequiredDescription
translationIdstringNoThe translation id (GUID) to delete. Provide this or name, not both.
namestringNoThe translation's name (case-insensitive, exact match). Provide this or translationId, not both. Note: names commonly repeat — an ambiguous match will ask for translationId instead.
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 translation.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a translation is permanent and cannot be undone. Set only after stating the exact translation 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_language_image​

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

Parameters:

ParameterTypeRequiredDescription
languageIdstringNoThe language id (GUID). Provide this or name, not both.
namestringNoThe language's name (case-insensitive, exact match). Provide this or languageId, not both.

Returns:

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

get_language_synonyms​

Exports the solr-formatted synonyms list for an Aprimo language, by id or by name. Returns the raw synonyms text (one synonym group per line) so it can be reviewed or edited before calling update_language_synonyms.

Parameters:

ParameterTypeRequiredDescription
languageIdstringNoThe language id (GUID). Provide this or name, not both.
namestringNoThe language's name (case-insensitive, exact match). Provide this or languageId, not both.

Returns:

FieldTypeDescription
languageIdstring
contentstring
lineCountinteger

get_translation​

Gets one Aprimo translation's detail (studio, module, name, custom tag, localized values, dates) by id or by name. Not get_translation_by_key, which looks up by a different key shape (studio/module/name triplet) rather than an id. Use list_translations first, or pass name directly — but note plain names commonly repeat across studios/modules, so an ambiguous match will ask you to use translationId or get_translation_by_key instead.

Parameters:

ParameterTypeRequiredDescription
translationIdstringNoThe translation id (GUID), from list_translations. Provide this or name, not both.
namestringNoThe translation's name (case-insensitive, exact match). Provide this or translationId, not both. Note: names commonly repeat across studios/modules — an ambiguous match will ask for translationId instead.

Returns:

FieldTypeDescription
idstring
studiostring
modulestring
namestring
tagstring (optional)
localizedValuesarray of TranslationLocalizedValuePayload
localizedValues[].languageIdstring
localizedValues[].valuestring
createdOnstring
modifiedOnstring

get_translation_by_key​

Gets one Aprimo translation by its exact studio/module/name key (DAM's own unique-key lookup — all three are required together). Use this when the caller already knows all three, e.g. from application source/config; otherwise use get_translation by id or by (ambiguous) name.

Parameters:

ParameterTypeRequiredDescription
studiostringYesThe studio name for the translation, e.g. "Core".
modulestringYesThe module name for the translation, e.g. "Search".
namestringYesThe name of the element that should be translated, e.g. "SaveButtonLabel".

Returns:

FieldTypeDescription
idstring
studiostring
modulestring
namestring
tagstring (optional)
localizedValuesarray of TranslationLocalizedValuePayload
localizedValues[].languageIdstring
localizedValues[].valuestring
createdOnstring
modifiedOnstring

list_translations​

Lists the translations configured in Aprimo: studio, module, name, and dates. Use when the user asks what translations exist, or to look up a translation's id before calling get_translation/update_translation/delete_translation.

Parameters:

ParameterTypeRequiredDescription
filterstringNoOptional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every translation.
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 TranslationPayload
items[].idstring
items[].studiostring
items[].modulestring
items[].namestring
items[].tagstring (optional)
items[].localizedValuesarray of TranslationLocalizedValuePayload
items[].localizedValues[].languageIdstring
items[].localizedValues[].valuestring
items[].createdOnstring
items[].modifiedOnstring

update_language​

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

Parameters:

ParameterTypeRequiredDescription
languageIdstringNoThe language id (GUID) to edit. Provide this or name, not both.
namestringNoThe language's current name (case-insensitive, exact match), used to look it up. Provide this or languageId, not both.
newNamestringNoNew name for the language. Omit to leave the name unchanged.
culturestringNoNew culture code, e.g. "nl-be". Omit to leave the culture unchanged.
enabledForFieldsbooleanNoNew enabled-for-fields flag. Omit to leave it unchanged.
enabledForUIbooleanNoNew enabled-for-UI flag. Omit to leave it unchanged.
tagstringNoNew custom XML tag. Omit to leave the tag unchanged.

Returns:

FieldTypeDescription
idstring
namestring (optional)

update_language_synonyms​

Imports (replaces) the entire solr-formatted synonyms list for an Aprimo language, by id or by name. This modifies data and overwrites any existing synonyms for the language. Always show the new content to the user and confirm before calling this tool — use get_language_synonyms first if you need to preserve any existing entries.

Parameters:

ParameterTypeRequiredDescription
languageIdstringNoThe language id (GUID) to edit. Provide this or name, not both.
namestringNoThe language's current name (case-insensitive, exact match), used to look it up. Provide this or languageId, not both.
synonymsContentstringNoThe full new synonyms file content, solr format (one synonym group per line, e.g. "car, automobile, vehicle"). Required and cannot be empty: DAM's import silently ignores empty (or all-comment/invalid) content as a no-op, leaving any existing synonyms untouched — there is no way to clear a language's synonyms via this tool.

Returns:

FieldTypeDescription
languageIdstring
updatedboolean
lineCountinteger

update_translation​

Edits an existing Aprimo translation by id or by name. Only the fields provided are changed — omitted fields keep their current value; if provided, localizedValues replaces the whole set (not a merge). This modifies data. Always confirm the exact translation and the new values with the user before calling this tool.

Parameters:

ParameterTypeRequiredDescription
translationIdstringNoThe translation id (GUID) to edit. Provide this or name, not both.
namestringNoThe translation's current name (case-insensitive, exact match), used to look it up. Provide this or translationId, not both. Note: names commonly repeat — an ambiguous match will ask for translationId instead.
newStudiostringNoNew studio. Omit to leave the studio unchanged.
newModulestringNoNew module. Omit to leave the module unchanged.
newNamestringNoNew name for the translation. Omit to leave the name unchanged.
tagstringNoNew custom XML tag. Omit to leave the tag unchanged.
localizedValuesarray of DamModels.TranslationLocalizedValueNoThe full new set of localized values (languageId + value), replacing the existing set entirely. Omit to leave localized values unchanged.

Returns:

FieldTypeDescription
idstring
namestring (optional)