Pricefx REST API Reference
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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/AI
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/AI
- 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/delete/AI \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "42.AI"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "data": [ … ], "status": 0 } }
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
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/AI
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/AI
- 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/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"
}
]
}
}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "string", "data": [ … ], "endRow": 0 } }
Bodyapplication/json
data should contain the typedId of the Action Item you want to update and the updated field.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/AI
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/AI
- 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/update/AI \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "70.AI",
"assignedTo": 2147490806
},
"oldValues": {
"version": 2,
"typedId": "70.AI",
"createdByName": "admin",
"assignedTo": 2147490696,
"assignedToName": "admin",
"description": "This action is really important!",
"dueDate": "2023-06-30T00:00:00",
"lastUpdateByName": "admin",
"summary": "Important Action2",
"outputs": [],
"status": "OPEN",
"uniqueName": "AI-70",
"createDate": "2023-06-27T12:59:15",
"createdBy": 2147490696,
"lastUpdateDate": "2023-06-27T12:59:15",
"lastUpdateBy": 2147490696,
"actionItemType": "__DEFAULT__",
"_key": "70.AI",
"_level": 0
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "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