Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Create an Action Item

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Actions

Operations

Create an Action Item

Request

Adds an Action Item.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobject(ActionItem)required

The type code is AI.

data.​lastUpdateByNamestring or null<= 255 characters
data.​outputsArray of objects
data.​createdByNamestring or null<= 255 characters
data.​typedIdstring
data.​assignedToNamestring<= 255 characters
data.​lastUpdateDatestring(date-time)
data.​dueDatestring(date-time)
data.​actionItemTypestringrequired
data.​descriptionstring or null
data.​parentTabNamestring or null<= 255 characters
data.​assignedTointegerrequired
data.​assignedToGroupstring or null<= 255 characters
data.​sourceContextstring or null<= 255 characters
data.​targetContextstring or null<= 255 characters
data.​parentTypedIdstring or null<= 255 characters
data.​completedByNamestring or null<= 255 characters
data.​createDatestring(date-time)
data.​summarystring<= 255 charactersrequired
data.​originatorTypedIdstring or null<= 255 characters
data.​versioninteger
data.​completedDatestring or null(date-time)
data.​uniqueNamestring<= 255 characters
data.​createdByinteger
data.​completedByinteger or null
data.​statusstring<= 255 characters
Enum"OPEN""DONE""REJECTED""BLOCKED""POSTPONED"
data.​lastUpdateByinteger
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/AI \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "summary": "Important Action",
      "assignedTo": 2147490696,
      "dueDate": "2023-06-30T00:00:00",
      "description": "This action is really important!",
      "actionItemType": "__DEFAULT__",
      "parentTypedId": null
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": [ … ],
    "status": 0
  }
}

Delete an Action Item

Request

Deletes an Action Item.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobjectrequired
data.​typedIdstringnon-emptyrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/AI \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "42.AI"
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "pricefx-cluster-app-frontend",
    "data": [ … ],
    "status": 0
  }
}

List Action Items

Request

Retrieves Action Items by filter criteria. To retrieve a specific action, filter the action by id as follows:

{
   "data":{
      "fieldName":"id",
      "operator":"equals",
      "value":"41",
      "_constructor":"AdvancedCriteria"
   }
}
Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/AI \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "_constructor": "AdvancedCriteria",
          "operator": "and",
          "criteria": [
            {
              "fieldName": "assignedTo",
              "operator": "equals",
              "value": 2147491061
            }
          ]
        },
        {
          "fieldName": "parentTypedId",
          "operator": "equals",
          "value": "90.Q",
          "_constructor": "AdvancedCriteria"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "status": 0,
    "startRow": 0,
    "node": "string",
    "data": [ … ],
    "endRow": 0
  }
}

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.

otherSchemas

Schemas