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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.fetchfilteredbyapprovable/active/{loginName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.fetchfilteredbyapprovable/active/{loginName}
- 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.fetchfilteredbyapprovable/active/john.priceResponse
application/json
{ "response": { "status": 0, "startRow": 0, "node": "<node>", "data": [ … ], "endRow": 1 } }
Request
Retrieves a list of workflows (based on filter settings) where the authenticated user participates. The request can be sent also with an empty body (without filters or paging) in order to retrieve all workflows. Returns all workflows if the authenticated user is the workflow admin.
Filter example:
Returns only workflows where document type = Quote and workflow status = Approved.
{
"data":{
"_constructor":"AdvancedCriteria",
"operator":"and",
"criteria":[
{
"fieldName":"code",
"operator":"equals",
"value":"Q"
},
{
"fieldName":"workflowStatus",
"operator":"equals",
"value":"APPROVED"
}
]
}
}Available for the following roles:
ADMIN_WO_USER_MGMT(General Admin (without User Management))SUPPORT(Investigate for Support)PRICESHOP_RO(View Quoting)PRICESHOP_EDIT(Edit Quoting)PB_PRICEGRIDS_RO(View LPG)WF_BUILDER(Manage Workflow Logics)RM_RAT(Manage Rebate Templates)RM_REBATEAGREEMENTS_RO(View Rebate Agreements)RM_REBATEAGREEMENTS(Manage Rebate Agreements)WF_BUILDER(Manage Workflow Logics)CONTRACTS_RO(View A&P)CM_CONTRACTMANAGER(Manage A&P module)CONTRACTS_RO(View A&P)WF_ADMIN(Manage Workflows)SC_COMPENSATIONS_RO(View Compensation Plans)SC_ADMIN(Administer Sales Compensations module)
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/workflowsmanager.fetch
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.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/workflowsmanager.fetch \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "workflowStatus",
"operator": "equals",
"value": "SUBMITTED"
}
]
}
}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "<node>", "csrfToken": "<token>", "data": [ … ], "endRow": 1 } }
Request
Retrieves workflow details of the approvable object.
See the Workflows article to find out which documents types can have approval workflows.
Available for the following roles:
ADMIN_WO_USER_MGMT(General Admin (without User Management))SUPPORT(Investigate for Support)PRICESHOP_RO(View Quoting)PB_PRICELISTS_RO(View Price Lists)PB_PRICEGRIDS_RO(View LPG)RM_REBATEAGREEMENTS_RO(View Rebate Agreements)RM_REBATEAGREEMENTS(Manage Rebate Agreements)RM_REBATERECORDS(Manage Rebate Records)RM_REBATERECORDS_RO(View Rebate Records)CONTRACTS_RO(View A&P)CM_CONTRACTS(Manage A&P)CLM_CLAIM(Use Claims)WF_ADMIN(Manage Workflows)PO_MODELRECORDS_RO(View Policy Records)PO_MODELRECORDS_APPROVAL(Approve Policy Records)MODULECATEGORY_MO_RO(View Model in Module Category)SC_COMPENSATIONS_RO(View Compensation Plans)
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.fetchdetailsviaapprovable/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.fetchdetailsviaapprovable/{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/workflowsmanager.fetchdetailsviaapprovable/2147491330.QResponse
application/json
{ "response": { "node": "e2e-staging-node", "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