Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Datamart Orphan Objects
List Data Manager Entities
Execute a Data Load Logic
Get a DM Object
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
Delete Datamart Orphan Objects
List Datamart Orphan Obje...
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
Creates a DMFieldCollection from a multipart/form-data body containing the schema (JSON – the DMFieldCollection DTO) as a first part and the data (AVRO format) as second part. Fails if the specified DMFieldCollection already exists.
The first part contains information about the schema of the Field Collenction to be created:
- for DMDataSource
uniqueNamelabel*fields
- for DMT
namelabelfields*owner– the ModeObjecttypedIdthat owns the table. *fieldsis a list of the DMFields specification.
The second part contains the table data in the AVRO format. The data schema must comply with the one given in the first part.
An existing table will be overriden (deletes an existing one, creates a new one).
This is an endpoint dedicated for remote services (such as Optimization Engine or Python Engine). It is very strict by design in order to ensure that the uploaded data ends up exactly in the same format in the platform.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.createfc/{fcType}
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.createfc/{fcType}
- 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.createfc/DMDS \
-H 'Content-Type: multipart/form-data'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 } }
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code