PM lookups
Reference data, users, groups, and roles that most other PM tool groups depend on. Enabling a PM group usually enables a group from this area too.
This area has 2 groups and 22 tools, 19 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 |
|---|---|---|---|
| Look Up PM Reference Data | Read-only | None | 10 |
| Look Up PM Users, Groups & Roles | Can change data | None | 12 |
Look Up PM Reference Data
Read-only · 10 tools (8 currently available) · Group ID look-up-pm-reference-data
Needs: no other groups.
| Tool | What it does |
|---|---|
get_active_system_type_values | Retrieves only the active values for a system type, by its name, paged, in Aprimo Marketing Operations. |
get_allowed_child_pick_list_options | Not currently available. Retrieves the allowed child pick list options for a parent pick list item, by the extended attribute's integer ID and the parent pick list item's integer ID, in Aprimo Marketing Operations. |
get_lookup_list | Retrieves a lookup list by its integer ID in Aprimo Marketing Operations. |
get_metadata | Retrieves metadata for a resource by its object name (e.g. "Activity", "Project") in Aprimo Marketing Operations -- field definitions, data types, and lookup/selection-list bindings. |
get_metadata_for_groups | Retrieves metadata for the group resource in Aprimo Marketing Operations (field definitions, data types, and lookup/selection-list bindings). |
get_pick_list_options | Not currently available. Retrieves the pick list options for an extended attribute, by the attribute's integer ID, in Aprimo Marketing Operations. |
get_selection_list | Retrieves a selection list by name in Aprimo Marketing Operations (e.g. "ActivityTypeList"). |
get_system_type_value | Retrieves a single value for a system type, by the system type's name and the value's integer ID, in Aprimo Marketing Operations. |
get_system_type_values | Retrieves the values for a system type, by its name, paged, in Aprimo Marketing Operations. |
list_system_types | Lists all system types (name + API endpoint) in Aprimo Marketing Operations. |
get_active_system_type_values
Retrieves only the active values for a system type, by its name, paged, in Aprimo Marketing Operations. Use get_system_type_values to see all values (active and inactive).
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
systemType | string | Yes | The system type's name (e.g. "Country"). |
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 |
|---|---|---|
systemType | string (optional) | The system type's name (echoes the caller's parameter). |
totalRecords | integer | Total record count across all pages. |
count | integer | Number of items returned in this page (precomputed for the llm). |
items | array of SystemTypeValueProjection | The values for this page. |
items[].systemTypeId | integer | The value's integer identifier. |
items[].resourceId | string (optional) | Resource-bundle key for the value's display label. |
items[].description | string (optional) | The value's description. |
items[].activeFlag | integer | The active flag (PM wires this as an integer, not a bool). |
items[].sequence | integer (optional) | Sort sequence, when set. |
get_allowed_child_pick_list_options
Not currently available
Retrieves the allowed child pick list options for a parent pick list item, by the extended attribute's integer ID and the parent pick list item's 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 |
|---|---|---|---|
eaId | string | Yes | The parent extended attribute's integer ID. |
parentPicklistItemId | string | Yes | The parent pick list item's integer ID. |
filter | string | No | Optional text used to filter the child pick list options. Omit for the full list. |
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). |
childValue | integer | No | Optional currently selected child list item value. |
Returns:
| Field | Type | Description |
|---|---|---|
listName | string (optional) | The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one). |
description | string (optional) | The list's description, when present. |
count | integer | Number of items (precomputed for the llm). |
items | array of SelectionListItemProjection | The list's items. |
items[].itemId | integer | The item's integer value (PM's itemId). |
items[].resourceId | string (optional) | Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it). |
items[].displayValue | string (optional) | Display value identifier. |
items[].sequence | integer (optional) | Sort sequence, when set. |
items[].active | boolean | Whether this item is active. |
items[].systemName | string (optional) | Optional system (code) name for this item. |
items[].color | string (optional) | Optional css color for this item. |
get_lookup_list
Retrieves a lookup list 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 |
|---|---|---|---|
lookupId | string | Yes | The lookup list's integer ID. |
subListId | integer | No | Optional integer ID of a sub-list to retrieve. Default 0 (the top-level list). |
filterText | string | No | Optional text used to filter the lookup entries. Omit for the full list. |
Returns:
| Field | Type | Description |
|---|---|---|
lookupId | integer | The lookup list's integer identifier (echoes the caller's parameter). |
description | string (optional) | The lookup list's description, if any. |
count | integer | Number of items (precomputed for the llm; PM's own count field is also captured here, so the two should agree). |
items | array of LookupListItemProjection | The lookup list's items. |
items[].key | integer | The item's integer key. |
items[].value | string (optional) | The item's display value. |
items[].sequence | integer (optional) | Sort sequence, when set. |
items[].active | boolean | Whether this item is active. |
get_metadata
Retrieves metadata for a resource by its object name (e.g. "Activity", "Project") in Aprimo Marketing Operations -- field definitions, data types, and lookup/selection-list bindings. Not the groups variant (use get_metadata_for_groups for that).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | The resource's object name (e.g. "Activity", "Project", "activity-forecast"). |
Returns:
| Field | Type | Description |
|---|---|---|
objectName | string (optional) | The name of the resource this metadata describes. |
supportsEAs | boolean | Whether this object supports extended attributes. |
supportsSecureEAs | boolean | Whether this object supports secure extended attributes. |
nameResourceId | string (optional) | Resource id for this resource's display name. |
contentType | string (optional) | The mime type returned by the API for this resource, if any. |
fieldCount | integer | Number of fields (precomputed for the llm). |
fields | array of FieldMetadataProjection | This resource's fields, flattened to their scalar properties. |
fields[].fieldName | string (optional) | The field's name. |
fields[].titleResourceId | string (optional) | Resource-bundle key for the field's display label. |
fields[].fieldDataType | integer | The field's data type (PM's MetadataDataType enum, wired as an integer code). |
fields[].lookupListId | integer (optional) | The lookup list id used by this field, if any. |
fields[].attributeHelpTextId | string (optional) | Resource id for this field's attribute help text, if any. |
fields[].timeValueType | integer | How a DateTime value on this field should be interpreted (PM's TimeConversionMethod enum, wired as an integer code). |
fields[].amsAttributeId | integer (optional) | The ams attribute id used to identify this field, if any. |
fields[].isSecure | boolean | Whether this field has its own security controls. |
fields[].isReadOnly | boolean | Whether this field is read-only during an update. |
fields[].allowInitialValue | boolean | Whether this field can be set during creation. |
fields[].inactive | boolean | Whether this field is inactive. |
fields[].selectionListName | string (optional) | The name of the selection list backing this field, if any. |
fields[].entityFieldName | string (optional) | The corresponding field name on the entity. |
fields[].systemTypeName | string (optional) | The system type name used when accessing the system-type API for this field, if any. |
fields[].parentName | string (optional) | The name of the parent resource, if any. |
fields[].parentFieldName | string (optional) | The name of the parent field for a pick-list relationship, if any. |
fields[].parentFieldType | integer (optional) | The parent field type (PM's MetadataFieldType enum, wired as an integer code), if any. |
fields[].fieldType | integer | The metadata field type (PM's MetadataFieldType enum, wired as an integer code). |
fields[].defaultValue | string (optional) | The field's default value, if any. |
fields[].tabSequence | integer | The tab sequence identifier. |
raw | object (optional) | /// The full, untouched data object -- preserves the nested sub-structures (validation rules, value-manipulation rules, valid values, lookup values, child objects, EA sections) that doesn't flatten, same "Raw" precedent as AssociatedActivitiesResponse. |
get_metadata_for_groups
Retrieves metadata for the group resource in Aprimo Marketing Operations (field definitions, data types, and lookup/selection-list bindings). Deprecated on PM's side in favor of get_metadata with resourceName "groups" but retained for backward compatibility.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
objectName | string (optional) | The name of the resource this metadata describes. |
supportsEAs | boolean | Whether this object supports extended attributes. |
supportsSecureEAs | boolean | Whether this object supports secure extended attributes. |
nameResourceId | string (optional) | Resource id for this resource's display name. |
contentType | string (optional) | The mime type returned by the API for this resource, if any. |
fieldCount | integer | Number of fields (precomputed for the llm). |
fields | array of FieldMetadataProjection | This resource's fields, flattened to their scalar properties. |
fields[].fieldName | string (optional) | The field's name. |
fields[].titleResourceId | string (optional) | Resource-bundle key for the field's display label. |
fields[].fieldDataType | integer | The field's data type (PM's MetadataDataType enum, wired as an integer code). |
fields[].lookupListId | integer (optional) | The lookup list id used by this field, if any. |
fields[].attributeHelpTextId | string (optional) | Resource id for this field's attribute help text, if any. |
fields[].timeValueType | integer | How a DateTime value on this field should be interpreted (PM's TimeConversionMethod enum, wired as an integer code). |
fields[].amsAttributeId | integer (optional) | The ams attribute id used to identify this field, if any. |
fields[].isSecure | boolean | Whether this field has its own security controls. |
fields[].isReadOnly | boolean | Whether this field is read-only during an update. |
fields[].allowInitialValue | boolean | Whether this field can be set during creation. |
fields[].inactive | boolean | Whether this field is inactive. |
fields[].selectionListName | string (optional) | The name of the selection list backing this field, if any. |
fields[].entityFieldName | string (optional) | The corresponding field name on the entity. |
fields[].systemTypeName | string (optional) | The system type name used when accessing the system-type API for this field, if any. |
fields[].parentName | string (optional) | The name of the parent resource, if any. |
fields[].parentFieldName | string (optional) | The name of the parent field for a pick-list relationship, if any. |
fields[].parentFieldType | integer (optional) | The parent field type (PM's MetadataFieldType enum, wired as an integer code), if any. |
fields[].fieldType | integer | The metadata field type (PM's MetadataFieldType enum, wired as an integer code). |
fields[].defaultValue | string (optional) | The field's default value, if any. |
fields[].tabSequence | integer | The tab sequence identifier. |
raw | object (optional) | /// The full, untouched data object -- preserves the nested sub-structures (validation rules, value-manipulation rules, valid values, lookup values, child objects, EA sections) that doesn't flatten, same "Raw" precedent as AssociatedActivitiesResponse. |
get_pick_list_options
Not currently available
Retrieves the pick list options for an extended attribute, by the attribute's 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 |
|---|---|---|---|
eaId | string | Yes | The extended attribute's integer ID. |
filter | string | No | Optional text used to filter the pick list options. Omit for the full list. |
Returns:
| Field | Type | Description |
|---|---|---|
listName | string (optional) | The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one). |
description | string (optional) | The list's description, when present. |
count | integer | Number of items (precomputed for the llm). |
items | array of SelectionListItemProjection | The list's items. |
items[].itemId | integer | The item's integer value (PM's itemId). |
items[].resourceId | string (optional) | Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it). |
items[].displayValue | string (optional) | Display value identifier. |
items[].sequence | integer (optional) | Sort sequence, when set. |
items[].active | boolean | Whether this item is active. |
items[].systemName | string (optional) | Optional system (code) name for this item. |
items[].color | string (optional) | Optional css color for this item. |
get_selection_list
Retrieves a selection list by name in Aprimo Marketing Operations (e.g. "ActivityTypeList").
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
selectionListName | string | Yes | The selection list's name (e.g. "ActivityTypeList") -- a bare string, not numeric. |
parentValue | integer | No | Optional parent list item value used to filter dependent list items. Omit for the full list. |
filter | string | No | Optional text used to filter the selection list items. Omit for the full list. |
Returns:
| Field | Type | Description |
|---|---|---|
listName | string (optional) | The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one). |
description | string (optional) | The list's description, when present. |
count | integer | Number of items (precomputed for the llm). |
items | array of SelectionListItemProjection | The list's items. |
items[].itemId | integer | The item's integer value (PM's itemId). |
items[].resourceId | string (optional) | Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it). |
items[].displayValue | string (optional) | Display value identifier. |
items[].sequence | integer (optional) | Sort sequence, when set. |
items[].active | boolean | Whether this item is active. |
items[].systemName | string (optional) | Optional system (code) name for this item. |
items[].color | string (optional) | Optional css color for this item. |
get_system_type_value
Retrieves a single value for a system type, by the system type's name and the value's 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 |
|---|---|---|---|
systemType | string | Yes | The system type's name (e.g. "Country"). |
systemTypeId | string | Yes | The value's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
systemType | string (optional) | The system type's name (echoes the caller's parameter). |
systemTypeId | integer | The requested value's integer identifier (echoes the caller's parameter). |
items | array of SystemTypeValueProjection | The matching value(s) -- normally 0 or 1 entries. |
items[].systemTypeId | integer | The value's integer identifier. |
items[].resourceId | string (optional) | Resource-bundle key for the value's display label. |
items[].description | string (optional) | The value's description. |
items[].activeFlag | integer | The active flag (PM wires this as an integer, not a bool). |
items[].sequence | integer (optional) | Sort sequence, when set. |
get_system_type_values
Retrieves the values for a system type, by its name, paged, in Aprimo Marketing Operations. Use get_active_system_type_values to only see active values.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
systemType | string | Yes | The system type's name (e.g. "Country"). |
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 |
|---|---|---|
systemType | string (optional) | The system type's name (echoes the caller's parameter). |
totalRecords | integer | Total record count across all pages. |
count | integer | Number of items returned in this page (precomputed for the llm). |
items | array of SystemTypeValueProjection | The values for this page. |
items[].systemTypeId | integer | The value's integer identifier. |
items[].resourceId | string (optional) | Resource-bundle key for the value's display label. |
items[].description | string (optional) | The value's description. |
items[].activeFlag | integer | The active flag (PM wires this as an integer, not a bool). |
items[].sequence | integer (optional) | Sort sequence, when set. |
list_system_types
Lists all system types (name + API endpoint) in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | Number of system types (precomputed for the llm). |
items | array of SystemTypeSummaryProjection | The system types. |
items[].systemTypeName | string (optional) | The system type's name. |
items[].uri | string (optional) | The API endpoint for this system type. |
Look Up PM Users, Groups & Roles
Can change data · 12 tools (11 currently available) · Group ID look-up-pm-users-groups
Needs: no other groups.
| Tool | What it does |
|---|---|
get_current_pm_user | Returns the calling user's own profile in Aprimo Marketing Operations. |
get_my_region_preferences | Returns the calling user's region and language preferences (locale, language, date/time/number formats, timezone, currency, paper size, theme) in Aprimo Marketing Operations. |
get_pm_group | Returns a single group by id in Aprimo Marketing Operations. |
get_pm_group_membership | Not currently available. Lists the member users of a group by its integer ID in Aprimo Marketing Operations, paged. |
get_pm_user | Returns a single user by id in Aprimo Marketing Operations. |
get_user_role | Returns a single user role by id in Aprimo Marketing Operations, including who last modified it. |
list_domain_rights | Lists domain rights configured in Aprimo Marketing Operations, paged. |
list_pm_groups | Lists groups in Aprimo Marketing Operations, paged and unfiltered. |
list_user_roles | Lists user roles in Aprimo Marketing Operations, paged. |
search_pm_groups | Searches groups in Aprimo Marketing Operations by name, paged. |
search_pm_users | Searches users in Aprimo Marketing Operations by name, paged. |
update_my_region_preferences | Updates the calling user's region and language preferences in Aprimo Marketing Operations. |
get_current_pm_user
Returns the calling user's own profile in Aprimo Marketing Operations. Use when the user asks about "my account"/"my profile"/"who am I".
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess. |
name | string (optional) | Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known. |
rights | array of UserRightProjection (optional) | /// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it. |
rights[].functionId | integer | Same numbering space as api's UserRightsEnum (e.g. ProgramView = 15). |
rights[].functionName | string (optional) | |
rights[].domainId | integer | |
raw | object (optional) | The complete wire object, verbatim -- see the class remarks. |
get_my_region_preferences
Returns the calling user's region and language preferences (locale, language, date/time/number formats, timezone, currency, paper size, theme) in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
localeId | integer | |
languageId | integer | |
dateFormat | integer | |
adamUiLanguage | string (optional) | |
timeFormat | integer | |
adamContentLanguage | string (optional) | |
numberFormatId | integer | |
timezoneId | integer (optional) | |
currencyCode | integer | |
paperSize | integer | |
autoSave | integer (optional) | |
themeId | integer (optional) |
get_pm_group
Returns a single group by id in Aprimo Marketing Operations. Not a specific membership (use get_pm_group_membership for that).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Alternatively, identify the group by name instead of groupId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
groupId | string | No | The group's id. Provide either groupId or name, not both. |
name | string | No | The group's name. Provide either groupId or name, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize. |
name | string (optional) | From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs). |
raw | object (optional) |
get_pm_group_membership
Not currently available
Lists the member users of a group by its integer ID in Aprimo Marketing Operations, paged. Resolves each member's user name.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
groupId | string | Yes | The group's integer ID. |
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 GroupMembershipItemProjection | The items returned in this response. |
items[].userId | integer | |
items[].userName | string (optional) |
get_pm_user
Returns a single user by 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 |
|---|---|---|---|
userId | string | Yes | The user's id. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess. |
name | string (optional) | Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known. |
rights | array of UserRightProjection (optional) | /// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it. |
rights[].functionId | integer | Same numbering space as api's UserRightsEnum (e.g. ProgramView = 15). |
rights[].functionName | string (optional) | |
rights[].domainId | integer | |
raw | object (optional) | The complete wire object, verbatim -- see the class remarks. |
get_user_role
Returns a single user role by id in Aprimo Marketing Operations, including who last modified it.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Alternatively, identify the role by name instead of roleId. Note: resolving by name scans the full role list.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
roleId | string | No | The role's id. Provide either roleId or name, not both. |
name | string | No | The role's name. Provide either roleId or name, not both. |
excludeInactiveUser | boolean | No | If true, excludes inactive users from the role's membership count. Defaults to false. |
Returns:
| Field | Type | Description |
|---|---|---|
roleId | integer | |
name | string (optional) | |
description | string (optional) | |
activeFlag | boolean (optional) | |
color | string (optional) | |
currencyCode | integer (optional) | |
usedInAnnotations | boolean (optional) | |
modifiedUserId | integer (optional) | |
modifiedUserName | string (optional) | |
modifiedDate | string (optional) | |
laborRateEntered | number (optional) | Gets or sets the LaborRateEntered. Confirmed against the now-real UserRole component schema (wave-10 field list was incomplete) -- added here, was previously missing entirely. |
laborRateBase | number (optional) | Gets or sets the LaborRateBase. Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
excludeFromChatboards | boolean (optional) | Flag indicating whether the role excludes its users from the chatboard, wired as a 0/1 int (same convention as /). Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
list_domain_rights
Lists domain rights configured in Aprimo Marketing Operations, paged.
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 RightProjection | The items returned in this response. |
items[].functionID | integer | The function id -- same numbering space as api's UserRightsEnum/ (e.g. ProgramView = 15). Wire key is functionID (capitalized "ID", not the camelCase-policy-default functionId). |
items[].name | string (optional) | |
items[].description | string (optional) |
list_pm_groups
Lists groups in Aprimo Marketing Operations, paged and unfiltered. Use search_pm_groups when you need to filter by name; use this to browse.
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 GroupProjection | The items returned in this response. |
items[].id | string (optional) | The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize. |
items[].name | string (optional) | From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs). |
items[].raw | object (optional) |
list_user_roles
Lists user roles in Aprimo Marketing Operations, paged. Resolves who last modified each role.
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 (default 'RoleId'). 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 UserRoleProjection | The items returned in this response. |
items[].roleId | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].activeFlag | boolean (optional) | |
items[].color | string (optional) | |
items[].currencyCode | integer (optional) | |
items[].usedInAnnotations | boolean (optional) | |
items[].modifiedUserId | integer (optional) | |
items[].modifiedUserName | string (optional) | |
items[].modifiedDate | string (optional) | |
items[].laborRateEntered | number (optional) | Gets or sets the LaborRateEntered. Confirmed against the now-real UserRole component schema (wave-10 field list was incomplete) -- added here, was previously missing entirely. |
items[].laborRateBase | number (optional) | Gets or sets the LaborRateBase. Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
items[].excludeFromChatboards | boolean (optional) | Flag indicating whether the role excludes its users from the chatboard, wired as a 0/1 int (same convention as /). Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
search_pm_groups
Searches groups in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the group's name. Omit to match all groups. |
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 GroupProjection | The items returned in this response. |
items[].id | string (optional) | The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize. |
items[].name | string (optional) | From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs). |
items[].raw | object (optional) |
search_pm_users
Searches users in Aprimo Marketing Operations by name, paged. A nameFilter is required -- PM has no match-all query for this endpoint.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Required case-insensitive substring filter on the user's name -- PM has no match-all query for this endpoint, so this cannot be omitted. |
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 UserProjection | The items returned in this response. |
items[].id | string (optional) | The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess. |
items[].name | string (optional) | Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known. |
items[].rights | array of UserRightProjection (optional) | /// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it. |
items[].rights[].functionId | integer | Same numbering space as api's UserRightsEnum (e.g. ProgramView = 15). |
items[].rights[].functionName | string (optional) | |
items[].rights[].domainId | integer | |
items[].raw | object (optional) | The complete wire object, verbatim -- see the class remarks. |
update_my_region_preferences
Updates the calling user's region and language preferences in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated preferences.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the fields to change (PM wire names, e.g. localeId/languageId/timezoneId/currencyCode). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
localeId | integer | |
languageId | integer | |
dateFormat | integer | |
adamUiLanguage | string (optional) | |
timeFormat | integer | |
adamContentLanguage | string (optional) | |
numberFormatId | integer | |
timezoneId | integer (optional) | |
currencyCode | integer | |
paperSize | integer | |
autoSave | integer (optional) | |
themeId | integer (optional) |