Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete 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 Column Values (Matrix only)
Insert Bulk Data to Lookup Table
Copy a Lookup Table
Update a Lookup Table
Get Logic References
Mass Edit
Delete 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
Creates a new LookupTable.
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLE_ADD | Administer Price Parameters (PB_PARAMETERS), Administer Plasma (PLASMA) |
Security
basic or X-PriceFx-jwt
The request must contain all fields that are part of the business key for that object and all non-nullable fields.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.add
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.add
- 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 \
-H 'Content-Type: application/json' \
-d '{
"data": {
"uniqueName": "pp01",
"label": "Price Parameter 001",
"validAfter": "2021-10-06",
"type": "MATRIX",
"valueType": "MATRIX",
"status": "ACTIVE",
"formatType": "MONEY_USD",
"userGroupEdit": "Administrators"
},
"operation": "add"
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Deletes a Lookup Table specified by typedId.
| Required Permission | Roles with the Required Permission |
|---|---|
| LOOKUPTABLE_REMOVE | Administer Price Parameters (PB_PARAMETERS), Administer Plasma (PLASMA) |
Security
basic or X-PriceFx-jwt
Specify the typedId of the Lookup Table (Company Parameters) you want to delete.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.delete
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.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/lookuptablemanager.delete \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147484036.LT"
}
}'Response
application/json
{ "response": { "node": "<node>", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.resetcolumn/{tableId}/{columnName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/lookuptablemanager.resetcolumn/{tableId}/{columnName}
- 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.resetcolumn/{tableId}/{columnName}'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