Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Export a CSV File
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 (with validation and schedules)
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)
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
Export a CSV File
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
Downloads an XLSX file. The returned file contains all definitions (meta) and the data. This is useful for importing the Data Source, Datamart, or Data Feed definitions + data in some other instance or partition.
Security
basic or X-PriceFx-jwt
Query
Bodyapplication/jsonSet this parameter to override the default timeout (60 seconds) of the query. The maximum allowed timeout is 300 seconds. The default timeout value and the maximum timeout value can be configured in the backend. Setting higher timeout can be useful, for example, when a query takes long time (e.g., when processing large tables).
Default "60"
Example: timeout=20
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.exportdata/xlsx
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.exportdata/xlsx
- 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.exportdata/xlsx?timeout=20' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"fieldCollections": [
"DMDS.Transactions"
],
"sanitize": true
}
}'Request
Downloads a ZIP file. The returned ZIP file contains Data Source, Datamart, or Data Feed definitions in the JSON file and data in the CSV file.
Security
basic or X-PriceFx-jwt
Query
Bodyapplication/jsonSet this parameter to override the default timeout (60 seconds) of the query. The maximum allowed timeout is 300 seconds. The default timeout value and the maximum timeout value can be configured in the backend. Setting higher timeout can be useful, for example, when a query takes long time (e.g., when processing large tables).
Default "60"
Example: timeout=20
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.exportdata
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.exportdata
- 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.exportdata?timeout=20' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"fieldCollections": [
"DMDS.Transactions"
],
"sanitize": true
}
}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.fetchexportfile/{fileName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.fetchexportfile/{fileName}
- 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.fetchexportfile/DMDS.Txn_PO_Test_0001_part_00.gzSee 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