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}
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 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.addwatcher/{currentStepId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.addwatcher/{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.addwatcher/2d721e9d-ac6d-4eda-bd6c-60424f4fdaef \
-H 'Content-Type: application/json' \
-d '{
"data": {
"addStepCurrentStepId": "4c93094e-a9ba-4c84-aed7-fc5464742903",
"addStepStepInstance": {
"uniqueName": "Watcher Step",
"reason": "Watch this",
"userLoginName": null,
"userGroupName": null,
"emailAttachment": false,
"properties": {},
"userLoginNames": [
"JohnDoe"
],
"userGroupNames": [],
"emails": null
}
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
This feature is experimental in version 14.0 - Caribou Lou.
Updates the review status of the specified line items in the Review step of the Collaboration Workflow. The request can only be executed by a member of the User Group that is currently authorized to review the associated input fields, as defined in the Creation Workflow configuration. If the user does not have the required permissions, the request will fail.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/review.update/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/review.update/{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/review.update/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'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