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}
Request
Deletes a delegation and returns the deleted delegation details.
A delegation where
status=ACTIVATEDcannot be deleted. Only delegations that have not been activated yet (startDateis in the future) can be deleted. Use the /workflowdelegationmanager.enddate endpoint to terminate an activated workflow delegation.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowdelegationmanager.delete
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowdelegationmanager.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/workflowdelegationmanager.delete \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "12.WD"
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowdelegationmanager.update
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowdelegationmanager.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/workflowdelegationmanager.update \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "12.WD",
"note": "Please, check approvals. I'\''m on vacation until Thursday."
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "status": 0 } }
Request
Terminates an activated workflow delegation. Returns details of the terminated workflow delegation.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowdelegationmanager.enddate
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowdelegationmanager.enddate
- 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/workflowdelegationmanager.enddate \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "99.WD"
}
}'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