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
Denies a document specified by the currentStepId. Allows you to add a comment in the request body.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.deny/{currentStepId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.deny/{currentStepId}
- 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/workflowsmanager.deny/2d721e9d-ac6d-4eda-bd6c-60424f4fdaef \
-H 'Content-Type: application/json' \
-d '{
"data": {
"actionComment": "Not approved - the margin is too low."
}
}'Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.withdraw/{currentStepId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.withdraw/{currentStepId}
- 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/workflowsmanager.withdraw/2d721e9d-ac6d-4eda-bd6c-60424f4fdaefResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Security
basic or X-PriceFx-jwt
userLoginNames or userGroupNames must be provided.
userLoginNames or userGroupNames must be provided.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.addapprover/{currentStepId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.addapprover/{currentStepId}
- 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/workflowsmanager.addapprover/2d721e9d-ac6d-4eda-bd6c-60424f4fdaef \
-H 'Content-Type: application/json' \
-d '{
"data": {
"addStepCurrentStepId": "448a0229-0488-4f3a-a13d-481936ad01dd",
"addStepStepInstance": {
"uniqueName": "Additional check",
"reason": "Check this",
"userLoginName": null,
"userGroupName": null,
"emailAttachment": false,
"properties": {},
"userLoginNames": [
"JohnDoe"
],
"userGroupNames": [],
"minApprovalsNeeded": 1
}
}
}'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