Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete Datamart Orphan Objects
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)
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 Ob...
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
Returns a list of orphan Datamart objects. Identifies and returns details about objects considered obsolete. Objects such as:
- Datamart Tables with missing owners.
- Data Loads for which the target Field Cache was deleted.
- Analytics (PriceAnalyzer) tables without a matching deployed Field Cache (FC).
By default this endpoint works in the dry run mode to mitigate accidental deletions. Actual deletions require adding explicit /delete in the endpoint URL.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.deleteobsoletes
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.deleteobsoletes
- 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.deleteobsoletesResponse
application/json
{ "response": { "data": [ … ], "status": 0 } }
Request
Deletes orphan Datamart objects. Identifies and deletes objects considered obsolete. Objects such as:
- Datamart Tables with missing owners.
- Data Loads for which the target Field Cache was deleted.
- Analytics (PriceAnalyzer) tables without a matching deployed Field Cache (FC).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.deleteobsoletes/delete
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.deleteobsoletes/delete
- 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.deleteobsoletes/deleteResponse
application/json
{ "response": { "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