Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Execute a Model Logic
Calculate a Model Object Step
Recalculate a Calculation of a Step
Recalculate Items of a Parallel Calculation
Save a Model
Submit a Model
Get a Calculation Status
Get a Step Calculation Status
Cancel a Calculation Step
List Model Logic Parameters
List Parallel Calculation Items
Get a Parallel Calculation Item
Revoke a Model
Duplicate a Model
Import Models
Export Models
Load Data Into FieldCollection
Execute a Model Logic
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/optimization.modelformulaparams/{typedId}/{stepName}/{formulaName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelformulaparams/{typedId}/{stepName}/{formulaName}
- 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/optimization.modelformulaparams/123.M/{stepName}/{formulaName}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelformulaexec/{typedId}/{stepName}/{formulaName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelformulaexec/{typedId}/{stepName}/{formulaName}
- 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/optimization.modelformulaexec/123.M/{stepName}/{formulaName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"SegmentationModel": "Seg_Godfather",
"targetDate": "2022-02-08T11:38:51.972Z"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Retrieves all PCI objects (Parallel Calculation Items) for the specified job. A lightweight version of the general fetch/PCI endpoint. Does not return possibly large outputs and messages fields.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelfetchpci
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelfetchpci
- 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/optimization.modelfetchpci \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"criteria": [
{
"fieldName": "jstId",
"operator": "equals",
"value": 2153717967
}
],
"operator": "and",
"_constructor": "AdvancedCriteria"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5cf55f5475-fsn4h", "startRow": 0, "data": [ … ], "endRow": 10, "totalRows": 10, "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