Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Get a Parallel Calculation Item
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
Execute a Model Logic
List Parallel Calculation Items
Revoke a Model
Duplicate a Model
Import Models
Export Models
Load Data Into FieldCollection
Get a Parallel Calculatio...
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
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 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/PCI/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/PCI/{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/PCI/{id}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5cf55f5475-fsn4h", "data": [ … ], "status": 0 } }
Request
Revokes a model with a workflow so it can be deleted afterward. Only models with the workflow status = APPROVED or NO_APPROVAL_REQUIRED can be revoked. The revoke action will set the workflow status of a model to WITHDRAWN.
Once revoked, the model is back in an editable state and can be deleted by users having the right to do so.
Required roles:
PO_MCMO_MANAGER(Administrate Model Classes/Objects)PO_MCMO(Manage Model Objects)- for models in Module Categories (see User Group Entitlements in Module Categories):
MODULECATEGORY_MO_MANAGER(Manage Model in Module Category)
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelrevoke/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelrevoke/{typedId}
- 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.modelrevoke/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "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