Task Management
Work tasks from assignment to approval: task details and assignments, checklists and data collection forms, task documents, reviews, annotations, supporting documents, and chatboards.
This area has 8 groups and 115 tools, 68 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 |
|---|---|---|---|
| View Task Details & Assignments | Read-only | Look Up PM Users, Groups & Roles | 14 |
| Work My Tasks | Can change data | View Task Details & Assignments, Look Up PM Users, Groups & Roles | 12 |
| Fill Out Task Checklists & Data Collection Forms | Can change data | View Task Details & Assignments, Look Up PM Reference Data | 10 |
| Attach Documents & Files to Tasks | Can change data | View Task Details & Assignments, Find & Discover Content | 17 |
| Review & Approve Deliverables | Can change data | Attach Documents & Files to Tasks, Look Up PM Users, Groups & Roles | 22 |
| Annotate PM Documents | Can change data | Manage Supporting Documents | 4 |
| Manage Supporting Documents | Can change data | View Projects, View Task Details & Assignments, Look Up PM Users, Groups & Roles, Find & Discover Content | 22 |
| Collaborate in Chatboards | Can change data | Look Up PM Users, Groups & Roles | 14 |
View Task Details & Assignments
Read-only · 14 tools (12 currently available) · Group ID view-task-details-assignments
Needs: Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
get_project_tasks | Lists the tasks that belong to a Project, by the project's integer ID, in Aprimo Marketing Operations. |
get_task | Returns a single task (workflow assignment) by its integer ID from Aprimo Marketing Operations. |
get_task_assignee | Returns the current user's assignment record for the specified (non-review) task, by the task's integer ID, in Aprimo Marketing Operations. |
get_task_assignee_time_detail | Returns the time-detail record for the task assignee, by its integer ID, in Aprimo Marketing Operations. |
get_task_assignees | Returns the assignee records for a task, by the task's integer ID, in Aprimo Marketing Operations. |
get_task_link | Not currently available. Returns a single task link belonging to the specified (non-review) assignment task, in Aprimo Marketing Operations. |
get_task_time_entry | Returns a single workflow task time entry by its integer ID in Aprimo Marketing Operations. |
get_team | Returns a single workflow team by its integer ID in Aprimo Marketing Operations, including its members. |
list_task_delegation_users | Not currently available. Returns a paged list of users to whom the specified (non-review) assignment task can be delegated, by the task's integer ID, in Aprimo Marketing Operations. |
list_task_links | Lists the task links on a (non-review) assignment task, by the task's integer ID, in Aprimo Marketing Operations. |
list_tasks | Lists tasks (workflow assignments) in Aprimo Marketing Operations, paged and unfiltered. |
list_teams | Lists workflow teams in Aprimo Marketing Operations, paged, with an optional title filter. |
search_task_time_entries | Searches workflow task time entries in Aprimo Marketing Operations with a JSON query body, paged and sortable. |
search_tasks | Searches tasks (workflow assignments) in Aprimo Marketing Operations. |
get_project_tasks
Lists the tasks that belong to a Project, by the project's integer ID, in Aprimo Marketing Operations. Optionally excludes auto-close tasks. Returns totals and human-readable labels for status and users, plus the linked Activity.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link bullets.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The parent project'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 (e.g. 'ModifiedDate', 'Name'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
excludeAutoClose | boolean | No | When true, omit auto-close tasks. Default false (include all). |
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 TaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].projectId | integer | |
items[].projectTitle | string (optional) | |
items[].projectDeepLink | string (optional) | |
items[].activityId | integer (optional) | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
items[].canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
items[].canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
items[].daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
get_task
Returns a single task (workflow assignment) by its integer ID from Aprimo Marketing Operations. A task belongs to a Project, which belongs to an Activity. Returns only the base task record itself — not any task sub-resource (assignees, checklists, DCTs, documents, links, review materials, time entries, attachments, etc.), each of which has its own get_task_* tool. Resolves status, modified-by and completed-by user names, and surfaces the linked Project and Activity with deep links. Also reports whether the task can currently be closed, declined, or delegated.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim, including every (id: N) suffix.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
get_task_assignee
Returns the current user's assignment record for the specified (non-review) task, by the task's integer ID, in Aprimo Marketing Operations. Not its time detail (use get_task_assignee_time_detail for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) |
get_task_assignee_time_detail
Returns the time-detail record for the task assignee, by its integer ID, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task assignee time-detail record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted field above. |
get_task_assignees
Returns the assignee records for a task, by the task's integer ID, in Aprimo Marketing Operations. Resolves assignee user names.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of TaskAssigneeItemProjection | |
items[].assigneeId | integer | |
items[].taskId | integer | |
items[].userId | integer (optional) | |
items[].userName | string (optional) | |
items[].workStatus | integer | |
items[].canClose | boolean | |
items[].voteResult | integer (optional) | |
items[].comments | string (optional) | |
items[].assignedDate | string (optional) | |
items[].completedDate | string (optional) | |
items[].actualBeginDate | string (optional) | |
items[].actualEndDate | string (optional) | |
items[].roleId | integer (optional) | |
items[].estimatedWork | integer (optional) | Estimated work (in the task's work-unit), newly confirmed by the hardened schema. |
items[].actualWork | integer (optional) | Actual work logged so far, newly confirmed by the hardened schema. |
items[].sequence | integer (optional) | The assignee's sequence/ordering within the task, newly confirmed by the hardened schema. |
get_task_link
Not currently available
Returns a single task link belonging to the specified (non-review) assignment task, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
linkId | string | Yes | The task link'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_task_time_entry
Returns a single workflow task time entry 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 task time entry's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted field above. |
get_team
Returns a single workflow team by its integer ID in Aprimo Marketing Operations, including its members. Resolves member user names.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
teamId | string | Yes | The team's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
teamId | integer | |
name | string (optional) | |
description | string (optional) | |
members | array of TeamMemberProjection | |
members[].teamMemberId | integer | |
members[].teamId | integer | |
members[].roleId | integer (optional) | |
members[].userId | integer (optional) | |
members[].userName | string (optional) | |
members[].hasEditRight | boolean (optional) | |
members[].hasFinancialsEditRight | boolean (optional) |
list_task_delegation_users
Not currently available
Returns a paged list of users to whom the specified (non-review) assignment task can be delegated, by the task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
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 DelegationUserProjection | 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_task_links
Lists the task links on a (non-review) assignment task, by the task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
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 TaskLinkProjection | 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_tasks
Lists tasks (workflow assignments) in Aprimo Marketing Operations, paged and unfiltered. Use search_tasks when you need to filter by name, status, project, or dates; use get_project_tasks to browse the tasks of one Project; use this to browse all tasks. Returns totals and human-readable labels for status and users, plus the linked Project/Activity.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link bullets.
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 (e.g. 'ModifiedDate', 'Name'). 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 TaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].projectId | integer | |
items[].projectTitle | string (optional) | |
items[].projectDeepLink | string (optional) | |
items[].activityId | integer (optional) | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
items[].canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
items[].canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
items[].daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
list_teams
Lists workflow teams in Aprimo Marketing Operations, paged, with an optional title filter. Resolves each team's member user names.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
titleFilter | string | No | Optional case-insensitive substring filter on the team's title. Omit to match all teams. |
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 'Name'). |
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 TeamProjection | The items returned in this response. |
items[].teamId | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].members | array of TeamMemberProjection | |
items[].members[].teamMemberId | integer | |
items[].members[].teamId | integer | |
items[].members[].roleId | integer (optional) | |
items[].members[].userId | integer (optional) | |
items[].members[].userName | string (optional) | |
items[].members[].hasEditRight | boolean (optional) | |
items[].members[].hasFinancialsEditRight | boolean (optional) |
search_task_time_entries
Searches workflow task time entries 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-encoded search body using PM's operator-tree DSL -- not a flat {field: value} object. This route has no OpenAPI schema (see this class's remarks), but it shares the same underlying search engine as search_projects/search_activities, and its valid fields are confirmed from the api repo's WfTaskTimeEntriesEntity model (api repo, 2026-08-17). The body must have exactly one top-level operator. Operators (all lowercase, no separators): 'equals', 'contains', 'lessthan', 'lessthanorequalto', 'greaterthan', 'greaterthanorequalto', 'isnull', 'isnotnull', 'and', 'or', 'not'. Leaf operators take {FieldName, FieldValue} (pascal case) where FieldName is one of the 7 valid fields -- 'TimeEntryId' (int), 'AssigneeId' (int), 'ActualDate' (ISO 8601 date), 'ActualWork' (int), 'Comments' (string), 'EnteredActualWorkHours' (int), 'EnteredActualWorkMinutes' (int) -- and FieldValue is a native JSON value matching that type. No other field names are valid; there is no Extended Attributes support for this entity. Composite 'and'/'or' take an array of operations; 'not' takes a single operation object. Examples: by assignee '{"equals":{"FieldName":"AssigneeId","FieldValue":12345}}'; by date '{"equals":{"FieldName":"ActualDate","FieldValue":"2026-08-01"}}'. 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 WfTaskTimeEntryProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted field above. |
search_tasks
Searches tasks (workflow assignments) in Aprimo Marketing Operations. A task belongs to a Project, which belongs to an Activity. Returns a paged list with totals and human-readable labels for status and users, plus the linked Project/Activity with deep links. Use get_project_tasks to list the tasks of one Project; use this to query across tasks.
Response format. Items come back as pre-rendered markdown blocks intended for verbatim display, each carrying an (id: N) suffix and a deep-link bullet, with every item rendered separately.
Filtering. Prefer the name-keyed statusLabel parameter over composing the query DSL.
Query DSL. query takes a structured operator tree using PascalCase FieldName/FieldValue. By partial name: query='{"contains":{"FieldName":"Name","FieldValue":"review"}}'. By project: query='{"equals":{"FieldName":"ProjectId","FieldValue":67890}}'. To browse without a filter use list_tasks instead — an empty query='{}' is rejected.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | JSON-encoded search body using PM's operator-tree DSL — not a flat {field: value} object. Exactly one top-level operator. Operators (all lowercase): 'equals', 'contains', 'lessthan', 'lessthanorequalto', 'greaterthan', 'greaterthanorequalto', 'isnull', 'isnotnull', 'and', 'or', 'not'. Leaf operators take {FieldName, FieldValue} (pascal case) where FieldName is PM's wire field name ('TaskId', 'Name', 'ProjectId', 'ActivityId', 'WorkFlowTaskStatus', 'BeginDate', 'EndDate', etc.) and FieldValue is a native JSON value matching the field's type. Composite 'and'/'or' take an array of operations; 'not' takes a single operation object. PM rejects an empty '{}' (throws 'Couldn't find any operator') — it is not a match-all query; use list_tasks to browse without a filter. For status filtering, prefer the statusLabel parameter below. |
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 (e.g. 'ModifiedDate', 'Name'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
statusLabel | string | No | Filter to tasks with this status (label, case-insensitive). Resolved against the PM task status lookup (WorkFlowTaskStatus). Returns an error if the label doesn't match any known status. Combined with query via and. |
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 TaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].projectId | integer | |
items[].projectTitle | string (optional) | |
items[].projectDeepLink | string (optional) | |
items[].activityId | integer (optional) | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
items[].canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
items[].canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
items[].daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
Work My Tasks
Can change data · 12 tools (9 currently available) · Group ID work-my-tasks
Needs: View Task Details & Assignments, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
accept_task | Accepts a task assignment, by the task's integer ID, in Aprimo Marketing Operations. |
close_task | Not currently available. Destructive. Closes a task (workflow assignment) in Aprimo Marketing Operations. |
decline_task | Destructive. Declines a task (workflow assignment) in Aprimo Marketing Operations. |
delegate_task | Not currently available. Destructive. Delegates a task (workflow assignment) to another user in Aprimo Marketing Operations. |
update_task | Updates an existing task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
update_task_assignee | Not currently available. Updates the current user's assignment record on the specified task (for example, the time and work details from the work-entry panel), in Aprimo Marketing Operations. |
update_task_assignee_time_detail | Updates the task assignee's time-detail record, by its integer ID, in Aprimo Marketing Operations. |
update_task_begin_date | Updates the begin date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
update_task_end_date | Updates the end date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
update_task_estimated_duration | Updates the estimated duration of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
validate_task_assignee | Validates whether the current user's work on the specified task can be closed, in Aprimo Marketing Operations. |
validate_task_assignee_time_detail | Validates the supplied time-detail data for a task assignee without persisting any changes, by the record's integer ID, in Aprimo Marketing Operations. |
accept_task
Accepts a task assignment, by the task's integer ID, in Aprimo Marketing Operations. This is an additive commitment (the assignee agrees to take on the task) — not a state-ending action. Requires confirmed=true after confirming the exact task with the user. Returns the accept action's result.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to accept. |
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. |
Returns:
| Field | Type | Description |
|---|---|---|
actionId | string (optional) | |
taskId | integer | |
assigneeId | integer | |
status | integer | |
message | string (optional) |
close_task
Destructive · Not currently available
Closes a task (workflow assignment) in Aprimo Marketing Operations. This is a state change that completes the task and advances the workflow. Optionally promotes the task's annotations on close. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact task with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to close. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — closing a task changes its state and drives the workflow. Set only after stating the exact task to the user and getting explicit go-ahead. |
promoteAnnotations | boolean | No | When true, promote the task's annotations on close. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
action | string (optional) | The state-change action performed: "close", "decline", or "delegate". |
succeeded | boolean | |
delegatedToUserId | integer (optional) | For delegate_task only: the user the task was delegated to. |
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.
decline_task
Destructive
Declines a task (workflow assignment) in Aprimo Marketing Operations. This is a state change that rejects the assignment. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact task with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to decline. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — declining a task changes its state. Set only after stating the exact task to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
action | string (optional) | The state-change action performed: "close", "decline", or "delegate". |
succeeded | boolean | |
delegatedToUserId | integer (optional) | For delegate_task only: the user the task was delegated to. |
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.
delegate_task
Destructive · Not currently available
Delegates a task (workflow assignment) to another user in Aprimo Marketing Operations. This is a state change that reassigns the task. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact task and target user with the user. Returns a 409-style conflict message if the task cannot be delegated in its current state.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to delegate. |
taskAssigneeId | string | Yes | The task assignee record's integer ID (the assignment being delegated). |
newUserId | string | Yes | The integer user ID to delegate the task to. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — delegating a task reassigns it and changes its state. Set only after stating the exact task and target user to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
action | string (optional) | The state-change action performed: "close", "decline", or "delegate". |
succeeded | boolean | |
delegatedToUserId | integer (optional) | For delegate_task only: the user the task was delegated to. |
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_task
Updates an existing task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). To change a task's begin date, end date, or estimated duration, prefer the dedicated tools (update_task_begin_date / update_task_end_date / update_task_estimated_duration) — those fields are read-only on this endpoint. Requires confirmed=true after showing the user the exact changes. Returns the updated task. Note: PM's response-building step for this endpoint can fail after the write has already been committed (e.g. a pre-existing unrelated date field it can't reserialize) — if this happens, the error message includes the task's just-re-fetched current state so you can confirm whether the change actually applied before retrying, rather than assuming the update was rejected outright.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). 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 |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
update_task_assignee
Not currently available
Updates the current user's assignment record on the specified task (for example, the time and work details from the work-entry panel), in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object with the assignment record fields to update (PM wire names). |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) |
update_task_assignee_time_detail
Updates the task assignee's time-detail record, by its integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task assignee time-detail record's integer ID. |
body | string | Yes | JSON object with the time-detail fields to update (PM wire names). Confirmed shape (from the Marketing Operations UI's own request body, cross-checked against a working Postman capture -- this cluster has no OpenAPI schema, see this class's remarks): a top-level assigneeId plus a taskTimeEntries array, where each entry has timeEntryId, actualDate (ISO 8601), enteredActualWorkHours, enteredActualWorkMinutes, comments, and its own assigneeId. Example: {"assigneeId": 101, "taskTimeEntries": [{"timeEntryId": 1001, "assigneeId": 101, "actualDate": "2026-08-17", "enteredActualWorkHours": 2, "enteredActualWorkMinutes": 30, "comments": "Worked on review."}]}. A shorthand guess like {"hours": 3} will not match this shape and will fail or be silently ignored. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted field above. |
update_task_begin_date
Updates the begin date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new begin date. Returns the updated task.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object carrying the new begin date in PM wire form (e.g. {"beginDate":"2026-08-01T00:00:00Z"}). |
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 |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
update_task_end_date
Updates the end date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new end date. Returns the updated task.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object carrying the new end date in PM wire form (e.g. {"endDate":"2026-08-15T00:00:00Z"}). |
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 |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
update_task_estimated_duration
Updates the estimated duration of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new estimated duration. Returns the updated task.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object carrying the new estimated duration in PM wire form (e.g. {"estimatedDuration":480}). |
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 |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (optional) | /// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of . |
canDelegate | boolean (optional) | Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
canDecline | boolean (optional) | Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask). |
daysOverDue | integer (optional) | /// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field. |
validate_task_assignee
Validates whether the current user's work on the specified task can be closed, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
raw | object (optional) |
validate_task_assignee_time_detail
Validates the supplied time-detail data for a task assignee without persisting any changes, by the record'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 |
|---|---|---|---|
id | string | Yes | The task assignee time-detail record's integer ID. |
body | string | Yes | JSON object with the time-detail data to validate (PM wire names). |
Returns:
| Field | Type | Description |
|---|---|---|
raw | object (optional) |
Fill Out Task Checklists & Data Collection Forms
Can change data · 10 tools (2 currently available) · Group ID fill-out-task-checklists-data-collection-forms
Needs: View Task Details & Assignments, Look Up PM Reference Data
| Tool | What it does |
|---|---|
get_task_checklist | Not currently available. Returns a single checklist, including its checklist items, for an assignment task in Aprimo Marketing Operations. |
get_task_checklist_results | Not currently available. Returns the saved results for a checklist on a task assignment, in Aprimo Marketing Operations. |
get_task_dct | Not currently available. Returns a single data collection template (DCT) for an assignment task, including whether the current user can save it, in Aprimo Marketing Operations. |
get_task_dct_results | Not currently available. Returns the saved data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations. |
list_task_checklists | Lists the checklists on an assignment task, by the task's integer ID, in Aprimo Marketing Operations. |
list_task_dcts | Lists the data collection templates (DCTs) associated with an assignment task, by the task's integer ID, in Aprimo Marketing Operations. |
update_task_checklist_results | Not currently available. Saves the submitted results for a checklist on a task assignment, in Aprimo Marketing Operations. |
update_task_dct_results | Not currently available. Saves data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations. |
validate_task_checklist_results | Not currently available. Validates a checklist's results to determine whether the task can be closed, in Aprimo Marketing Operations. |
validate_task_dct_results | Not currently available. Validates a task assignment's data collection template (DCT) results to determine whether they meet the requirements for closing the task, in Aprimo Marketing Operations. |
get_task_checklist
Not currently available
Returns a single checklist, including its checklist items, for an assignment task in Aprimo Marketing Operations. Not its results (use get_task_checklist_results for those).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including nested checklist items, whose real shape is not part of this schema-blind cluster (see class remarks) -- for full fidelity beyond the defensively-extracted fields above. |
get_task_checklist_results
Not currently available
Returns the saved results for a checklist on a task assignment, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_task_dct
Not currently available
Returns a single data collection template (DCT) for an assignment task, including whether the current user can save it, in Aprimo Marketing Operations. Not its results (use get_task_dct_results for those).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including the unverified "can save" indicator noted in this class's remarks -- for full fidelity beyond the defensively-extracted fields above. |
get_task_dct_results
Not currently available
Returns the saved data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_task_checklists
Lists the checklists on an assignment task, by the task's integer ID, in Aprimo Marketing Operations. Limited to the checklists the current user is allowed to see.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
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 TaskChecklistProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- including nested checklist items, whose real shape is not part of this schema-blind cluster (see class remarks) -- for full fidelity beyond the defensively-extracted fields above. |
list_task_dcts
Lists the data collection templates (DCTs) associated with an assignment task, by the task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
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 TaskDctProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- including the unverified "can save" indicator noted in this class's remarks -- for full fidelity beyond the defensively-extracted fields above. |
update_task_checklist_results
Not currently available
Saves the submitted results for a checklist on a task assignment, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the saved results.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
body | string | Yes | JSON object with the checklist results to save (PM wire names). |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
update_task_dct_results
Not currently available
Saves data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the saved results.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
body | string | Yes | JSON object with the DCT result values to save (PM wire names). |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
validate_task_checklist_results
Not currently available
Validates a checklist's results to determine whether the task can be closed, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
validate_task_dct_results
Not currently available
Validates a task assignment's data collection template (DCT) results to determine whether they meet the requirements for closing the task, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
Attach Documents & Files to Tasks
Can change data · 17 tools (5 currently available) · Group ID attach-documents-files-to-tasks
Needs: View Task Details & Assignments, Find & Discover Content
| Tool | What it does |
|---|---|
associate_uploaded_document_with_task | Not currently available. Associates an uploaded document version with a task's document-upload instruction, in Aprimo Marketing Operations. |
create_task_document_attachment | Not currently available. Creates an attachment for a task document, by task ID and task-document ID, in Aprimo Marketing Operations. |
create_task_document_attachment_version | Not currently available. Creates a new version of a task document's attachment, by task ID, task-document ID, and attachment ID, in Aprimo Marketing Operations. |
create_task_document_upload | Not currently available. Creates a task document-upload requirement for a task, in Aprimo Marketing Operations. |
delete_task_document_uploaded_version | Not currently available. Destructive. Permanently deletes an uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. |
get_task_document_assets | Not currently available. Returns the asset documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. |
get_task_document_attachments | Not currently available. Returns the attachment documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. |
get_task_document_upload | Returns a single task document-upload requirement by task ID and task-document ID, in Aprimo Marketing Operations. |
get_task_document_uploaded_version | Not currently available. Returns detail for one uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. |
get_task_document_uploaded_versions | Not currently available. Lists the uploaded versions of a task document, by task ID and task-document ID, in Aprimo Marketing Operations. |
get_task_documents | Not currently available. Returns the documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations. |
get_task_supporting_attachment | Returns a single supporting (reference/background) attachment for a (non-review) task, by task ID and document ID, in Aprimo Marketing Operations. |
get_task_working_attachment | Not currently available. Returns a single working attachment document for a task, by task ID and document ID, in Aprimo Marketing Operations. |
list_task_document_uploads | Lists the document-upload requirements for a task, in Aprimo Marketing Operations. |
list_task_supporting_attachments | Lists supporting (reference/background) attachments for a (non-review) task, by the task's integer ID, in Aprimo Marketing Operations. |
list_task_working_attachments | Lists all working attachment documents for a task, in Aprimo Marketing Operations. |
update_assignment_document | Not currently available. Updates the metadata of a required document attached to a workflow task assignment, by the task-document's integer ID, in Aprimo Marketing Operations. |
associate_uploaded_document_with_task
Not currently available
Associates an uploaded document version with a task's document-upload instruction, in Aprimo Marketing Operations. Records a project audit-trail entry. No review-task route exists for this op. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. the uploaded document/version identifiers). Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the uploaded document association data (PM wire names). PM's schema declares this opaque. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
taskDocumentId | integer (optional) | |
raw | object (optional) |
create_task_document_attachment
Not currently available
Creates an attachment for a task document, by task ID and task-document ID, in Aprimo Marketing Operations. No review-task route exists for this op. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload. Resolves modified-by/creator user names.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the attachment data (PM wire names). PM's schema declares this opaque. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
attachmentId | integer | |
title | string (optional) | |
description | string (optional) | |
objectId | integer | |
objectTypeId | integer | |
attachmentTypeId | integer (optional) | |
attachmentType | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
modifiedDate | string (optional) | |
creatorId | integer (optional) | |
creatorName | string (optional) | |
documentId | integer | |
documentName | string (optional) | |
documentType | string (optional) | |
isDocumentDamAsset | boolean (optional) | |
damRecordId | string (optional) | |
isReferenceDocument | boolean |
create_task_document_attachment_version
Not currently available
Creates a new version of a task document's attachment, by task ID, task-document ID, and attachment ID, in Aprimo Marketing Operations. No review-task route exists for this op. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload. Resolves modified-by/creator user names.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
attachmentId | string | Yes | The attachment's integer ID. |
body | string | Yes | JSON object with the attachment version data (PM wire names). PM's schema declares this opaque. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
versionId | integer | |
isDefaultVersion | boolean | |
attachmentId | integer | |
filename | string (optional) | |
extension | string (optional) | |
downloadUri | string (optional) | |
thumbnailUri | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
modifiedDate | string (optional) | |
createdDate | string (optional) | |
creatorId | integer (optional) | |
creatorName | string (optional) | |
fileSize | integer (optional) | |
documentVersionId | integer | |
documentVersionName | string (optional) | |
attachmentTitle | string (optional) | |
attachmentType | string (optional) | |
hasAnnotations | boolean | |
isDamFileAvailable | boolean |
create_task_document_upload
Not currently available
Creates a task document-upload requirement for a task, in Aprimo Marketing Operations. Set isReviewTask=true to create it via the review-task route instead of the plain task route. PM's snapshot declares the request body as fully opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
body | string | Yes | JSON object with the document-upload requirement data (PM wire names). PM's schema declares this opaque. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
documentId | integer (optional) | |
title | string (optional) | |
category | string (optional) | |
categoryId | integer (optional) | |
assetId | integer (optional) | |
attachmentId | integer (optional) | |
versionId | integer (optional) | |
fileTypeId | integer (optional) | |
uploadTypeId | integer (optional) | |
instructions | string (optional) | |
documentsRequiredType | integer (optional) | |
allowVersionId | integer (optional) | |
uploadLocationId | integer (optional) | |
facets | string (optional) | |
searchExpression | string (optional) | |
workflowDocumentId | integer (optional) | |
linkedTaskDocumentId | integer (optional) | |
assetTypeId | integer (optional) | |
attachmentTypeId | integer (optional) | |
initialVersionId | integer (optional) |
delete_task_document_uploaded_version
Destructive · Not currently available
Permanently deletes an uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. This cannot be undone. Set isReviewTask=true to delete it via the review-task route instead of the plain task route. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact version with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
versionId | string | Yes | The document version's integer ID to delete. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting an uploaded document version is permanent and cannot be undone. Set only after stating the exact version to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
taskDocumentId | integer | |
versionId | integer | |
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_task_document_assets
Not currently available
Returns the asset documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. Set isReviewTask=true to fetch them via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskTypeId | integer (optional) | |
supporting | array of TaskDocumentHrefItem | |
supporting[].href | string (optional) | |
supporting[].contentType | string (optional) | |
working | array of TaskDocumentHrefItem | |
working[].href | string (optional) | |
working[].contentType | string (optional) |
get_task_document_attachments
Not currently available
Returns the attachment documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. Set isReviewTask=true to fetch them via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskTypeId | integer (optional) | |
supporting | array of TaskDocumentHrefItem | |
supporting[].href | string (optional) | |
supporting[].contentType | string (optional) | |
working | array of TaskDocumentHrefItem | |
working[].href | string (optional) | |
working[].contentType | string (optional) |
get_task_document_upload
Returns a single task document-upload requirement by task ID and task-document ID, in Aprimo Marketing Operations. Set isReviewTask=true to fetch it via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
documentId | integer (optional) | |
title | string (optional) | |
category | string (optional) | |
categoryId | integer (optional) | |
assetId | integer (optional) | |
attachmentId | integer (optional) | |
versionId | integer (optional) | |
fileTypeId | integer (optional) | |
uploadTypeId | integer (optional) | |
instructions | string (optional) | |
documentsRequiredType | integer (optional) | |
allowVersionId | integer (optional) | |
uploadLocationId | integer (optional) | |
facets | string (optional) | |
searchExpression | string (optional) | |
workflowDocumentId | integer (optional) | |
linkedTaskDocumentId | integer (optional) | |
assetTypeId | integer (optional) | |
attachmentTypeId | integer (optional) | |
initialVersionId | integer (optional) |
get_task_document_uploaded_version
Not currently available
Returns detail for one uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. Set isReviewTask=true to fetch it via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
versionId | string | Yes | The document version's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
documentId | integer | |
versionId | integer | |
canUndoLatestUpload | boolean | |
canUndoLatestUploadForTipModifier | boolean | |
uploadedByCurrentUser | boolean | |
currentTaskVersionId | integer | |
isNewerVersion | boolean |
get_task_document_uploaded_versions
Not currently available
Lists the uploaded versions of a task document, by task ID and task-document ID, in Aprimo Marketing Operations. Set isReviewTask=true to list them via the review-task route instead of the plain task route.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of DocumentVersionProjection | |
items[].versionId | integer | |
items[].isDefaultVersion | boolean | |
items[].hasXfdfAnnotations | boolean | |
items[].isEligibleForDamContent | boolean |
get_task_documents
Not currently available
Returns the documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations. Set isReviewTask=true to fetch them via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskTypeId | integer (optional) | |
supporting | array of TaskDocumentHrefItem | |
supporting[].href | string (optional) | |
supporting[].contentType | string (optional) | |
working | array of TaskDocumentHrefItem | |
working[].href | string (optional) | |
working[].contentType | string (optional) |
get_task_supporting_attachment
Returns a single supporting (reference/background) attachment for a (non-review) task, by task ID and document 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 |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
documentId | string | Yes | The document's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
title | string (optional) | |
raw | object (optional) |
get_task_working_attachment
Not currently available
Returns a single working attachment document for a task, by task ID and document ID, in Aprimo Marketing Operations. Set isReviewTask=true to fetch it via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
documentId | string | Yes | The document's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
documentId | integer (optional) | |
title | string (optional) | |
category | string (optional) | |
assetId | integer (optional) | |
attachmentId | integer (optional) | |
versionId | integer (optional) | |
fileTypeId | integer (optional) | |
uploadTypeId | integer (optional) | |
instructions | string (optional) | |
documentsRequiredType | integer (optional) | |
allowVersionId | integer (optional) |
list_task_document_uploads
Lists the document-upload requirements for a task, in Aprimo Marketing Operations. Set isReviewTask=true to list them via the review-task route instead of the plain task route.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of TaskDocumentUploadProjection | |
items[].taskId | integer | |
items[].documentId | integer (optional) | |
items[].title | string (optional) | |
items[].category | string (optional) | |
items[].categoryId | integer (optional) | |
items[].assetId | integer (optional) | |
items[].attachmentId | integer (optional) | |
items[].versionId | integer (optional) | |
items[].fileTypeId | integer (optional) | |
items[].uploadTypeId | integer (optional) | |
items[].instructions | string (optional) | |
items[].documentsRequiredType | integer (optional) | |
items[].allowVersionId | integer (optional) | |
items[].uploadLocationId | integer (optional) | |
items[].facets | string (optional) | |
items[].searchExpression | string (optional) | |
items[].workflowDocumentId | integer (optional) | |
items[].linkedTaskDocumentId | integer (optional) | |
items[].assetTypeId | integer (optional) | |
items[].attachmentTypeId | integer (optional) | |
items[].initialVersionId | integer (optional) |
list_task_supporting_attachments
Lists supporting (reference/background) attachments for a (non-review) task, by the task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of SupportingAttachmentProjection | |
items[].id | string (optional) | |
items[].title | string (optional) | |
items[].raw | object (optional) |
list_task_working_attachments
Lists all working attachment documents for a task, in Aprimo Marketing Operations. Set isReviewTask=true to list them via the review-task route instead of the plain task route.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of WorkingDocumentProjection | |
items[].taskId | integer | |
items[].documentId | integer (optional) | |
items[].title | string (optional) | |
items[].category | string (optional) | |
items[].assetId | integer (optional) | |
items[].attachmentId | integer (optional) | |
items[].versionId | integer (optional) | |
items[].fileTypeId | integer (optional) | |
items[].uploadTypeId | integer (optional) | |
items[].instructions | string (optional) | |
items[].documentsRequiredType | integer (optional) | |
items[].allowVersionId | integer (optional) |
update_assignment_document
Not currently available
Updates the metadata of a required document attached to a workflow task assignment, by the task-document's integer ID, in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskDocId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). PM's schema declares this opaque. |
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 |
|---|---|---|
taskDocId | string (optional) | |
raw | object (optional) |
Review & Approve Deliverables
Can change data · 22 tools (10 currently available) · Group ID review-approve-deliverables
Needs: Attach Documents & Files to Tasks, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
cast_review_task_vote | Not currently available. Destructive. Casts a vote on a review task in Aprimo Marketing Operations. |
delegate_review_task | Not currently available. Destructive. Delegates a review task to another user in Aprimo Marketing Operations. |
get_review_document_vote_comments | Not currently available. Returns the assignees' vote comments for one document under document-level voting (DLV), by task ID and task-document ID, in Aprimo Marketing Operations. |
get_review_required_documents | Returns all tasks that a given attachment is required on (paged), by the attachment's integer ID, in Aprimo Marketing Operations. |
get_review_task | Returns a single review task by its integer ID in Aprimo Marketing Operations. |
get_review_task_assignee | Not currently available. Returns the current user's assignment record for the specified review task, by the review task's integer ID, in Aprimo Marketing Operations. |
get_review_task_link | Not currently available. Returns a single task link belonging to the specified review task, in Aprimo Marketing Operations. |
get_review_task_review_materials | Not currently available. Returns the review materials (document hrefs) for a review task, by the review task's integer ID, in Aprimo Marketing Operations. |
get_review_task_supporting_attachment | Not currently available. Returns a single supporting (reference/background) attachment for a review task, by review task ID and document ID, in Aprimo Marketing Operations. |
get_task_document_votes | Returns the document-level vote records for a task under document-level voting (DLV), by the task's integer ID, in Aprimo Marketing Operations. |
get_task_review_materials | Returns the review materials (document hrefs) for a task, by the task's integer ID, in Aprimo Marketing Operations. |
list_my_review_tasks | Lists review tasks assigned to the current user, in Aprimo Marketing Operations, paged. |
list_review_task_delegation_users | Not currently available. Returns a paged list of users to whom the specified review task can be delegated, by the review task's integer ID, in Aprimo Marketing Operations. |
list_review_task_document_votes | Not currently available. Returns the document-level vote records for a review task under document-level voting (DLV), by the review task's integer ID, in Aprimo Marketing Operations. |
list_review_task_links | Lists the task links on a review task, by the review task's integer ID, in Aprimo Marketing Operations. |
list_review_task_supporting_attachments | Lists supporting (reference/background) attachments for a review task, by the review task's integer ID, in Aprimo Marketing Operations. |
list_review_tasks | Lists review tasks in Aprimo Marketing Operations, paged, with optional filters on task status, modified-after date, and task title. |
search_review_tasks | Searches review tasks in Aprimo Marketing Operations by name, paged. |
update_review_task_begin_date | Not currently available. Updates the begin date of a review task by its integer ID in Aprimo Marketing Operations. |
update_review_task_document_vote | Not currently available. Updates the review vote for a document in a review-material task, by the task-document's integer ID, in Aprimo Marketing Operations. |
update_review_task_end_date | Not currently available. Updates the end date of a review task by its integer ID in Aprimo Marketing Operations. |
update_review_task_estimated_duration | Updates the estimated duration of a review task by its integer ID in Aprimo Marketing Operations. |
cast_review_task_vote
Destructive · Not currently available
Casts a vote on a review task in Aprimo Marketing Operations. This is a state change that records the assignee's vote (approve/reject/etc.) and may advance the workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact review task and vote with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
voteResult | integer | Yes | The integer vote result to cast (PM's ReviewTaskVoteResult enum, e.g. approve/reject). |
comments | string | No | Optional comments on the vote. |
days | integer | No | Optional days spent reviewing. |
hours | integer | No | Optional hours spent reviewing. |
minutes | integer | No | Optional minutes spent reviewing. |
rejectReasonId | integer | No | Optional integer ID of the reason for rejecting, when voteResult is a rejection. |
electronicSignature | string | No | Optional electronic signature text, when the review task requires one. |
promoteAttachments | boolean | No | When true, promote the task's draft attachments on vote. Default false. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — casting a vote changes the review task's state. Set only after stating the exact review task and vote to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
success | boolean | |
message | string (optional) |
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.
delegate_review_task
Destructive · Not currently available
Delegates a review task to another user in Aprimo Marketing Operations. This is a state change that reassigns the review task. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact review task and target user with the user. Returns a 409-style conflict message if the review task cannot be delegated in its current state.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID to delegate. |
taskAssigneeId | string | Yes | The task assignee record's integer ID (the assignment being delegated). |
newUserId | string | Yes | The integer user ID to delegate the review task to. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — delegating a review task reassigns it and changes its state. Set only after stating the exact review task and target user to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
success | boolean | |
failedDueToConflictingData | boolean | |
message | string (optional) | |
messageResourceId | string (optional) |
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_review_document_vote_comments
Not currently available
Returns the assignees' vote comments for one document under document-level voting (DLV), by task ID and task-document ID, in Aprimo Marketing Operations. Resolves related-user names.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocId | string | Yes | The task-document's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
readOnly | boolean | |
totalRecords | integer | |
items | array of ReviewTaskDocumentVoteProjection | |
items[].taskName | string (optional) | |
items[].taskId | integer (optional) | |
items[].workflowStepId | integer (optional) | |
items[].taskDocId | integer | |
items[].assigneeId | integer | |
items[].versionId | integer | |
items[].voteResult | integer (optional) | |
items[].rejectId | integer (optional) | |
items[].comments | string (optional) | |
items[].voteResultEncTitleId | integer (optional) | |
items[].relatedUserId | integer (optional) | |
items[].relatedUserName | string (optional) | |
items[].relatedCompletedDate | string (optional) | |
items[].relatedNotVotedAssigneeUserIds | array of integer (optional) |
get_review_required_documents
Returns all tasks that a given attachment is required on (paged), by the attachment's integer ID, in Aprimo Marketing Operations. No review-task route exists for this op. PM's snapshot declares the response items fully opaque, so each entry's full record is included alongside best-effort task/document/title fields.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
attachId | string | Yes | The attachment'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 |
|---|---|---|
totalRecords | integer | |
items | array of ReviewRequiredDocumentItem | |
items[].taskId | integer (optional) | |
items[].documentId | integer (optional) | |
items[].title | string (optional) | |
items[].category | string (optional) | |
items[].categoryId | integer (optional) | |
items[].assetId | integer (optional) | |
items[].attachmentId | integer (optional) | |
items[].versionId | integer (optional) | |
items[].fileTypeId | integer (optional) | |
items[].uploadTypeId | integer (optional) | |
items[].instructions | string (optional) | |
items[].documentsRequiredType | integer (optional) | |
items[].allowVersionId | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
get_review_task
Returns a single review task by its integer ID in Aprimo Marketing Operations. Not its assignee (get_review_task_assignee), link (get_review_task_link), review materials (get_review_task_review_materials), or supporting attachment (get_review_task_supporting_attachment). Resolves status label and modified/completed-by user names. Also reports whether the review task can currently be closed, delegated, declined, or skipped.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
projectId | integer | |
projectDeepLink | string (optional) | |
name | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (optional) | Whether the review task can currently be closed. |
canDelegate | boolean (optional) | Whether the review task can currently be delegated (drives delegate_review_task). |
canDecline | boolean (optional) | Whether the review task can currently be declined. |
canSkip | boolean (optional) | Whether the review task can currently be skipped. |
voteStyle | integer (optional) | PM's ReviewTaskVoteStyle enum, as a raw integer -- no existing resolver maps it to a display label. |
voteResult | integer (optional) | PM's ReviewTaskVoteResult enum, as a raw integer -- no existing resolver maps it to a display label. |
documentLevelVoting | boolean (optional) | |
allMustVote | boolean (optional) | |
requiresElectronicSignature | boolean (optional) | |
numberOfAssignees | integer (optional) | |
raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
get_review_task_assignee
Not currently available
Returns the current user's assignment record for the specified review task, by the review task's integer ID, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) |
get_review_task_link
Not currently available
Returns a single task link belonging to the specified review task, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
linkId | string | Yes | The task link'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_review_task_review_materials
Not currently available
Returns the review materials (document hrefs) for a review task, by the review task'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 |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
reviewMaterials | array of ReviewMaterialItemProjection | |
reviewMaterials[].href | string (optional) |
get_review_task_supporting_attachment
Not currently available
Returns a single supporting (reference/background) attachment for a review task, by review task ID and document 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 |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
documentId | string | Yes | The document's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
title | string (optional) | |
raw | object (optional) |
get_task_document_votes
Returns the document-level vote records for a task under document-level voting (DLV), by the task's integer ID, in Aprimo Marketing Operations. Resolves related-user names.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
readOnly | boolean | |
totalRecords | integer | |
items | array of ReviewTaskDocumentVoteProjection | |
items[].taskName | string (optional) | |
items[].taskId | integer (optional) | |
items[].workflowStepId | integer (optional) | |
items[].taskDocId | integer | |
items[].assigneeId | integer | |
items[].versionId | integer | |
items[].voteResult | integer (optional) | |
items[].rejectId | integer (optional) | |
items[].comments | string (optional) | |
items[].voteResultEncTitleId | integer (optional) | |
items[].relatedUserId | integer (optional) | |
items[].relatedUserName | string (optional) | |
items[].relatedCompletedDate | string (optional) | |
items[].relatedNotVotedAssigneeUserIds | array of integer (optional) |
get_task_review_materials
Returns the review materials (document hrefs) for a task, by the task'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 |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
reviewMaterials | array of ReviewMaterialItemProjection | |
reviewMaterials[].href | string (optional) |
list_my_review_tasks
Lists review tasks assigned to the current user, in Aprimo Marketing Operations, paged. PM's snapshot declares the response shape as opaque, so items are surfaced with best-effort id/name extraction plus the full raw wire object.
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). |
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 ReviewTaskMineItemProjection | The items returned in this response. |
items[].taskId | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) |
list_review_task_delegation_users
Not currently available
Returns a paged list of users to whom the specified review task can be delegated, by the review task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
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 DelegationUserProjection | 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_review_task_document_votes
Not currently available
Returns the document-level vote records for a review task under document-level voting (DLV), by the review task's integer ID, in Aprimo Marketing Operations. The result is flagged read-only when the current user cannot vote on it. PM's snapshot declares this route's response shape as opaque, so items are surfaced with best-effort id extraction plus the full raw wire object.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
readOnly | boolean (optional) | |
totalRecords | integer | |
items | array of ReviewTaskDocumentVoteRawItemProjection | |
items[].taskDocId | string (optional) | |
items[].raw | object (optional) |
list_review_task_links
Lists the task links on a review task, by the review task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
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 TaskLinkProjection | 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_review_task_supporting_attachments
Lists supporting (reference/background) attachments for a review task, by the review task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of SupportingAttachmentProjection | |
items[].id | string (optional) | |
items[].title | string (optional) | |
items[].raw | object (optional) |
list_review_tasks
Lists review tasks in Aprimo Marketing Operations, paged, with optional filters on task status, modified-after date, and task title. Resolves status labels and modified/completed-by user names.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskStatus | integer | No | Optional integer task-status id to filter by. Omit to match any status. |
modifiedAfterDate | string | No | Optional ISO-8601 date; only review tasks modified on/after this date are returned. |
taskTitle | string | No | Optional case-insensitive substring filter on the review task's title. |
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 'TaskId'). |
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 ReviewTaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].projectId | integer | |
items[].projectDeepLink | string (optional) | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (optional) | Whether the review task can currently be closed. |
items[].canDelegate | boolean (optional) | Whether the review task can currently be delegated (drives delegate_review_task). |
items[].canDecline | boolean (optional) | Whether the review task can currently be declined. |
items[].canSkip | boolean (optional) | Whether the review task can currently be skipped. |
items[].voteStyle | integer (optional) | PM's ReviewTaskVoteStyle enum, as a raw integer -- no existing resolver maps it to a display label. |
items[].voteResult | integer (optional) | PM's ReviewTaskVoteResult enum, as a raw integer -- no existing resolver maps it to a display label. |
items[].documentLevelVoting | boolean (optional) | |
items[].allMustVote | boolean (optional) | |
items[].requiresElectronicSignature | boolean (optional) | |
items[].numberOfAssignees | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
search_review_tasks
Searches review tasks 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 review task's name. Omit to match all review tasks. |
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 ReviewTaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].projectId | integer | |
items[].projectDeepLink | string (optional) | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (optional) | Whether the review task can currently be closed. |
items[].canDelegate | boolean (optional) | Whether the review task can currently be delegated (drives delegate_review_task). |
items[].canDecline | boolean (optional) | Whether the review task can currently be declined. |
items[].canSkip | boolean (optional) | Whether the review task can currently be skipped. |
items[].voteStyle | integer (optional) | PM's ReviewTaskVoteStyle enum, as a raw integer -- no existing resolver maps it to a display label. |
items[].voteResult | integer (optional) | PM's ReviewTaskVoteResult enum, as a raw integer -- no existing resolver maps it to a display label. |
items[].documentLevelVoting | boolean (optional) | |
items[].allMustVote | boolean (optional) | |
items[].requiresElectronicSignature | boolean (optional) | |
items[].numberOfAssignees | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
update_review_task_begin_date
Not currently available
Updates the begin date of a review task by its integer ID in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. {"beginDate":"2026-08-01T00:00:00Z"}). Requires confirmed=true after showing the user the exact new begin date. Returns the updated task.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
body | string | Yes | JSON object carrying the new begin date in PM wire form. PM's schema declares this opaque. |
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 |
|---|---|---|
taskId | integer (optional) | |
raw | object (optional) |
update_review_task_document_vote
Not currently available
Updates the review vote for a document in a review-material task, by the task-document's integer ID, in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. vote result/comments). Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskDocId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the vote data (PM wire names). PM's schema declares this opaque. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
taskDocId | integer (optional) | |
raw | object (optional) |
update_review_task_end_date
Not currently available
Updates the end date of a review task by its integer ID in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. {"endDate":"2026-08-15T00:00:00Z"}). Requires confirmed=true after showing the user the exact new end date. Returns the updated task.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
body | string | Yes | JSON object carrying the new end date in PM wire form. PM's schema declares this opaque. |
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 |
|---|---|---|
taskId | integer (optional) | |
raw | object (optional) |
update_review_task_estimated_duration
Updates the estimated duration of a review task by its integer ID in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. {"estimatedDuration":480}). Requires confirmed=true after showing the user the exact new estimated duration. Returns the updated task.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
body | string | Yes | JSON object carrying the new estimated duration in PM wire form. PM's schema declares this opaque. |
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 |
|---|---|---|
taskId | integer (optional) | |
raw | object (optional) |
Annotate PM Documents
Can change data · 4 tools (1 currently available) · Group ID annotate-pm-documents
Needs: Manage Supporting Documents
| Tool | What it does |
|---|---|
create_public_xfdf_annotation | Not currently available. Creates an XFDF annotation on a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource). |
delete_public_xfdf_annotation | Not currently available. Destructive. Permanently deletes an XFDF annotation from a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource). |
get_dam_record_reference_documents | Returns the DAM reference documents linked to a DAM record, in Aprimo Marketing Operations. |
get_public_xfdf_annotations | Not currently available. Returns the XFDF annotations for a document version, paged, in Aprimo Marketing Operations (the public assets/annotations-data resource). |
create_public_xfdf_annotation
Not currently available
Creates an XFDF annotation on a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource). Requires confirmed=true after showing the user the exact payload. Returns the created annotation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The asset (document)'s integer id. |
versionId | string | Yes | The document version's integer id. |
body | string | Yes | JSON object with the XFDF annotation payload. Must include a "type" property identifying the annotation kind. |
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 payload. |
Returns:
| Field | Type | Description |
|---|---|---|
annotationId | integer | |
annotationUuid | string (optional) | |
associatedNumber | integer (optional) | |
createdDate | string (optional) | |
modifiedDate | string (optional) | |
replyCount | integer (optional) | |
type | string (optional) | |
page | integer (optional) | |
authorId | integer (optional) | |
comment | string (optional) | Flattened from content.comment. |
quotedText | string (optional) | Flattened from content.quotedText. |
fixedLabel | string (optional) | Flattened from content.fixedLabel (a stamp/fixed-annotation's label, when present) -- newly surfaced now that ContentModel is a confirmed, hardened schema. |
color | string (optional) | Flattened from style.color. |
opacity | number (optional) | Flattened from style.opacity. |
width | integer (optional) | Flattened from style.width. |
referenceDocumentUuid | string (optional) | Flattened from referenceLink.documentUuid. |
delete_public_xfdf_annotation
Destructive · Not currently available
Permanently deletes an XFDF annotation from a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource). This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact annotation with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The asset (document)'s integer id. |
versionId | string | Yes | The document version's integer id. |
annotationId | string | Yes | The annotation's integer id to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting an annotation is permanent and cannot be undone. Set only after stating the exact annotation to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
versionId | integer | |
annotationId | integer | |
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_dam_record_reference_documents
Returns the DAM reference documents linked to a DAM record, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The DAM record's GUID (a string, not an integer id). |
Returns:
| Field | Type | Description |
|---|---|---|
items | array of RefDocsModel | |
items[].fileVersionId | string (optional) | |
items[].refDocs | array of RefDocsProjection | |
items[].refDocs[].refDocRecordId | string (optional) | |
items[].refDocs[].refDocFileVersionId | string (optional) | |
items[].refDocs[].refDocAssetTitle | string (optional) |
get_public_xfdf_annotations
Not currently available
Returns the XFDF annotations for a document version, paged, in Aprimo Marketing Operations (the public assets/annotations-data resource).
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The asset (document)'s integer id. |
versionId | string | Yes | The document version's integer id. |
offset | integer | No | The zero-based index of the first annotation to return (default 0). |
limit | integer | No | The maximum number of annotations to return (default 50). |
Returns:
| Field | Type | Description |
|---|---|---|
totalCount | integer | |
offset | integer | |
limit | integer | |
items | array of PublicXfdfAnnotationProjection | |
items[].annotationId | integer | |
items[].annotationUuid | string (optional) | |
items[].associatedNumber | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedDate | string (optional) | |
items[].replyCount | integer (optional) | |
items[].type | string (optional) | |
items[].page | integer (optional) | |
items[].authorId | integer (optional) | |
items[].comment | string (optional) | Flattened from content.comment. |
items[].quotedText | string (optional) | Flattened from content.quotedText. |
items[].fixedLabel | string (optional) | Flattened from content.fixedLabel (a stamp/fixed-annotation's label, when present) -- newly surfaced now that ContentModel is a confirmed, hardened schema. |
items[].color | string (optional) | Flattened from style.color. |
items[].opacity | number (optional) | Flattened from style.opacity. |
items[].width | integer (optional) | Flattened from style.width. |
items[].referenceDocumentUuid | string (optional) | Flattened from referenceLink.documentUuid. |