Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Update a Calculation Grid Item
Add a Calculation Grid
List Calculation Grids
Get a Calculation Grid
Update a Calculation Grid
Delete a Calculation Grid
Calculate a Calculation Grid
Add a Calculation Grid Item
List Calculation Grid Items
Get a Calculation Grid Item
Submit a Calculation Grid Item
Deny a Calculation Grid Item
Delete a Calculation Grid Item
Update a Calculation Grid...
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
Path
Bodyapplication/jsonUse CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys.
Enum"1""2""3""4""5""6"
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CGI{keyNumber}/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CGI{keyNumber}/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CGI{keyNumber}/{id}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "e2e-tabasco-node", "data": [ … ], "status": 0 } }
Request
Allows you to perform a manual override of the specified Calculation Grid Item (CGI). Returns the updated CGIx object.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationgridmanager.update/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/calculationgridmanager.update/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationgridmanager.update/6 \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "4.CGI6",
"key6": "newKeyValue"
},
"oldValues": {
"version": 3,
"typedId": "4.CGI6",
"calculationGridId": 7,
"manualEditVersion": 0,
"name": "2 | q | 2 | aa | w | b",
"createDate": "2022-11-30T12:45:54",
"createdBy": 2147490187,
"lastUpdateDate": "2022-11-30T12:45:54",
"lastUpdateBy": 2147490187,
"key1": "2",
"key2": "q",
"key3": "2",
"key4": "aa",
"key5": "w",
"key6": "b",
"completeResultsAvailable": false,
"itemExtensions": {}
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "e2e-tabasco-node", "data": [ … ], "status": 0 } }
Request
Submits the CalculationGridItems to the workflow.
| Required Permission | Roles with the Required Permission |
|---|---|
| CALCULATIONGRID_SUBMIT | Edit Calculation Grid & Add Products (CALCULATIONGRID_ADD), Edit CG (PB_CALCULATIONGRIDEDITOR), Administer CG (PB_CALCULATIONGRIDS) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationgridmanager.accept/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/calculationgridmanager.accept/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationgridmanager.accept/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"ids": [
"12.CGI",
"13.CGI",
"17.CGI",
"18.CGI",
"19.CGI"
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "data": [ … ], "status": 0 } }
See the Key-Value Database Storage Knowledge Base article for more details.
Operations
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.
Comments