Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Duplicate a Model
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
Get a Parallel Calculation Item
Revoke a Model
Import Models
Export Models
Load Data Into FieldCollection
Duplicate a Model
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
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 } }
Request
Creates a copy of the specified model with a new name, including the parameter tables (if copyParamTables=true).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelduplicate/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelduplicate/{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.modelduplicate/{typedId}' \
-H 'Content-Type: application/json' \
-d '{
"response": {
"node": "pricefx-cluster-app-frontend-85784f5b7c-jd2t7",
"data": [
{
"version": 0,
"typedId": "59.MO",
"uniqueName": "OT_TEST",
"label": "OT_TEST",
"modelClassUN": "Price_Waterfall",
"moduleCategoryUN": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"currentStep": null,
"state": {
"definition": {
"mapping": {
"product": "ProductID",
"customer": "CustomerID",
"quantity": "Quantity",
"net_price": "PocketPrice",
"surcharge": "SalesDiscount",
"source_name": "DM.datamart_transaction",
"invoice_price": "InvoicePrice",
"net_net_price": "PocketPrice",
"pocket_margin": "GrossMargin",
"product_group": "ProductGroup",
"product_label": "ProductLabel",
"customer_group": "CustomerGroup",
"customer_label": "CustomerName",
"customer_discount": "VolumeDiscount",
"global_list_price": "InvoicePrice",
"standard_discount": "StdDiscount",
"product_group_label": "ProductGroup",
"specific_list_price": "ListPrice",
"customer_group_label": "CustomerGroup",
"transaction_data_filter": null,
"negotiation_guidance_model": null
}
}
},
"createdByName": "ondrej.tesar",
"lastUpdateByName": "ondrej.tesar",
"submittedBy": null,
"submittedByName": null,
"approvedBy": null,
"approvedByName": null,
"deniedBy": null,
"deniedByName": null,
"submitDate": null,
"workflowStatus": "DRAFT",
"status": "DRAFT",
"createDate": "2024-08-30T09:32:41",
"createdBy": 2147490187,
"lastUpdateDate": "2024-08-30T09:32:41",
"lastUpdateBy": 2147490187,
"id": 59
}
],
"status": 0
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelimport
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelimport
- 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.modelimport \
-H 'Content-Type: multipart/form-data' \
-F file=stringResponse
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