Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Data Loads (with validation and schedules)
List Data Manager Entities
Execute a Data Load Logic
Get a DM Object
Get a DM Object (no count)
Update a Data Manager Entity
Create a Data Manager Entity
Upload a Bulk Data to Data Source
Run a Data Load
Save a Data Load
Mass Edit
List Data Loads
Delete a Data Manager Entity
Query a Data Manager Object
SQL Query a Data Manager Object
List Rollups
List Charts
Import a Data Load
Export an Excel File (XLSX)
Export a CSV File
Get a DM Export File
Get Action Status
Export Datamart
Restore Default Data Sources
Import a File
Create a DMFieldCollection
List Datamart Orphan Objects
Delete Datamart Orphan Objects
List Data Loads (with val...
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
Performs a Mass Edit operation on specified Datamart object - changes values of the specified field (column).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.massedit/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.massedit/{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/datamart.massedit/2147483653.DMDS \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {},
"massEditRecords": [
{
"fieldName": "currency",
"massEditOperator": "=",
"fieldValue": "EUR",
"precision": null
}
]
}
}'Response
application/json
{ "response": { "node": "e2e-staging-node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.getdataloads
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.getdataloads
- 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/datamart.getdataloadsResponse
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "endRow": 0, "status": 0 } }
Request
Returns a list of Data Load definitions. No validation is run on returned Data Loads and no schedules are loaded. Use this endpoint for listing only.
If you need Data Loads to be validated and schedules returned, use the List Data Loads (with validation and schedules) (/datamart.getdataloads) endpoint instead.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.listdataloads
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.listdataloads
- 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/datamart.listdataloadsResponse
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "endRow": 0, "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