Pricefx REST API Reference
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}
See the Key-Value Database Storage Knowledge Base article for more details.
Operations
Bodyapplication/json
The sample request creates a table with four columns: sku, customer, record and payload (TEXT).
Note: The “payload” column is always added automatically and must not be present in the creation definition.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.createtable/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.createtable/{tableName}
- 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/kvservice.createtable/{tableName}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"keys": [
{
"columnType": "TEXT",
"columnName": "sku",
"isPrimaryKey": true
},
{
"columnType": "TEXT",
"columnName": "customer",
"isPrimaryKey": true
},
{
"columnType": "INT",
"columnName": "record",
"isIndexed": true
}
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.droptable/{tableName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.droptable/{tableName}
- 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/kvservice.droptable/{tableName}' \
-H 'Content-Type: application/json' \
-d '{}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.listtables
- URL:https://companynode.pricefx.com/pricefx/companypartition/kvservice.listtables
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/kvservice.listtablesResponse
application/json
{ "response": { "node": "node", "csrfToken": "token", "data": [ … ], "status": 0 } }
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