System administration
Configure DAM system settings and run administrative operations such as index rebuilds and integration log review.
This area has 2 groups and 28 tools, 25 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 DAM System Settings | Can change data | None | 13 |
| Administer & Monitor the DAM System | Can change data | None | 15 |
Configure DAM System Settings
Can change data · 13 tools · Group ID configure-dam-system-settings
Needs: no other groups.
| Tool | What it does |
|---|---|
create_setting_category | Creates a new Aprimo setting category. |
create_setting_definition | Creates a new Aprimo setting definition. |
delete_setting_category | Destructive. Permanently deletes an Aprimo setting category by id or by name. |
delete_setting_definition | Destructive. Permanently deletes an Aprimo setting definition by id or by name. |
get_setting | Gets one Aprimo setting's current value by its exact name (e.g. ".defaultRecordTitleField"). |
get_setting_category | Gets one Aprimo setting category's detail (labels, tag, dates) by id or by name. |
get_setting_definition | Gets one Aprimo setting definition's detail (data type, category, access flags, labels) by id or by name. |
list_setting_categories | Lists the setting categories configured in Aprimo — named groupings used to organize related system settings for display (e.g. in Config Studio). |
list_setting_definitions | Lists the setting definitions configured in Aprimo — the schema (name, data type, category) of each system setting. |
list_settings | Lists Aprimo settings by name. |
update_setting | Sets the value of an existing Aprimo setting by its exact name, at a specific scope (site/system/user/user group). |
update_setting_category | Edits an existing Aprimo setting category by id or by name. |
update_setting_definition | Edits an existing Aprimo setting definition by id or by name. |
create_setting_category
Creates a new Aprimo setting category. This modifies data. Always confirm the name with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new setting category, exactly as the user stated it. |
labels | object (map of string) | No | Multi-language labels for the name of this setting category: a map of languageId (GUID) to label value. |
tag | string | No | Optional free-form tag for this setting category. Must be valid XML if provided. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
create_setting_definition
Creates a new Aprimo setting definition. This modifies data. Always confirm the name, data type, and category with the user before calling this tool. Confirmed live against the tenant: DAM rejects a name containing spaces or a leading decimal point, and a name with any non-alphanumeric character ("The name of a setting should only contain alphanumeric characters, should not start with a decimal point and spaces are not allowed.") -- use a PascalCase-style name with no spaces/ punctuation. DAM also rejects a definition with no access-control flag set at all ("you need to specify at least one access control") -- set at least one of allowAnonymousAccess/allowSystemSetting/allowSiteSetting/allowUserSetting to true.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new setting definition. DAM requires alphanumeric characters only -- no spaces, no punctuation, and it must not start with a decimal point. |
dataType | string | Yes | The setting's data type. One of: text, boolean, numeric, datetime, xml, role, reference, encryptedtext. |
categoryId | string | Yes | The id (GUID) of the setting category this definition belongs to. |
allowAnonymousAccess | boolean | No | When true, this setting can be read without authentication. Defaults to false. |
allowSystemSetting | boolean | No | When true, this setting can be configured at the system level. |
allowSiteSetting | boolean | No | When true, this setting can be configured at the site level. |
allowUserSetting | boolean | No | When true, this setting can be configured per user. |
roleRequiredForChange | string | No | Optional name of the role required to change settings of this definition. |
labels | object (map of string) | No | Multi-language labels for the name of this setting definition: a map of languageId (GUID) to label value. |
tag | string | No | Optional free-form tag for this setting definition. Must be valid XML if provided. |
helpUrl | string | No | Optional URL to help documentation for this setting definition. |
userGroupSettingMode | string | No | Optional algorithm for computing the effective value across user-group settings. One of: None, MaximumValue, MinimumValue, Manual, FirstValue. |
defaultValue | string | No | Optional default value for this setting definition, as a plain string. For dataType 'boolean' provide "true"/"false"; for 'numeric' provide a whole number — both are sent to Aprimo as their native JSON type, not a quoted string. Every other dataType (including 'datetime', as an ISO-8601 string) is sent as-is. |
regularExpression | string | No | Optional regular expression used to validate the value (text/encryptedtext data types). |
range | string | No | Optional range of allowed values, e.g. "1-255" (numeric data type). |
schema | string | No | Optional schema used to validate the value (xml data type). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_setting_category
Destructive
Permanently deletes an Aprimo setting category by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact setting category with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingCategoryId | string | No | The setting category id (GUID) to delete. Provide this or name, not both. |
name | string | No | The setting category's exact name (case-insensitive). Provide this or settingCategoryId, 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 setting category. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a setting category is permanent and cannot be undone. Set only after stating the exact setting category 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_setting_definition
Destructive
Permanently deletes an Aprimo setting definition by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact setting definition with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingDefinitionId | string | No | The setting definition id (GUID) to delete. Provide this or name, not both. |
name | string | No | The setting definition's exact name (case-insensitive). Provide this or settingDefinitionId, 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 setting definition. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a setting definition is permanent and cannot be undone. Set only after stating the exact setting definition 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_setting
Gets one Aprimo setting's current value by its exact name (e.g. ".defaultRecordTitleField"). Not its category (get_setting_category) or its definition/schema (get_setting_definition). Optionally reads it at a specific scope (site/system/user/user group) rather than the caller's own effective value.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingName | string | Yes | The setting's exact name, e.g. ".defaultRecordTitleField". |
scope | string | No | Optional scope to read the setting at. One of: Site, System, User, UserGroup. Omit to read the caller's own effective value. |
scopeId | string | No | The id (GUID) of the entity the scope applies to (e.g. a user group id when scope is UserGroup). Required together with scope, when scope needs one. |
Returns:
| Field | Type | Description |
|---|---|---|
name | string | |
value | string (optional) |
get_setting_category
Gets one Aprimo setting category's detail (labels, tag, dates) by id or by name. Use after list_setting_categories, or directly when the user names the category.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingCategoryId | string | No | The setting category id (GUID). Provide this or name, not both. |
name | string | No | The setting category's exact name (case-insensitive). Provide this or settingCategoryId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
labels | array of SettingLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
tag | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_setting_definition
Gets one Aprimo setting definition's detail (data type, category, access flags, labels) by id or by name. Use after list_setting_definitions, or directly when the user names the definition.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingDefinitionId | string | No | The setting definition id (GUID). Provide this or name, not both. |
name | string | No | The setting definition's exact name (case-insensitive). Provide this or settingDefinitionId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
dataType | string (optional) | |
categoryId | string (optional) | |
helpUrl | string (optional) | |
userGroupSettingMode | string (optional) | |
labels | array of SettingLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string | |
allowSystemSetting | boolean (optional) | |
allowUserSetting | boolean (optional) | |
roleRequiredForChange | string (optional) | |
defaultValue | object (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
list_setting_categories
Lists the setting categories configured in Aprimo — named groupings used to organize related system settings for display (e.g. in Config Studio). Use when the user asks what setting categories exist, or to look up a category's id/exact name before calling get_setting_category, update_setting_category, or delete_setting_category by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every setting category. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of SettingCategoryPayload | |
items[].id | string | |
items[].name | string | |
items[].labels | array of SettingLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].tag | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_setting_definitions
Lists the setting definitions configured in Aprimo — the schema (name, data type, category) of each system setting. Use when the user asks what setting definitions exist, or to look up a definition's id/exact name before calling get_setting_definition, update_setting_definition, or delete_setting_definition by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every setting definition. |
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 SettingDefinitionPayload | |
items[].id | string | |
items[].name | string | |
items[].dataType | string (optional) | |
items[].categoryId | string (optional) | |
items[].helpUrl | string (optional) | |
items[].userGroupSettingMode | string (optional) | |
items[].labels | array of SettingLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].allowSystemSetting | boolean (optional) | |
items[].allowUserSetting | boolean (optional) | |
items[].roleRequiredForChange | string (optional) | |
items[].defaultValue | object (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_settings
Lists Aprimo settings by name. Only settings the caller may see are returned (DAM's own allowlist/whitelist mechanism silently omits the rest — this never fails with an error for that reason). Provide exact setting names (e.g. ".defaultRecordTitleField") — there is no browse-all or partial-match query for settings.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
names | . Required — the endpoint has no browse-all for settings and 400s if this is omitted or empty.")] List<string> | Yes | Exact setting names to fetch, e.g. [".recordFieldViewList", ".userFieldViewList"]. Required — the endpoint has no browse-all for settings and 400s if this is omitted or empty. |
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 SettingPayload | |
items[].name | string | |
items[].value | string (optional) |
update_setting
Sets the value of an existing Aprimo setting by its exact name, at a specific scope (site/system/user/user group). This modifies data. Always confirm the exact setting name, scope, and new value with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingName | string | Yes | The setting's exact name to update, e.g. ".defaultRecordTitleField". |
value | string | Yes | The new value for this setting, exactly as the user stated it. |
scope | string | Yes | Scope to set the setting at. One of: Site, System, User, UserGroup. Required -- the endpoint has no caller-default scope and 400s with "The setting's scope property should be set." if this is omitted. |
scopeId | string | No | The id (GUID) of the entity the scope applies to (e.g. a user group id when scope is UserGroup). Required together with scope, when scope needs one. |
Returns:
| Field | Type | Description |
|---|---|---|
name | string | |
value | string | |
scope | string (optional) | |
scopeId | string (optional) |
update_setting_category
Edits an existing Aprimo setting category by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact setting category and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingCategoryId | string | No | The setting category id (GUID) to edit. Provide this or name, not both. |
name | string | No | The setting category's current name (case-insensitive), used to look it up. Provide this or settingCategoryId, not both. |
newName | string | No | New name for the setting category. Omit to leave the name 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. |
tag | string | No | New free-form tag. Must be valid XML if provided. Omit to leave it unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
update_setting_definition
Edits an existing Aprimo setting 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 setting definition and the new values with the user before calling this tool. Note: the data type cannot be changed after creation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
settingDefinitionId | string | No | The setting definition id (GUID) to edit. Provide this or name, not both. |
name | string | No | The setting definition's current name (case-insensitive), used to look it up. Provide this or settingDefinitionId, not both. |
newName | string | No | New name for the setting definition. Omit to leave the name unchanged. |
categoryId | string | No | New setting category id (GUID). Omit to leave it unchanged. |
defaultValue | string | No | New default value (as a plain string). Omit to leave it unchanged. |
regularExpression | string | No | New regular expression used to validate the value. Omit to leave it unchanged. |
range | string | No | New range of allowed values, e.g. "1-255". Omit to leave it unchanged. |
schema | string | No | New schema used to validate the value. 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. |
allowSystemSetting | boolean | No | New value for whether this setting can be configured at the system level. Omit to leave it unchanged. |
allowUserSetting | boolean | No | New value for whether this setting can be configured per user. Omit to leave it unchanged. |
roleRequiredForChange | string | No | New name of the role required to change settings of this definition. Omit to leave it unchanged. |
userGroupSettingMode | string | No | New algorithm for computing the effective value across user-group settings. One of: None, MaximumValue, MinimumValue, Manual, FirstValue. Omit to leave it unchanged. |
helpUrl | string | No | New URL to help documentation. Omit to leave it unchanged. |
tag | string | No | New free-form tag. Must be valid XML if provided. Omit to leave it unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Administer & Monitor the DAM System
Can change data · 15 tools (12 currently available) · Group ID administer-monitor-the-dam-system
Needs: no other groups.
| Tool | What it does |
|---|---|
fill_fda_form | Not currently available. Fills the FDA 2253 form from submitted field data in Aprimo Marketing Operations. |
get_content_security_policy | Gets the Content Security Policy domain allowlist for this Aprimo DAM location. |
get_dam_version_info | Not currently available. Gets the currently active Aprimo DAM release/version number. |
get_integration_log | Returns a single integration log by its integer ID in Aprimo Marketing Operations. |
get_search_index_status | Gets the status of Aprimo's record/classification search index: whether a rebuild is required/currently scheduled, indexed record/classification counts, pending changes, and the last rebuild time. |
get_supported_version | Not currently available. Gets detail (documentation URI) for one supported Aprimo API version, by its exact version number. |
get_unique_key_index_status | Gets the status of Aprimo's unique-key index (enforces uniqueness for fields configured as unique keys across records and classifications): processed record/classification counts, whether reindexing is running, whether duplicates were found, and whether a rebuild is required. |
list_counters | Lists every named counter configured in Aprimo (persistent, atomically-incrementing integer sequences typically used to generate unique values, e.g. an invoice number or SKU, for a custom field): name and current value. |
list_integration_logs | Lists integration logs in Aprimo Marketing Operations, paged and sortable. |
list_solution_sets | Lists the solution sets (licensed solution modules) installed for the current tenant in Aprimo Marketing Operations. |
list_supported_versions | Lists every API version Aprimo currently supports (version number + documentation URI). |
rebuild_search_index | Triggers a rebuild of Aprimo's record/classification search index. |
rebuild_unique_key_index | Triggers a rebuild of Aprimo's unique-key index. |
search_integration_logs | Searches integration logs in Aprimo Marketing Operations with a JSON query body, paged and sortable. |
update_counter | Destructive. Sets an Aprimo counter's value, by its exact name -- DAM upserts, so a name that doesn't already exist gets created with this value. |
fill_fda_form
Not currently available
Fills the FDA 2253 form from submitted field data in Aprimo Marketing Operations. Read-only despite the POST verb -- filling/generating a form from submitted data is a query/transform operation, no PM resource is created, updated, or deleted as a side effect (same precedent as retrieve_digital_asset_dam_mapping). The request body is a raw, undocumented map of form-field names to arrays-of-arrays of values -- pass it through verbatim as a JSON object; PM declares no typed schema for this data. PM's response has no documented schema either -- the real API almost certainly streams back a filled PDF binary, which this tool cannot surface as text; it reports success and the response's byte length instead.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object mapping form-field names to arrays-of-arrays of values -- opaque, undocumented FDA form-field data (PM wire names). Pass through verbatim. |
flatten | boolean | No | Whether to flatten the resulting form (bakes filled-in field values into the page content so they can no longer be edited). Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
flatten | boolean | |
succeeded | boolean | |
responseByteLength | integer | Length, in utf-8 bytes, of the raw response body PM returned. A non-zero value alongside Succeeded=true typically indicates a filled PDF was streamed back. |
get_content_security_policy
Gets the Content Security Policy domain allowlist for this Aprimo DAM location. Tenant-wide singleton -- no parameters.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
domains | array of string |
get_dam_version_info
Not currently available
Gets the currently active Aprimo DAM release/version number. Tenant-wide singleton -- no parameters.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
releaseNumber | string (optional) |
get_integration_log
Returns a single integration log by its integer ID in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The integration log's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
get_search_index_status
Gets the status of Aprimo's record/classification search index: whether a rebuild is required/currently scheduled, indexed record/classification counts, pending changes, and the last rebuild time. Tenant-wide singleton -- no parameters. Use before deciding whether to call rebuild_search_index.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
rebuildRequired | boolean | |
rebuildScheduled | boolean | |
indexedRecords | integer | |
indexedClassifications | integer | |
pendingChanges | integer | |
lastChangeId | integer | |
lastChangeDateTime | string (optional) | |
lastIndexRebuild | string (optional) |
get_supported_version
Not currently available
Gets detail (documentation URI) for one supported Aprimo API version, by its exact version number. Use after list_supported_versions.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
version | string | Yes | The API version number to look up, e.g. "1", from list_supported_versions. |
Returns:
| Field | Type | Description |
|---|---|---|
version | string (optional) | |
documentationUri | string (optional) |
get_unique_key_index_status
Gets the status of Aprimo's unique-key index (enforces uniqueness for fields configured as unique keys across records and classifications): processed record/classification counts, whether reindexing is running, whether duplicates were found, and whether a rebuild is required. Tenant-wide singleton -- no parameters. Use before deciding whether to call rebuild_unique_key_index.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
totalProcessedRecords | integer | |
totalProcessedClassifications | integer | |
isReindexing | boolean | |
hasDuplicates | boolean | |
indexBuildRequired | boolean | |
lastTimeIndexed | string (optional) |
list_counters
Lists every named counter configured in Aprimo (persistent, atomically-incrementing integer sequences typically used to generate unique values, e.g. an invoice number or SKU, for a custom field): name and current value. Use to look up a counter's exact name before calling update_counter.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CounterPayload | |
items[].name | string (optional) | |
items[].value | integer |
list_integration_logs
Lists integration logs in Aprimo Marketing Operations, paged and sortable.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of IntegrationLogProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
list_solution_sets
Lists the solution sets (licensed solution modules) installed for the current tenant in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of SolutionSetProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
list_supported_versions
Lists every API version Aprimo currently supports (version number + documentation URI). Use to look up a version's exact number before calling get_supported_version.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of SupportedVersionPayload | |
items[].version | string (optional) | |
items[].documentationUri | string (optional) |
rebuild_search_index
Triggers a rebuild of Aprimo's record/classification search index. This modifies data (queues a resource-intensive reindex). Requires confirmed=true after confirming with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
rebuildScheduled | boolean | No | Whether to schedule the rebuild instead of running it immediately. Required -- DAM has no default for this. |
rebuildTarget | string | No | Which resource type to rebuild the index for: "Classification" or "Record". Omit to rebuild DAM's default target. |
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. |
Returns:
| Field | Type | Description |
|---|---|---|
triggered | boolean | |
rebuildScheduled | boolean (optional) | |
rebuildTarget | string (optional) |
rebuild_unique_key_index
Triggers a rebuild of Aprimo's unique-key index. This modifies data (queues a resource-intensive reindex). Requires confirmed=true after confirming with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
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. |
Returns:
| Field | Type | Description |
|---|---|---|
triggered | boolean |
search_integration_logs
Searches integration logs in Aprimo Marketing Operations with a JSON query body, paged and sortable. No resource is created or changed by this call.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | JSON object with the search query PM expects (PM query DSL). Pass "{}" for an unfiltered search. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of IntegrationLogProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
update_counter
Destructive
Sets an Aprimo counter's value, by its exact name -- DAM upserts, so a name that doesn't already exist gets created with this value. This modifies data and there is no way to delete a counter afterward. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact counter name and new value with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
counterName | string | Yes | The counter's exact name, from list_counters. |
value | integer | Yes | The new value for the counter. |
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 counter name and value. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) -- this can create a brand-new counter with no way to delete it afterward, and overwriting an existing one's value cannot be undone. Set only after stating the exact counter name and value to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
name | string | |
value | integer |
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.