Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete 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
Update a Custom Form
Duplicate a Custom Form
Create a Custom Form Revision
Preview a Custom Form Workflow
Delete 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}
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 } }
Request
Creates a copy of the specified Custom Form. The copy includes inputs, outputs, and embedded objects. Returns the duplicated Custom Form.
Duplicated Custom Form fields:
The Custom Form has an origin and it is not deleted
originCustomFormId, originDeleted, originLabel, originUniqueName fields in the duplicated CFO object contain a copy of corresponding fields from the original Custom Form.
The Custom Form origin has been deleted
originCustomFormId is the id of the original Custom Form, originDeleted set to true. originLabel and originUniqueName fields are null.
The Custom Form does not have an origin (the CFO is not duplicated)
originCustomFormId, originDeleted, originLabel, originUniqueName fields have a null value.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/customform.duplicate/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/customform.duplicate/{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.duplicate/123.CFO \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-8bdb777df-dn9xf", "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