Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Submit a Data Change Request
Add a Data Change Request
Add a Data Change Request Item
Get a Data Change Request
Get a Data Change Request (changes only)
Update a Data Change Request Item
Delete a Data Change Request Item
Submit a Data Change Request (async)
Mass Edit Data Change Request Items
Get Data Change Request Mass Changes
Update Data Change Request Mass Changes
Delete a Data Change Request Mass Change
Submit a Data Change Requ...
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/dcrmanager.delete/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/dcrmanager.delete/{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/dcrmanager.delete/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "string"
},
"operationType": "string"
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/dcrmanager.submit/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/dcrmanager.submit/{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/dcrmanager.submit/{id}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "e2e-node", "data": [ … ], "status": 0 } }
Request
Asynchronously submits the specified Data Change Request (DCR). Returns the Job Status Tracker object (JST).
Use to submit large (set by asyncSubmitDCRThreshold via Advanced Configuration Options) DCRs to avoid system timeouts (180 seconds - AWS).
asyncSubmitDCRThreshold default is set 100. If the key does not exist, the submit is always synchronous.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/dcrmanager.submit/{id}/async
- URL:https://companynode.pricefx.com/pricefx/companypartition/dcrmanager.submit/{id}/async
- 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/dcrmanager.submit/{id}/async' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-64c5f8d7f5-k5svk", "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