Breadcrumbs

Get Detailed Action Item in Agents

The pricefx_acc_ag_get_agents_action_item tool returns the details of one action item: its summary, status, assignee, due date, and the impact values that the Agent calculated. The response also includes links to the action item and to the Agent that created it.

Tool Name – pricefx_acc_ag_get_agents_action_item

Title – Get detailed action item in Agents accelerator

Type – Private

Access Profile: Configurator

This tool is only available with the Accelerate Agents 1.7.

Permissions

The tool is available only to the Configurator access profile when tool access control is on.

You can view an action item only if one of the following is true:

  • You are the assignee of the action item.

  • You created the action item.

  • You have the user role ADMINISTER_ACTIONS or MANAGE_ACTIONS. With these roles, you can view any action item.

If none of these is true, the tool returns an error and no action item details.

Parameters

Parameter

Required

Description

actionItemUniqueName

Yes, if actionItemTypedId and actionItemId are not given

Unique name of the action item, for example AI-1729. Not case-sensitive.

actionItemTypedId

Yes, if actionItemUniqueName and actionItemId are not given

Typed ID of the action item, for example 1729.AI.

actionItemId

Yes, if actionItemUniqueName and actionItemTypedId are not given

ID of the action item, for example 1729.

Give one identifier. If you give several, the action item must match all of them. When you give both actionItemTypedId and actionItemId, the tool uses actionItemTypedId and ignores actionItemId.

Output

The tool returns one action item with the following fields:

Field

Description

id

ID of the action item.

uniqueName

Unique name, for example AI-1729.

summary

Short summary of the action item.

description

Full description of the action item.

status

Status, for example OPEN or DONE.

dueDate

Date by which the action item should be done.

assignedTo / assignedToLoginName

ID and login name of the assignee.

createdBy / createdByName / createdByLoginName

ID, name, and login name of the user who created the action item.

createDate / lastUpdateDate

When the action item was created and last changed.

parentTypedId

Typed ID of the parent object, if any.

originatorTypedId

Typed ID of the Agent that created the action item, for example 2187.MO.

actionLink

Link to the action item detail page in Pricefx.

agentLink

Link to the Summary step of the Agent that created the action item.

Impact fields

For each impact type (Revenue, Profit, Costs, Target, Trends, Benchmark, and Others), the impact value and the name of the measure it is based on, for example pfxAcc_AG_revenueImpact and pfxAcc_AG_revenueImpactMeasureName. Fields without a value are empty.

info Revenue, Profit, and Costs impact values are rounded to 2 decimal places and shown with the currency symbol of the Agent, for example €1,250.00. Target, Trends, Benchmark, and Others impact values are not money values, so they have no currency symbol.

Behavior and Limitations

  • The tool returns one action item per call.

    • It returns any action item, not only those created by Agents. For other action items, the impact fields and agentLink are empty or not meaningful.

    • The links do not work outside the Pricefx application. actionLink and agentLink are relative (#/user/actions/...). They have no base URL and no partition, so the AI cannot give the user a working link. Other tools in the same package build full links, for example deepLink in Partition Manifest.

Errors

Situation

Error Message

No identifier is given.

No identifier provided. Please provide a Name, TypedId, or an ID of an Action Item.

actionItemTypedId is not in the format number.

Action Typed ID input is invalid. It should look like '12345.AI'.

No action item matches the identifiers.

No Action Item found for the provided identifier.

You are not the assignee or creator and do not have an action management role.

You do not have permission to view actions assigned to other users.

See Also