Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Update a Custom Form Type
Create a Custom Form Type
List Custom Form Types
Delete a Custom Form Type
Create a Custom Form
Get a Custom Form
List Custom Forms
Change a Custom Form Status
Update a Custom Form
Delete a Custom Form
Duplicate a Custom Form
Create a Custom Form Revision
Preview a Custom Form Workflow
Update a Custom Form Type
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/fetch/CFOT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CFOT
- 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/fetch/CFOT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "module",
"operator": "equals",
"value": "QUOTING"
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7f5685597f-7p2tn", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/CFOT
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/CFOT
- 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/update/CFOT \
-H 'Content-Type: application/json' \
-d '{
"oldValues": {
"version": 3,
"typedId": "7.CFOT",
"uniqueName": "CFOT",
"label": "MyCustomFormType",
"headerFormulaName": "cflogic",
"embedded": false,
"module": "QUOTING",
"configuration": {
"default": {
"icon": "compress-arrows",
"name": "default",
"tabs": {
"details": {
"icon": "file-info-alt",
"name": "details",
"type": "details",
"translationKey": "dynamicTab_details"
}
},
"translationKey": "common_default"
}
},
"createDate": "2022-05-20T15:02:00",
"createdBy": 2147490696,
"lastUpdateDate": "2022-05-23T10:18:46",
"lastUpdateBy": 2147490696
},
"operationType": "update",
"textMatchStyle": "exact",
"data": {
"embedded": true,
"configuration": null,
"module": null,
"supportedParentTypeCodes": null,
"typedId": "7.CFOT",
"workflowFormulaName": null
}
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/CFOT
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/CFOT
- 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/CFOT \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "10.CFOT"
}
}'Response
application/json
{ "response": { "node": "string", "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