Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Update a Lookup Table Value
Upsert 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
Copy a Lookup Table
Update a Lookup Table
Get Logic References
Mass Edit
Update a Lookup Table Val...
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 new Company Parameter record (LookupTableValue or MatrixLookupTableValue) or updates an existing record (if the specified name of the record already exists).
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLEVALUES_INTEGRATE | Data Integration (DATAINTEGRATION) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.integrate/{tableId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.integrate/{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.integrate/{tableId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"name": "tofu",
"value": "0.05"
}
}'Response
application/json
{ "response": { "node": "<node>", "data": [ … ], "status": 0 } }
Request
Updates LookupTableValue. Returns a list of updated LookupTableValue/MatrixLookupTableValue objects.
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLE_UPDATE | Administer Price Parameters (PB_PARAMETERS), Administer Plasma (PLASMA) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.update/{tableId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.update/{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.update/{tableId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147497641.MLTV",
"attribute1": "250"
},
"oldValues": {
"version": 10,
"typedId": "2147497641.MLTV",
"lastUpdateByName": "admin",
"createdByName": "admin",
"tableId": null,
"type": "MATRIX",
"valueType": "MATRIX",
"lookupTableTypedId": "2147484036.LT",
"createDate": "2021-10-06T10:53:52",
"createdBy": 2147490696,
"lastUpdateDate": "2021-10-06T13:20:24",
"lastUpdateBy": 2147490696,
"attribute1": null,
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null,
"name": "matrixValue"
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "<node>", "data": [ … ], "status": 0 } }
Request
Deletes a record (LookupTableValue or MatrixLookupTableValue) from the specified Company Parameters table (LookupTable).
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLE_REMOVE | Administer Price Parameters (PB_PARAMETERS), Administer Plasma (PLASMA) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.delete/{tableId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.delete/{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.delete/{tableId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147497641.MLTV"
}
}'Response
application/json
{ "response": { "node": "<node>", "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