Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Mass Edit
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
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)
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
Mass Edit
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.updatedataload
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.updatedataload
- 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.updatedataload \
-H 'Content-Type: application/json' \
-d '{
"data": {
"version": 2,
"typedId": "2147484683.DMDL",
"label": "DL01",
"type": "DS_PRODUCTS",
"targetName": "DMDS.DS001",
"withTargetSnapshot": false,
"calcItemsLookupTableId": 2147484066,
"schedules": [],
"numberOfItems": 0,
"calculationConfig": {
"feederInputParams": [],
"inputParams": [],
"mappingParams": [],
"outputElements": []
},
"requestTime": 1638456932000,
"lastUpdateTime": 1638456932000,
"createDate": "2021-12-02T14:55:32",
"createdBy": 2147490696,
"lastUpdateDate": "2021-12-02T14:55:32",
"lastUpdateBy": 2147490696,
"status": "DRAFT",
"isDefault": false,
"incremental": true,
"distributed": false,
"continuous": false,
"valid": false,
"isPlasma": false
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-f465f654b-wjkpv", "data": [ … ], "status": 0 } }
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 } }
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