Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Deploy a Configuration Storage
Add a Configuration Storage
Update a Configuration Storage
Get a Configuration Storage
Delete a Configuration Storage
Deploy a Configuration St...
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/JCS
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/JCS
- 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/JCS \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "7.JCS"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Deploys the JSON Configuration Storage (JCS). Can be only used when storageStatus = DRAFT.
Required roles:
SUPPORTPM_FORMULA_DESIGNER_MANAGERPB_STRATEGY_DESIGNER_MANAGER
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/jcsmanager.deploy
- URL:https://companynode.pricefx.com/pricefx/companypartition/jcsmanager.deploy
- 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/jcsmanager.deploy \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "string"
},
"oldValues": {
"version": 0
}
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/JCS
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/JCS
- 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/JCS \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "7.JCS"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Deploys the JSON Configuration Storage (JCS). Can be only used when storageStatus = DRAFT.
Required roles:
SUPPORTPM_FORMULA_DESIGNER_MANAGERPB_STRATEGY_DESIGNER_MANAGER
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/jcsmanager.deploy
- URL:https://companynode.pricefx.com/pricefx/companypartition/jcsmanager.deploy
- 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/jcsmanager.deploy \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "string"
},
"oldValues": {
"version": 0
}
}'Response
application/json
{ "response": { "node": "node", "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