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.
- Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
- Needs. Enabling a group also enables every group it needs. Each group below lists them.
- Read-only groups are intended for look-up access without the ability to change data.
- Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Not currently available tools are registered but are not offered in any tool list at this time.
- Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Groups in this area
| Group | Access | Needs | Tools |
|---|---|---|---|
| Configure Custom Metadata Fields | Can change data | Read the Content Model | 10 |
| Configure Content Types & File Types | Can change data | Read the Content Model | 6 |
| Govern the Classification Taxonomy | Can change data | Find & Discover Content, Look Up DAM Users & Groups | 9 |
| Manage Languages & Translations | Can change data | Read the Content Model | 12 |
Configure Custom Metadata Fields
Can change data · 10 tools · Group ID configure-custom-metadata-fields
Needs: Read the Content Model
| Tool | What it does |
|---|---|
create_field_definition | Creates a new custom metadata field definition in Aprimo. |
create_field_group | Creates a new Aprimo field group. |
delete_field_definition | Destructive. Permanently deletes an Aprimo custom metadata field definition by id or by name. |
delete_field_group | Destructive. Permanently deletes an Aprimo field group by id or by name. |
get_field_group_created_by | Gets the Aprimo user who created a field group, by id or by name. |
get_field_group_modified_by | Gets the Aprimo user who last modified a field group, by id or by name. |
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. |
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. |
update_field_definition | Edits an existing Aprimo custom metadata field definition by id or by name. |
update_field_group | Edits 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new field definition, exactly as the user stated it. |
dataType | string | Yes | The field's data type. One of: SingleLineText, MultiLineText, Numeric, DateTime, Date, Time, OptionList, Duration, UserList, UserGroupList, Html, Json, ClassificationList, RecordList, RecordLink, LanguageList, TextList, HyperlinkList. |
scope | string | No | Optional scope. One of: RecordContentGlobal, RecordContentClassDependent, RecordContentFloating, ClassificationProfileClassDependent, UserGlobal, FileFileTypeDependent, FileFloating, IndexerTaskGlobal, FileGlobal, ClassificationProfileFloating, RecordContentContentTypeDependent. |
labels | object (map of string) | No | Multi-language labels for the field's name: a map of languageId (GUID) to label value. |
helpTexts | object (map of string) | No | Multi-language help texts for the field: a map of languageId (GUID) to help-text value. |
isRequired | boolean | No | Whether the field is required. Defaults to false. |
isReadOnly | boolean | No | Whether the field is read-only. Defaults to false. |
isUniqueIdentifier | boolean | No | Whether the field's value must be unique across records. Defaults to false. |
indexed | boolean | No | Whether searching on this field is enabled. Defaults to false. |
inlineStyle | string | No | Optional inline css style applied to the field in the DAM UI. |
sortIndex | integer | No | Optional sort index used to order the field relative to other fields. |
tag | string | No | Optional custom XML tag associated with the field. |
languageMode | string | No | Optional language mode. One of: Single, Multiple. |
defaultValue | string | No | Optional default value assigned to the field. |
resetToDefaultTriggers | array of string | No | Optional 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. |
resetToDefaultFieldIds | array of string | No | Field ids (GUIDs) that trigger this field to be reset to its default value — only used when resetToDefaultTriggers includes "OnFieldChange". |
validationTrigger | string | No | Optional validation trigger. One of: None, WhenNeeded, Always. |
validation | string | No | Optional validation expression applied to the field's value. |
validationErrorMessage | string | No | Optional error message shown when validation fails. |
storageMode | string | No | Optional storage mode. One of: None, NonEmptyValues, AllValues, LogChanges. |
enabledLanguageIds | array of string | No | Language ids (GUIDs) in which this field is enabled. |
membershipFieldGroupIds | array of string | No | Field group ids (GUIDs) this field should be a member of. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new field group, exactly as the user stated it. |
tag | string | No | Optional custom XML tag associated with the group. |
memberFieldIds | array of string | No | Field definition ids (GUIDs) to add as members of the new group. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | No | The field definition id (GUID) to delete. Provide this or name, not both. |
name | string | No | The field definition's name (case-insensitive, exact match). Provide this or fieldDefinitionId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact field. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID) to delete. Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact group. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_field_group_created_by
Gets the Aprimo user who created a field group, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID). Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
firstName | string (optional) | |
lastName | string (optional) | |
email | string (optional) | |
isActive | boolean (optional) |
get_field_group_modified_by
Gets the Aprimo user who last modified a field group, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID). Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
firstName | string (optional) | |
lastName | string (optional) | |
email | string (optional) | |
isActive | boolean (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldId | string | Yes | The field definition id (GUID) to fetch recent predictions for, from list_field_definitions. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldId | string | |
count | integer | |
items | array of FieldPopulationLogPredictionPayload | |
items[].contentItemId | string (optional) | |
items[].contentItemTitle | string (optional) | |
items[].contentItemPreviewImage | string (optional) | |
items[].logDate | string (optional) | |
items[].initialValue | string (optional) | |
items[].lastChangeDate | string (optional) | |
items[].status | string (optional) | |
items[].updatedValue | string (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:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldPopulationLogSummaryPayload | |
items[].fieldId | string | |
items[].fieldName | string (optional) | |
items[].hints | string (optional) | |
items[].predictedPercent | number (optional) | |
items[].predictedCount | integer (optional) | |
items[].attemptedCount | integer (optional) | |
items[].retainedPercent | number (optional) | |
items[].retainedCount | integer (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | No | The field definition id (GUID) to edit. Provide this or name, not both. |
name | string | No | The field definition's current name (case-insensitive, exact match), used to look it up. Provide this or fieldDefinitionId, not both. |
newName | string | No | New name for the field definition. Omit to leave the name unchanged. |
scope | string | No | New scope. One of: RecordContentGlobal, RecordContentClassDependent, RecordContentFloating, ClassificationProfileClassDependent, UserGlobal, FileFileTypeDependent, FileFloating, IndexerTaskGlobal, FileGlobal, ClassificationProfileFloating, RecordContentContentTypeDependent. Omit to leave it unchanged. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Only the languages provided are changed. |
helpTexts | object (map of string) | No | Help-text values to set: a map of languageId (GUID) to help-text value. Only the languages provided are changed. |
isRequired | boolean | No | New required setting. Omit to leave it unchanged. |
isReadOnly | boolean | No | New read-only setting. Omit to leave it unchanged. |
isUniqueIdentifier | boolean | No | New unique-identifier setting. Omit to leave it unchanged. |
indexed | boolean | No | New indexed setting. Omit to leave it unchanged. |
inlineStyle | string | No | New inline css style. Omit to leave it unchanged. |
sortIndex | integer | No | New sort index. Omit to leave it unchanged. |
tag | string | No | New custom XML tag. Omit to leave it unchanged. |
defaultValue | string | No | New default value. Omit to leave it unchanged. |
resetToDefaultTriggers | array of string | No | New 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. |
resetToDefaultFieldIds | array of string | No | New reset-to-default field ids (GUIDs, full replacement list). Omit to leave it unchanged. |
validationTrigger | string | No | New validation trigger. One of: None, WhenNeeded, Always. Omit to leave it unchanged. |
validation | string | No | New validation expression. Omit to leave it unchanged. |
validationErrorMessage | string | No | New validation error message. Omit to leave it unchanged. |
storageMode | string | No | New storage mode. One of: None, NonEmptyValues, AllValues, LogChanges. Omit to leave it unchanged. |
enabledLanguageIdsToAdd | array of string | No | Language ids (GUIDs) to enable this field for. |
enabledLanguageIdsToRemove | array of string | No | Language ids (GUIDs) to disable this field for. |
membershipFieldGroupIdsToAdd | array of string | No | Field group ids (GUIDs) to add this field to. |
membershipFieldGroupIdsToRemove | array of string | No | Field group ids (GUIDs) to remove this field from. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID) to edit. Provide this or name, not both. |
name | string | No | The field group's current name (case-insensitive, exact match), used to look it up. Provide this or fieldGroupId, not both. |
newName | string | No | New name for the field group. Omit to leave the name unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
memberFieldIdsToAdd | array of string | No | Field definition ids (GUIDs) to add as members. |
memberFieldIdsToRemove | array of string | No | Field definition ids (GUIDs) to remove from the group. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Configure Content Types & File Types
Can change data · 6 tools · Group ID configure-content-types-file-types
Needs: Read the Content Model
| Tool | What it does |
|---|---|
create_content_type | Creates a new Aprimo content type. |
create_file_type | Creates a new Aprimo file type. |
delete_content_type | Destructive. Permanently deletes an Aprimo content type by id or by name. |
delete_file_type | Destructive. Permanently deletes an Aprimo file type by id or by name. |
update_content_type | Edits an existing Aprimo content type by id or by name. |
update_file_type | Edits 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new content type, exactly as the user stated it. |
purpose | string | No | Optional description of the content type's purpose. |
parentId | string | No | Optional parent content type id (GUID) this content type inherits from. |
isNoFile | boolean | No | When true, records of this content type have no file (a "no-file" content type). Defaults to false. |
fileMode | string | No | Optional file mode. One of: UploadFile, NoFile, CreateFromUrl, CreateFromSmartAgent, ManagedInDam. |
titleConfigurationOption | string | No | Optional title-resolution option. One of: FileName, Field. |
titleConfigurationFieldId | string | No | Field id (GUID) used to resolve the title, when titleConfigurationOption is "Field". |
titleConfigurationShowExtension | boolean | No | When true, the file extension is included in the title, when titleConfigurationOption is "FileName". |
registeredFieldIds | array of string | No | Field ids (GUIDs) to register on this content type. |
inheritableFieldIds | array of string | No | Field ids (GUIDs) that can be inherited from the parent content type. |
defaultFileExtensions | .")] List<string> | No | Default file extensions associated with this content type, e.g. ["avi", "MP4"]. |
labels | object (map of string) | No | Multi-language labels for the name of this content type: a map of languageId (GUID) to label value. |
inheritanceConfiguration | string | No | Optional inheritance configuration. One of: None, Parent, Custom. |
inheritanceFieldId | string | No | Field id (GUID) used to resolve the parent record for inheritance, when inheritanceConfiguration is "Custom". |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new file type, exactly as the user stated it. |
kind | string | No | The kind of the file type, e.g. "Image", "Video", "Document". |
extension | string | No | The file extension associated with this file type, e.g. "PDF". |
mimeType | string | No | The MIME type associated with this file type, e.g. "application/pdf". |
engineFormat | string | No | Required (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. |
isCatalogable | boolean | No | Whether files of this type can be cataloged. Omit to use DAM's default. |
previewFormat | string | No | The preview format used for this file type, e.g. "Jpg", "None". |
previewRequired | boolean | No | Whether a preview is required for files of this type. Omit to use DAM's default. |
previewKeepDimensions | boolean | No | Whether the preview should keep the original dimensions. Omit to use DAM's default. |
supportAssetResize | boolean | No | Whether asset resize is supported for this file type. Omit to use DAM's default. |
supportAssetWatermark | boolean | No | Whether asset watermarking is supported for this file type. Omit to use DAM's default. |
preferredExtension | boolean | No | Whether this file type's extension is the preferred one for its kind. Omit to use DAM's default. |
tag | string | No | Optional custom XML tag for this file type. |
registeredFieldIds | array of string | No | Field ids (GUIDs) to register on this file type. |
registeredFieldGroupIds | array of string | No | Field group ids (GUIDs) to register on this file type. |
mediaEngines | .")] List<string> | No | Media engines used for this file type, e.g. ["Exif", "Text"]. |
previewPlayers | .")] List<string> | No | Preview render web controls used for this file type, e.g. ["Adam.PdfPreviewPlayer"]. |
labels | object (map of string) | No | Multi-language labels for the name of this file type: a map of languageId (GUID) to label value. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentTypeId | string | No | The content type id (GUID) to delete. Provide this or name, not both. |
name | string | No | The content type's name (case-insensitive, exact match). Provide this or contentTypeId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact content type. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileTypeId | string | No | The file type id (GUID) to delete. Provide this or name, not both. |
name | string | No | The file type's name (case-insensitive, exact match). Provide this or fileTypeId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact file type. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentTypeId | string | No | The content type id (GUID) to edit. Provide this or name, not both. |
name | string | No | The content type's current name (case-insensitive, exact match), used to look it up. Provide this or contentTypeId, not both. |
newName | string | No | New name for the content type. Omit to leave the name unchanged. |
purpose | string | No | New purpose/description. Omit to leave it unchanged. |
parentId | string | No | New parent content type id (GUID). Omit to leave it unchanged. |
isNoFile | boolean | No | New "no-file" setting. Omit to leave it unchanged. |
fileMode | string | No | New file mode. One of: UploadFile, NoFile, CreateFromUrl, CreateFromSmartAgent, ManagedInDam. Omit to leave it unchanged. |
titleConfigurationOption | string | No | New title-resolution option. One of: FileName, Field. Omit to leave it unchanged. |
titleConfigurationFieldId | string | No | New field id (GUID) for title resolution, when titleConfigurationOption is "Field". |
titleConfigurationShowExtension | boolean | No | New value for including the file extension in the title, when titleConfigurationOption is "FileName". |
registeredFieldIdsToAdd | array of string | No | Field ids (GUIDs) to register on this content type. |
registeredFieldIdsToRemove | array of string | No | Field ids (GUIDs) to unregister from this content type. |
inheritableFieldIdsToAdd | array of string | No | Field ids (GUIDs) to add as inheritable from the parent content type. |
inheritableFieldIdsToRemove | array of string | No | Field ids (GUIDs) to remove from the inheritable set. |
defaultFileExtensionsToAdd | .")] List<string> | No | Default file extensions to add, e.g. ["avi", "MP4"]. |
defaultFileExtensionsToRemove | array of string | No | Default file extensions to remove. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Only the languages provided are changed. |
inheritanceConfiguration | string | No | New inheritance configuration. One of: None, Parent, Custom. Omit to leave it unchanged. |
inheritanceFieldId | string | No | New field id (GUID) for inheritance resolution, when inheritanceConfiguration is "Custom". |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileTypeId | string | No | The file type id (GUID) to edit. Provide this or name, not both. |
name | string | No | The file type's current name (case-insensitive, exact match), used to look it up. Provide this or fileTypeId, not both. |
newName | string | No | New name for the file type. Omit to leave the name unchanged. |
kind | string | No | New kind. Omit to leave it unchanged. |
extension | string | No | New file extension. Omit to leave it unchanged. |
mimeType | string | No | New MIME type. Omit to leave it unchanged. |
engineFormat | string | No | New engine format. Omit to leave it unchanged. |
isCatalogable | boolean | No | New "is catalogable" setting. Omit to leave it unchanged. |
previewFormat | string | No | New preview format. Omit to leave it unchanged. |
previewRequired | boolean | No | New "preview required" setting. Omit to leave it unchanged. |
previewKeepDimensions | boolean | No | New "preview keep dimensions" setting. Omit to leave it unchanged. |
supportAssetResize | boolean | No | New "support asset resize" setting. Omit to leave it unchanged. |
supportAssetWatermark | boolean | No | New "support asset watermark" setting. Omit to leave it unchanged. |
preferredExtension | boolean | No | New "preferred extension" setting. Omit to leave it unchanged. |
tag | string | No | New custom XML tag. Omit to leave it unchanged. |
registeredFieldIdsToAdd | array of string | No | Field ids (GUIDs) to register on this file type. |
registeredFieldIdsToRemove | array of string | No | Field ids (GUIDs) to unregister from this file type. |
registeredFieldGroupIdsToAdd | array of string | No | Field group ids (GUIDs) to register on this file type. |
registeredFieldGroupIdsToRemove | array of string | No | Field group ids (GUIDs) to unregister from this file type. |
mediaEnginesToAdd | .")] List<string> | No | Media engines to add, e.g. ["Xmp"]. |
mediaEnginesToRemove | .")] List<string> | No | Media engines to remove, e.g. ["Exif", "Text"]. |
previewPlayersToAdd | array of string | No | Preview render web controls to add. |
previewPlayersToRemove | array of string | No | Preview render web controls to remove. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Omit to leave labels unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
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
| Tool | What it does |
|---|---|
create_classification | Creates a new Aprimo classification (taxonomy node). |
delete_classification | Destructive. Permanently deletes an Aprimo classification by id, leaf name, or name path. |
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. |
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. |
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. |
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. |
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. |
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. |
update_classification | Edits 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new classification, exactly as the user stated it. |
parentId | string | No | Id (GUID) of the parent classification to create this node under. Provide exactly one of parentId, parentNamePath, or isRoot=true. |
parentNamePath | string | No | Full name path of the parent classification to create this node under, e.g. "/Brands/Europe". Provide exactly one of parentId, parentNamePath, or isRoot=true. |
isRoot | boolean | No | Set true to create this as a top-level (root) classification. Provide exactly one of parentId, parentNamePath, or isRoot=true. |
identifier | string | No | Optional unique identifier string for the new classification. |
sortIndex | integer | No | Optional sort index among sibling classifications. |
sortOrder | string | No | Optional sort order for this classification's children. |
disabledInDamUi | boolean | No | Whether the classification is disabled in the DAM UI. Omit to use DAM's default. |
tag | string | No | Optional custom XML tag for the new classification. |
labels | object (map of string) | No | Multi-language labels for the name of this classification: a map of languageId (GUID) to label value. |
registeredFieldIds | array of string | No | Field ids (GUIDs) to register on this classification. |
registeredFieldGroupIds | array of string | No | Field group ids (GUIDs) to register on this classification. |
followerClassificationIds | array of string | No | Classification ids (GUIDs) to set as followers of this classification. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID) to delete. Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact classification. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
canRead | boolean (optional) | |
canClassify | boolean (optional) | |
canModify | boolean (optional) | |
canDelete | boolean (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
kind | string | |
breakInheritance | boolean (optional) | |
permissions | array of ClassificationGroupPermissionEntryPayload | |
permissions[].userGroupId | string | |
permissions[].accessRight | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
count | integer | |
items | array of ClassificationDetailPayload | |
items[].id | string | |
items[].identifier | string (optional) | |
items[].name | string | |
items[].namePath | string (optional) | |
items[].labelPath | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].sortOrder | string (optional) | |
items[].disabledInDamUi | boolean (optional) | |
items[].labels | array of ClassificationLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].registeredFieldIds | array of string | |
items[].registeredFieldGroupIds | array of string | |
items[].isRoot | boolean (optional) | |
items[].parentId | string (optional) | |
items[].hasChildren | boolean (optional) | |
items[].tag | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
kind | string | |
breakInheritance | boolean (optional) | |
permissions | array of ClassificationGroupPermissionEntryPayload | |
permissions[].userGroupId | string | |
permissions[].accessRight | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID). Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's leaf name (case-insensitive, exact match). Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's full name path. Provide exactly one of classificationId, name, or namePath. |
Returns:
| Field | Type | Description |
|---|---|---|
classificationId | string | |
kind | string | |
breakInheritance | boolean (optional) | |
permissions | array of ClassificationGroupPermissionEntryPayload | |
permissions[].userGroupId | string | |
permissions[].accessRight | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
classificationId | string | No | The classification id (GUID) to edit. Provide exactly one of classificationId, name, or namePath. |
name | string | No | The classification's current leaf name (case-insensitive, exact match), used to look it up. Provide exactly one of classificationId, name, or namePath. |
namePath | string | No | The classification's current full name path, used to look it up. Provide exactly one of classificationId, name, or namePath. |
newName | string | No | New name for the classification. Omit to leave the name unchanged. |
identifier | string | No | New unique identifier string. Omit to leave it unchanged. |
sortIndex | integer | No | New sort index among sibling classifications. Omit to leave it unchanged. |
sortOrder | string | No | New sort order for this classification's children. Omit to leave it unchanged. |
disabledInDamUi | boolean | No | New "disabled in DAM UI" setting. Omit to leave it unchanged. |
tag | string | No | New custom XML tag. Omit to leave it unchanged. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Omit to leave labels unchanged. |
registeredFieldIdsToAdd | array of string | No | Field ids (GUIDs) to register on this classification. |
registeredFieldIdsToRemove | array of string | No | Field ids (GUIDs) to unregister from this classification. |
registeredFieldGroupIdsToAdd | array of string | No | Field group ids (GUIDs) to register on this classification. |
registeredFieldGroupIdsToRemove | array of string | No | Field group ids (GUIDs) to unregister from this classification. |
followerClassificationIdsToAdd | array of string | No | Classification ids (GUIDs) to add as followers of this classification. |
followerClassificationIdsToRemove | array of string | No | Classification ids (GUIDs) to remove as followers of this classification. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Manage Languages & Translations
Can change data · 12 tools · Group ID manage-languages-translations
Needs: Read the Content Model
| Tool | What it does |
|---|---|
create_language | Creates a new Aprimo language for multi-language fields/labels. |
create_translation | Creates a new Aprimo translation under a studio/module/name key. |
delete_language | Destructive. Permanently deletes an Aprimo language by id or by name. |
delete_translation | Destructive. Permanently deletes an Aprimo translation by id or by name. |
get_language_image | Returns the image URL (plus width/height/size/extension) for an Aprimo language, by id or by name. |
get_language_synonyms | Exports the solr-formatted synonyms list for an Aprimo language, by id or by name. |
get_translation | Gets one Aprimo translation's detail (studio, module, name, custom tag, localized values, dates) by id or by name. |
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). |
list_translations | Lists the translations configured in Aprimo: studio, module, name, and dates. |
update_language | Edits an existing Aprimo language by id or by name. |
update_language_synonyms | Imports (replaces) the entire solr-formatted synonyms list for an Aprimo language, by id or by name. |
update_translation | Edits 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new language, exactly as the user stated it, e.g. "Dutch". |
culture | string | Yes | The culture code for the language, e.g. "nl-be". |
enabledForFields | boolean | No | Whether this language is enabled for field values. Omit to use DAM's default. |
enabledForUI | boolean | No | Whether this language is enabled for the user interface. Omit to use DAM's default. |
tag | string | No | Optional custom XML tag associated with the language. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
studio | string | Yes | The studio the translation belongs to, e.g. "Core". |
module | string | Yes | The module the translation belongs to, e.g. "Search". |
name | string | Yes | The name of the element being translated, exactly as the user stated it, e.g. "SaveButtonLabel". |
tag | string | No | Optional custom XML tag associated with the translation. |
localizedValues | array of DamModels.TranslationLocalizedValue | No | The localized values for the translation, one per language (languageId + value). Omit to create with no localized values yet. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
studio | string | |
module | string | |
name | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId | string | No | The language id (GUID) to delete. Provide this or name, not both. |
name | string | No | The language's name (case-insensitive, exact match). Provide this or languageId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact language. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
translationId | string | No | The translation id (GUID) to delete. Provide this or name, not both. |
name | string | No | The 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. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact translation. |
confirmedDestructive | boolean | No | Must 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:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_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:
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId | string | No | The language id (GUID). Provide this or name, not both. |
name | string | No | The language's name (case-insensitive, exact match). Provide this or languageId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
languageId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId | string | No | The language id (GUID). Provide this or name, not both. |
name | string | No | The language's name (case-insensitive, exact match). Provide this or languageId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
languageId | string | |
content | string | |
lineCount | integer |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
translationId | string | No | The translation id (GUID), from list_translations. Provide this or name, not both. |
name | string | No | The 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:
| Field | Type | Description |
|---|---|---|
id | string | |
studio | string | |
module | string | |
name | string | |
tag | string (optional) | |
localizedValues | array of TranslationLocalizedValuePayload | |
localizedValues[].languageId | string | |
localizedValues[].value | string | |
createdOn | string | |
modifiedOn | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
studio | string | Yes | The studio name for the translation, e.g. "Core". |
module | string | Yes | The module name for the translation, e.g. "Search". |
name | string | Yes | The name of the element that should be translated, e.g. "SaveButtonLabel". |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
studio | string | |
module | string | |
name | string | |
tag | string (optional) | |
localizedValues | array of TranslationLocalizedValuePayload | |
localizedValues[].languageId | string | |
localizedValues[].value | string | |
createdOn | string | |
modifiedOn | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every translation. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of TranslationPayload | |
items[].id | string | |
items[].studio | string | |
items[].module | string | |
items[].name | string | |
items[].tag | string (optional) | |
items[].localizedValues | array of TranslationLocalizedValuePayload | |
items[].localizedValues[].languageId | string | |
items[].localizedValues[].value | string | |
items[].createdOn | string | |
items[].modifiedOn | string |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId | string | No | The language id (GUID) to edit. Provide this or name, not both. |
name | string | No | The language's current name (case-insensitive, exact match), used to look it up. Provide this or languageId, not both. |
newName | string | No | New name for the language. Omit to leave the name unchanged. |
culture | string | No | New culture code, e.g. "nl-be". Omit to leave the culture unchanged. |
enabledForFields | boolean | No | New enabled-for-fields flag. Omit to leave it unchanged. |
enabledForUI | boolean | No | New enabled-for-UI flag. Omit to leave it unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (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:
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId | string | No | The language id (GUID) to edit. Provide this or name, not both. |
name | string | No | The language's current name (case-insensitive, exact match), used to look it up. Provide this or languageId, not both. |
synonymsContent | string | No | The 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:
| Field | Type | Description |
|---|---|---|
languageId | string | |
updated | boolean | |
lineCount | integer |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
translationId | string | No | The translation id (GUID) to edit. Provide this or name, not both. |
name | string | No | The 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. |
newStudio | string | No | New studio. Omit to leave the studio unchanged. |
newModule | string | No | New module. Omit to leave the module unchanged. |
newName | string | No | New name for the translation. Omit to leave the name unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
localizedValues | array of DamModels.TranslationLocalizedValue | No | The full new set of localized values (languageId + value), replacing the existing set entirely. Omit to leave localized values unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |