Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Copy a Lookup Table
Upsert a Lookup Table Value
Update a Lookup Table Value
Delete a Lookup Table Value
Mass Delete Lookup Table Values
Add a Lookup Table Value
List All Lookup Table Values
List All Lookup Tables
Add a Lookup Table
Delete a Lookup Table
Delete Column Values (Matrix only)
Insert Bulk Data to Lookup Table
Update a Lookup Table
Get Logic References
Mass Edit
Copy a Lookup Table
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
Inserts multiple records to the specified Lookup Table.
The /loaddata operation is a very efficient and quick way to insert bulk data. The main advantage is its greater speed when loading thousands of records (compared to e.g. /integrate).
Security
basic or X-PriceFx-jwt
We used /lookuptablemanager.loaddata/MLTV in the request example to insert bulk data to Matrix Lookup Table. Notice that the lookupTable is used in the header section and then ID of the Lookup Table in the data section
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.loaddata/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.loaddata/{TypeCode}
- 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/lookuptablemanager.loaddata/MLTV \
-H 'Content-Type: application/json' \
-d '{
"data": {
"header": [
"attribute1",
"lookupTable"
],
"data": [
[
"att1-1",
"2147484051"
],
[
"att1-2",
"2147484051"
],
[
"att1-3",
"2147484051"
]
]
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.copy/{tableId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.copy/{tableId}
- 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/lookuptablemanager.copy/{tableId}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "status": 0 } }
Request
Updates a Lookup Table.
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLE_UPDATE | Administer Price Parameters (PB_PARAMETERS), Administer Plasma (PLASMA) |
Security
basic or X-PriceFx-jwt
Enter values you want to update in the "field name = value" fashion. Multiple field values in one request can be updated.
Specify values of the object before the update. Especially important are typedId (to identify the object to update) and version (to detect date inconsistencies).
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.update
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.update
- 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/lookuptablemanager.update \
-H 'Content-Type: application/json' \
-d '{
"data": {
"label": "The New Label",
"status": "ACTIVE",
"typedId": "2147484051.LT"
},
"oldValues": {
"version": 0,
"typedId": "2147484051.LT",
"uniqueName": "pp02",
"label": null,
"validAfter": "2021-10-20",
"status": "INACTIVE",
"simulationSet": null,
"type": "MATRIX",
"valueType": "MATRIX",
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"hideWarnings": false,
"formatType": null,
"lastUpdateByName": "admin",
"createdByName": "admin",
"numberOfKeyFields": 1,
"createDate": "2021-10-20T11:44:07",
"createdBy": 2147490696,
"lastUpdateDate": "2021-10-20T11:44:07",
"lastUpdateBy": 2147490696,
"id": 2147484051,
"isPlasma": false
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "string", "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