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
Retrieves a list of workflow delegations. A filter can be applied to return Initialized, Activated, or EndDated workflow delegations only. See the example below.
The Filter Example: Returns only active delegations (status = ACTIVATED.)
{
"data":{
"_constructor":"AdvancedCriteria",
"operator":"and",
"criteria":[
{
"fieldName":"status",
"operator":"equals",
"value":"ACTIVATED"
}
]
}
}Security
basic or X-PriceFx-jwt
The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
Default 300
The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowdelegationmanager.fetch
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowdelegationmanager.fetch
- 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.fetch \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "status",
"operator": "equals",
"value": "ENDDATED"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
Request
Checks delegation for conflicts. Always use this operation before /workflowdelegationmanager.add to prevent invalid date conflicts in the new delegation. Use the same payload as for the /workflowdelegationmanager.add operation.
Security
basic or X-PriceFx-jwt
The name of the user whose workflow you want to delegate.
The name of the user you want to delegate a workflow to.
The date from which the workflow delegation should come into effect.
The date until which the workflow delegation should be effective.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowdelegationmanager.checkdates
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowdelegationmanager.checkdates
- 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.checkdates \
-H 'Content-Type: application/json' \
-d '{
"data": {
"sourceUser": "John Doe",
"targetUser": "Kate Smith",
"startDate": "2021-11-23T08:19:13.941Z",
"endDate": "2021-11-23T08:19:21.940Z",
"note": "Please, check all new quotes. I'\''m on vacation.",
"sourceUserId": "2147490806",
"targetUserId": "2147490696"
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0 } }
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 } }
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