The Pricefx Backend API

Copy

• Copy 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

Creates a default Data Source (Product, Customer, Unit of Measures, Currencies, or Calendar). Use this endpoint if default Data Sources have not been created when setting up the partition.

Note: When no path parameter is passed, all default Data Sources are dropped and recreated - any data will be lost. Othwerise, only the Data Source indicated by the path param is dropped and recreated.

Uploads a file to the Data Manager (specified by typeId in the path parameter).

To import data into FieldCollection (DMT or DMDS), use the datamart.loadfc/{typedId} endpoint.

Follow these steps to upload a file:

1. Create an upload slot and retrieve the slotId using the /uploadmanager.newuploadslot endpoint (see Product Image > 1. Create an Upload Slot).
2. Upload the file using the /datamart.importfile/{slotId}/{typedId} endpoint.

When importing a CSV file, it is possible to include more information than just a column name.
Example:

columName1:NUMBER:KEY,columnName2:TEXT:DIM,columnName3:NUMBER
a,1,0.5
b,1,0.6
c,2,1.2
d,3,2.0

In the example above you can see that columnName1 column should be the NUMBER field type and also the key (KEY).
The columnName2 column should be the TEXT type and a dimension (DIM).
The columnName3 column should be a NUMBER.
Possible field types: BOOLEAN, CURRENCY, DATE, DATETIME, INTEGER, LOB, MONEY, NUMBER, QUANTITY, TEXT, UOM

Information: When using datamart.importfile to upload a file with huge numbers (20+ significant decimal digits) it is recommended to use the Avro format. In CSV and XLSX files, you can use numbers within the double type or long type ranges.

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
  • uniqueName
  • label*
  • fields
• for DMT
  • name
  • label
  • fields*
  • owner – the ModeObject typedId that owns the table. * fields is 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.