Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Charts
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
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 Charts
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/datamart.getrollups
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.getrollups
- 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.getrollups \
-H 'Content-Type: application/json' \
-d '{
"operationType": "fetch",
"startRow": 0,
"endRow": null,
"textMatchStyle": "substring",
"data": {
"fieldName": "owner",
"operator": "equals",
"value": null,
"_constructor": "AdvancedCriteria"
},
"oldValues": null
}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "string", "data": [ … ], "endRow": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.getcharts
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.getcharts
- 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.getchartsResponse
application/json
{ "response": { "status": 0, "startRow": 0, "node": "string", "data": [ … ], "endRow": 0 } }
Request
Imports a list of Data Load definitions. Existing definitions will be updated.
Information: Omitting a property is equivalent to setting it to null. With one exception: a previously existing
incLoadDatewill be retained.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.importdataloads
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.importdataloads
- 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.importdataloads \
-H 'Content-Type: application/json' \
-d '{
"data": {
"dataLoads": [
{
"typedId": "string",
"type": "string",
"targetName": "string",
"sourceName": "string",
"continuous": true,
"incremental": true,
"incLoadDate": "string",
"calculationMessages": [
{}
],
"valid": "string"
}
]
}
}'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