Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Add 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
List Calculation Grid Items
Get a Calculation Grid Item
Update a Calculation Grid Item
Submit a Calculation Grid Item
Deny a Calculation Grid Item
Delete a Calculation Grid Item
Add a Calculation Grid It...
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}
Request
Start the calculation job of the specified Calculation Grid. Returns the JobStatusTracker object (JST).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationgridmanager.calculate/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/calculationgridmanager.calculate/{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.calculate/99 \
-H 'Content-Type: application/json' \
-d '{
"priority": 0
}'Response
application/json
{ "response": { "node": "e2e-tabasco-node", "data": [ … ], "status": 0 } }
Bodyapplication/json
dataCalculationGridItem1Key (object) or CalculationGridItem2Key (object) or CalculationGridItem3Key (object) or CalculationGridItem4Key (object) or CalculationGridItem5Key (object) or CalculationGridItem6Key (object)
Any of:
- CalculationGridItem1Key
- CalculationGridItem2Key
- CalculationGridItem3Key
- CalculationGridItem4Key
- CalculationGridItem5Key
- CalculationGridItem6Key
The type code is CGI1.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/CGI{keyNumber}
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/CGI{keyNumber}
- 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/add/CGI6 \
-H 'Content-Type: application/json' \
-d '{
"data": {
"key1": "1",
"key2": "q",
"key3": "2",
"key4": "aa",
"key5": "q",
"key6": "u",
"calculationGridId": 7
}
}'Response
application/json
{ "response": { "node": "e2e-tabasco-node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CGI{keyNumber}
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CGI{keyNumber}
- 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}' \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"calculationGridId": "7"
}
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "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