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/fetch/LAT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/LAT
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- Example 1
- ExampleFiltered
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/LAT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "status": 0 } }
Request
Retrieves a list of events generated by the Pricefx server. See the Server Events article.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/EVT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/EVT
- 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/EVT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "name",
"operator": "iEquals",
"value": "CALCULATION_COMPLETED_PG"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
Request
Retrieves events related to security (Management of User Groups, Management of Roles, Pricefx user account deactivation) and some configuration settings (e.g., changing default calculation logics).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/SAT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/SAT
- 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/SAT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "action",
"operator": "equals",
"value": "CHANGE_PASSWORD"
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-759b69578b-sl8nj", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "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