Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Mass Delete Lookup Table Values
Upsert a Lookup Table Value
Update a Lookup Table Value
Delete a Lookup Table Value
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
Mass Delete 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
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 } }
Request
Deletes records from the specified Company Parameters table (LookupTable). A filter can be applied (see the request example).
| 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}/batch
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.delete/{tableId}/batch
- 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}/batch?dataLocale=en' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "upperBound",
"operator": "equals",
"value": 30
}
]
}
}
}'Response
application/json
{ "response": { "node": "<node>", "data": [ … ], "status": 0 } }
Request
Creates a new LookupTableValue or MatrixLookupTableValue record in the LookupTable (Company Parameter table).
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLE_ADD | 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.add/{tableId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.add/{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.add/{tableId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"name": "recordName",
"value": "recordValue"
},
"operation": "add"
}'Response
application/json
{ "response": { "node": "e2e-templates-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