Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Update a Custom Form
Create a Custom Form Type
List Custom Form Types
Update a Custom Form Type
Delete a Custom Form Type
Create a Custom Form
Get a Custom Form
List Custom Forms
Change a Custom Form Status
Delete a Custom Form
Duplicate a Custom Form
Create a Custom Form Revision
Preview a Custom Form Workflow
Update a Custom Form
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/customform.changestatus/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/customform.changestatus/{typedId}
- 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/customform.changestatus/235.CFO \
-H 'Content-Type: application/json' \
-d '{
"data": {
"operation": "SUBMIT, REVOKE, WITHDRAW"
}
}'Response
application/json
{ "response": { "node": "string", "data": { … }, "status": 0 } }
Request
Allows you to update Label, User Group (Edit), and User Group (View Details) fields of the specified Custom Form.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/customform.update
- URL:https://companynode.pricefx.com/pricefx/companypartition/customform.update
- 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/customform.update \
-H 'Content-Type: application/json' \
-d '{
"data": {
"label": "Test Custom Form",
"userGroupEdit": "Administrators",
"userGroupViewDetails": "Administrators",
"typedId": "238.CFO"
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "string", "data": { … }, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/customform.delete
- URL:https://companynode.pricefx.com/pricefx/companypartition/customform.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/customform.delete \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedIds": [
"332.CFO",
"334.CFO"
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 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