Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Get Condition Record Set Items With Set Id Validation
Update a Condition Record Set
Add a Condition Record Set
List Condition Record Sets
Delete a Condition Records Set
Get a Condition Record Item
Add a Condition Record Item Attribute Meta
Update a Condition Record Item Attribute Meta
Get a Condition Record Item Attribute Meta
Delete a Condition Record Item Attribute Meta
Get Condition Record Set...
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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/CRCIM
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/CRCIM
- 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/delete/CRCIM \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "12.CRCIM"
},
"operationType": "remove"
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7599bbd56-75vcd", "data": [ … ], "status": 0 } }
Request
Retrieves Condition Record Items with 3 keys (CRCI3) from the specified Condition Record Set.
You can use the
CRCI1..CRCI12type codes in the path to retrieve Condition Record Items with different number of keys. You can check for mandatory parameters, e. g.conditionRecordSetId.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/conditionrecordset.fetch/CRCI3
- URL:https://companynode.pricefx.com/pricefx/companypartition/conditionrecordset.fetch/CRCI3
- 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/conditionrecordset.fetch/CRCI3 \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": {
"type": "object"
},
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "unitOfMeasure",
"operator": "iContains",
"value": "kg"
},
{
"fieldName": "conditionRecordSetId",
"operator": "equals",
"value": 3
}
]
}
}'Response
application/json
- Example 1
- Example 2
{ "response": { "data": [ … ], "endRow": 2, "totalRows": 2, "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