- Created by Jan Panoušek, last modified on Aug 18, 2021
- Mentions
- 0 Associations
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 59 Next »
On this page:
Note:
- Certain data elements (e.g. lookup table values of any table, including JSON lookup tables / pricing params) should NOT be retrieved with the generic fetch commands. Always use the "...manager.fetch" API endpoints where they are available. The same applies to update/delete/integrate commands.
- These entities can intentionally be fetched by any user without any particular user role: CN, BR, CS, CLLIAM, CTAM, CTT, CTTAM, C, CAM, CXAM, DMDC, DMF, DMDL, DMDS, DM, DMM, DMR, DMSSCALC, DMSIM, DMT, DCRAM, FN, IE, JST, JLTVM, MPLIT, MPLAM, MLTVM, MRAM, MT, PYRAM, PGIM, PRAM, PLIM, P, PAM, PXAM, QAM, RBAAM, RRAM, RRS, RRSC, RBT, RBTAM, SC, SCN, SCNAM, SIM, SIAM, UG.
How to Access the API
The URL to access the API is always in the format https://{base url}/pricefx/{partition}/{api}
where the value for {base url} is the same as the URL used to access your partition. When configuring a solution, always check that your base URL matches the domain name of the Pricefx instance that you intend to call.
Master Data
Action | Description | Request | Response |
---|---|---|---|
Upsert Product | Updates or creates a product. If the product does not exist yet, at least the "sku" must be specified in the payload. | /pricefx/{partition}/integrate/P
Payload Expand source
{ "data":{ "typedId":"10947740.P", "sku":"P-12535", "attribute2":"20" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 1, "typedId": "10947740.P", "sku": "P-12535", "label": null, "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": null, "formulaName": null, "image": null, "createDate": "2020-11-25T13:03:35", "createdBy": 5351, "lastUpdateDate": "2020-11-25T13:03:35", "lastUpdateBy": 5351, "attribute1": null, "attribute2": "20", "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } |
Upsert Multiple Products | Updates or creates several products simultaneously. If a product does not exist yet, at least the "sku" must be specified in the payload. | /pricefx/{partition}/integrate/P
Payload Expand source
[ { "data":{ "sku":"PC-150001", "label":"PC-150001", "attribute2":"20" } }, {"data":{ "sku":"PC-150002", "label":"PC-150002", "attribute2":"20" } } ] |
Response Expand source
[ { "response": { "node": "user1", "data": [ { "version": 1, "typedId": "2172502967.P", "sku": "PC-150001", "label": "PC-150001", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": null, "formulaName": null, "image": null, "createDate": "2021-05-10T11:57:30", "createdBy": 5351, "lastUpdateDate": "2021-05-10T11:57:30", "lastUpdateBy": 5351, "attribute1": null, "attribute2": "20", "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } }, { "response": { "node": "user1", "data": [ { "version": 1, "typedId": "2172502968.P", "sku": "PC-150002", "label": "PC-150002", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": null, "formulaName": null, "image": null, "createDate": "2021-05-10T11:57:30", "createdBy": 5351, "lastUpdateDate": "2021-05-10T11:57:30", "lastUpdateBy": 5351, "attribute1": null, "attribute2": "20", "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } ] |
Delete Product | Deletes a product specified by its typedId. | /pricefx/{partition}/delete/P
Payload Expand source
{ "data":{ "typedId":"2166210775.P" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 0, "typedId": "2166210775.P", "sku": "PP100232", "label": "Product 01", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": null, "formulaName": null, "image": false, "createDate": "2020-09-15T11:52:39", "createdBy": 5351, "lastUpdateDate": "2020-09-15T11:54:38", "lastUpdateBy": 5351, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } |
Add Product image | Adds the specified image to the specified product. | This is a little tricky but you can try to use (after necessary customization) our example that comes as a: There are variables whose values you must set (SERVER, PARTITION, UPLOAD_SLOT, SKU, etc.). Then you have to specify the file that you want to upload. In the Postman collection, you select a file in the Upload Picture step on the Body tab. | |
Upsert Customer | Updates or creates a customer. If the customer does not exist yet, at least the "customerId" must be specified in the payload. | /pricefx/{partition}/integrate/C
Payload Expand source
{ "data":{ "customerId":"Customer007", "attribute1":"25" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 1, "typedId": "2154738392.C", "customerId": "Customer007", "name": null, "parentId": null, "userGroupEdit": null, "userGroupViewDetails": null, "nodeId": 2154738392, "createDate": "2020-11-25T13:35:11", "createdBy": 5351, "lastUpdateDate": "2020-11-25T13:35:11", "lastUpdateBy": 5351, "attribute1": "25", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "isParent": false } ], "status": 0 } } |
Delete Customer | Deletes a customer specified by its typedId. | /pricefx/{partition}/delete/C
Payload Expand source
{ "data":{ "typedId":"2153963199.C" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 0, "typedId": "2153963199.C", "customerId": "Customer01", "name": "Customer 01", "parentId": null, "userGroupEdit": null, "userGroupViewDetails": null, "nodeId": 2153963199, "createDate": "2020-09-15T13:06:54", "createdBy": 5351, "lastUpdateDate": "2020-09-15T13:08:08", "lastUpdateBy": 5351, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "isParent": false } ], "status": 0 } } |
Upsert Product Extension | Updates or creates a Product Extension. The payload must specify at least the PX "name" (category) and the product's "sku". | /pricefx/{partition}/integrate/PX
Payload Expand source
{ "data":{ "sku":"PC-145927", "name":"ProductClass", "attribute1":"High" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 1, "typedId": "2211858234.PX30", "name": "ProductClass", "sku": "PC-145927", "createDate": "2020-11-25T14:27:29", "createdBy": 5351, "lastUpdateDate": "2020-11-25T14:27:29", "lastUpdateBy": 5351, "attribute1": "High", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } |
Delete Product Extension | Deletes a Product Extension specified by its typedId. | /pricefx/{partition}/delete/PX
Payload Expand source
{ "data":{ "typedId":"6561099.PX10" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 0, "typedId": "6561099.PX10", "name": "Performance", "sku": "ProductXT01", "createDate": "2020-09-15T13:12:56", "createdBy": 5351, "lastUpdateDate": "2020-09-15T13:12:56", "lastUpdateBy": 5351, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null } ], "status": 0 } } |
Upsert Customer Extension | Updates or creates a customer extension. The payload must specify the CX "name" (category) and "customerId". | /pricefx/{partition}/integrate/CX
Payload Expand source
{ "data":{ "name":"CustomerType", "customerId":"customer_02", "attribute1":"Restaurant" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 1, "typedId": "2148099377.CX30", "name": "CustomerType", "customerId": "customer_02", "createDate": "2020-11-25T14:07:15", "createdBy": 5351, "lastUpdateDate": "2020-11-25T14:07:15", "lastUpdateBy": 5351, "attribute1": "Restaurant", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } |
Delete Customer Extension | Deletes a Customer Extension specified by its typedId. | /pricefx/{partition}/delete/CX
Payload Expand source
{ "data":{ "typedId":"2148099220.CX30" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 0, "typedId": "2148099220.CX30", "name": "Ondrej_test", "customerId": "CustomerXT01", "createDate": "2020-09-15T13:39:32", "createdBy": 5351, "lastUpdateDate": "2020-09-15T13:39:32", "lastUpdateBy": 5351, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } |
Upsert Price Parameter value | Updates a Price Parameter value or creates a new name-value pair. The URL contains the PP table ID. | /pricefx/{partition}/lookuptablemanager.integrate/{tableId}
Payload Expand source
{ "data":{ "name":"Beef", "value":"0.05" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 2, "typedId": "2148090891.LTV", "name": "Beef", "value": "405", "lowerBound": null, "upperBound": null, "lastUpdateByName": "admin", "createdByName": "admin", "tableId": 2147488006, "type": "SIMPLE", "valueType": "STRING", "rawValue": "405", "createDate": "2020-11-25T14:48:08", "createdBy": 5351, "lastUpdateDate": "2020-11-25T14:49:29", "lastUpdateBy": 5351 } ], "status": 0 } } |
Delete Price Parameter value | Updates a value in a Price Parameter. The URL contains the PP table ID. In the payload example, we specify the new "null" value for attribute3 in the data section. In the oldValues section we can see that the current value is "101". In the response, the value of attribute3 is already "null". | /pricefx/{partition}/lookuptablemanager.update/{tableId}
Payload Expand source
//deleting the value of attribute3 { "data": { "typedId": "1849972.MLTV", "value": "406" }, "oldValues": { "version": 2, "typedId": "1849972.MLTV", "lastUpdateByName": "User101", "createdByName": null, "tableId": 31705, "type": "MATRIX", "valueType": "MATRIX", "lookupTableTypedId": "31705.LT", "createDate": "2015-10-29T10:19:34.000", "createdBy": 51, "lastUpdateDate": "2020-09-15T14:33:41.000", "lastUpdateBy": 5351, "attribute1": "3", "attribute2": null, "attribute3": "101", "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "name": "3" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 3, "typedId": "1849972.MLTV", "lastUpdateByName": "User101", "createdByName": null, "tableId": 31705, "type": "MATRIX", "valueType": "MATRIX", "lookupTableTypedId": "31705.LT", "createDate": "2015-10-29T10:19:34", "createdBy": 51, "lastUpdateDate": "2020-09-15T14:34:35", "lastUpdateBy": 5351, "attribute1": "3", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "name": "3" } ], "status": 0 } } |
User Admin
Action | Description | Request | Response |
---|---|---|---|
Create user | Creates a new user. The login name and email address are required. | /pricefx/{partition}/add/U
Payload Expand source
{ "data":{ "activated":true, "loginName":"p.roglic", "email":"primoz.roglic@jumbo-visma.com", "firstName":"Primoz", "lastName":"Roglic" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 0, "typedId": "2147484390.U", "loginName": "p.roglic", "firstName": "Primoz", "lastName": "Roglic", "email": "primoz.roglic@jumbo-visma.com", "groups": null, "businessRoles": null, "activated": true, "workflowEmailingActivated": true, "noSession": false, "requireTFA": false, "receiveAdminEmail": false, "ssoOnly": false, "wizardDashboardName": null, "firstLogin": false, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "emailLocale": null, "defaultUserGroupEdit": null, "defaultUserGroupViewDetails": null, "productFilterCriteria": null, "customerFilterCriteria": null, "roleNames": [], "allRoleNames": [], "allGroups": [], "createDate": "2020-09-15T14:54:30", "createdBy": 5351, "lastLogin": null, "lastUpdateBy": 5351, "extendedData": null, "passwordExpiry": null } ], "status": 0 } } |
Modify user | Enables you to modify any filed in the User Admin. The payload example adds the value "Admin" to the firstName which was previously null. | /pricefx/{partition}/update/U
Payload Expand source
{ "data":{ "typedId":"2147484126.U", "firstName":"Admin" }, "oldValues":{ "version":84, "typedId":"2147484126.U", "loginName":"admin", "email":"admin@pricefx.eu", "activated":true, "workflowEmailingActivated":true, "noSession":false, "requireTFA":false, "receiveAdminEmail":false, "ssoOnly":false, "firstLogin":false, "createDate":"2020-01-06T15:51:05", "createdBy":5351, "lastLogin":"2020-08-19T08:03:37.000", "lastUpdateBy":51, "firstName":null, "lastName":null, "passwordExpiry":null, "defaultUserGroupEdit":null, "defaultUserGroupViewDetails":null, "emailLocale":null, "wizardDashboardName":null, "productFilterCriteria":null, "customerFilterCriteria":null, "additionalInfo1":null, "additionalInfo2":null, "additionalInfo3":null, "additionalInfo4":null } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 85, "typedId": "2147484126.U", "loginName": "admin", "firstName": "Admin", "lastName": null, "email": "admin@pricefx.eu", "groups": [ { "version": 1, "typedId": "3978.UG", "uniqueName": "SA", "label": "South America", "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "createDate": "2017-06-09T13:21:54", "createdBy": 5308, "lastUpdateDate": "2017-06-09T13:22:00", "lastUpdateBy": 5308 } ], "businessRoles": [], "activated": true, "workflowEmailingActivated": true, "noSession": false, "requireTFA": false, "receiveAdminEmail": false, "ssoOnly": false, "wizardDashboardName": null, "firstLogin": false, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "emailLocale": null, "defaultUserGroupEdit": null, "defaultUserGroupViewDetails": null, "productFilterCriteria": null, "customerFilterCriteria": null, "roleNames": [ "WF_ADMIN", "PB_PXREF_RO", "PRICESHOP_QUOTEADMIN", "PRICESHOP_EDIT", "PRICESHOP", "PB_PRODUCTEDITOR", "PB_PRODUCTS_RO", "PB_PDETAILSVIEW", "DB_EXPORT" ], "allRoleNames": [ "DB_EXPORT", "WF_ADMIN", "PB_PRODUCTS_RO", "PB_PXREF_RO", "PRICESHOP_QUOTEADMIN", "PB_PDETAILSVIEW", "PB_PRODUCTEDITOR", "PRICESHOP", "PRICESHOP_EDIT" ], "allGroups": [ { "version": 1, "typedId": "3978.UG", "uniqueName": "SA", "label": "South America", "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "createDate": "2017-06-09T13:21:54", "createdBy": 5308, "lastUpdateDate": "2017-06-09T13:22:00", "lastUpdateBy": 5308 } ], "createDate": "2020-01-06T15:51:05", "createdBy": 5351, "lastLogin": "2020-08-19T08:03:37", "lastUpdateBy": 5351, "extendedData": null, "passwordExpiry": null } ], "status": 0 } } |
Delete user | Deletes a user specified by its typedId. | /pricefx/{partition}/delete/U
Payload Expand source
{ "operationType": "remove", "textMatchStyle": "exact", "data": { "typedId": "2147484390.U" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 0, "typedId": "2147484390.U", "loginName": "p.roglic", "firstName": "Primoz", "lastName": "Roglic", "email": "primoz.roglic@jumbo-visma.com", "groups": [], "businessRoles": [], "activated": true, "workflowEmailingActivated": true, "noSession": false, "requireTFA": false, "receiveAdminEmail": false, "ssoOnly": false, "wizardDashboardName": null, "firstLogin": false, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "emailLocale": null, "defaultUserGroupEdit": null, "defaultUserGroupViewDetails": null, "productFilterCriteria": null, "customerFilterCriteria": null, "roleNames": [], "allRoleNames": [], "allGroups": [], "createDate": "2020-09-15T14:54:30", "createdBy": 5351, "lastLogin": null, "lastUpdateBy": 5351, "extendedData": null, "passwordExpiry": null } ], "status": 0 } } |
PriceAnalyzer
Action | Description | Request | Response |
---|---|---|---|
Get a list of Data Feeds | /pricefx/{partition}/datamart.getfcs/DMF | ||
Add or update Data Feed | Note: Adding or updating a DS will create a DF for it | /pricefx/{partition}/datamart.updatefc/DMDS | |
Upload data to Data Feed | /uploadmanager.newuploadslot -> "data":[{"id":"339"}] /datamart.importfile/{slot_id}/{df_typedId} | ||
Fetch data from Data Feed | /pricefx/{partition}/datamart.fetch/{df_typedId} | ||
Truncate Data Feed | Truncates a Data Feed specified by its name. | /pricefx/{partition}/datamart.rundataload (type TRUNCATE)
Payload Expand source
{"data":{ "type":"TRUNCATE", "targetName":"DMF.<DataFeedName>", "dtoFilter":{ } }} |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 617, "typedId": "2147483754.DMDL", "targetDate": null, "label": "test", "locale": null, "calculationMessages": "[\"Target has 0 rows before truncate\",\"Deleted 0 rows\"]", "type": "TRUNCATE", "targetName": "DMF.test", "sourceName": null, "sortBy": null, "sourceSortBy": null, "dtoFilter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "formulaResult", "value": "OK", "operator": "equals" } ], "operator": "and" }, "dtoSourceFilter": null, "withTargetSnapshot": false, "calculationContext": null, "allowBatching": null, "validationLogic": null, "schedules": null, "jstId": 2152108362, "progressInfo": null, "numberOfItems": 0, "actionUUID": "TruncateTask-VU9qm", "testRow": null, "testResult": null, "calculationConfig": { "skuField": null, "targetDateField": null, "simulationSet": null, "formulaName": null, "targetDate": null, "feederFormulaName": null, "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "requestTime": 1490172388000, "lastUpdateTime": 1600301068000, "loadCompleteTime": 1600301067000, "adhocDataLoadDefinition": null, "createDate": "2017-03-22T08:46:28", "createdBy": 5351, "lastUpdateDate": "2020-09-17T00:04:28", "lastUpdateBy": 5351, "status": "PENDING", "calculationStartDate": "2020-09-17T00:04:27", "calculationDate": "2020-09-17T00:04:27", "isDefault": true, "incremental": true, "distributed": false, "continuous": false, "valid": false, "isPlasma": false, "incLoadDate": "2020-09-17T00:04:27" } ], "status": 0 } } |
Get a list of Data Sources | /pricefx/{partition}/datamart.getfcs/DMDS | ||
Add or update Data Source | /pricefx/{partition}/datamart.updatefc/DMDS | ||
Upload data to Data Source | Note: Prefer Flush. | /uploadmanager.newuploadslot -> "data":[{"id":"340"}] | |
Flush data to Data Source | Parse and import from Data Feed. | /pricefx/{partition}/datamart.rundataload (type DS_FLUSH) | |
Fetch data from Data Source | /pricefx/{partition}/datamart.fetch/{ds_typedId} | ||
Truncate Data Source | Truncates a Data Source specified by its name. | /pricefx/{partition}/datamart.rundataload (type TRUNCATE)
Payload Expand source
{"data":{ "type":"TRUNCATE", "targetName":"DMDS.<DataSourceName>", "dtoFilter":{ } }} |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 4, "typedId": "2147483753.DMDL", "targetDate": null, "label": "test", "locale": null, "calculationMessages": "[\"Deleted 10 rows\"]", "type": "TRUNCATE", "targetName": "DMDS.test", "sourceName": null, "sortBy": null, "sourceSortBy": null, "dtoFilter": null, "dtoSourceFilter": null, "withTargetSnapshot": false, "calculationContext": null, "allowBatching": null, "validationLogic": null, "schedules": null, "jstId": 2152108244, "progressInfo": null, "numberOfItems": 10, "actionUUID": "TruncateTask-RinKt", "testRow": null, "testResult": null, "calculationConfig": { "skuField": null, "targetDateField": null, "simulationSet": null, "formulaName": null, "targetDate": null, "feederFormulaName": null, "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "requestTime": 1490172388000, "lastUpdateTime": 1496909886000, "loadCompleteTime": 1496909886000, "adhocDataLoadDefinition": null, "createDate": "2017-03-22T08:46:28", "createdBy": 5351, "lastUpdateDate": "2017-06-08T08:18:06", "lastUpdateBy": 5351, "status": "PENDING", "calculationStartDate": "2017-06-08T08:18:05", "calculationDate": "2017-06-08T08:18:06", "isDefault": true, "incremental": true, "distributed": false, "continuous": false, "valid": false, "isPlasma": false, "incLoadDate": "2017-06-08T08:18:05" } ], "status": 0 } } |
Get a list of Datamarts | /pricefx/{partition}/datamart.getfcs/DM | ||
Add or update Datamart | |||
Refresh Datamart from Data Sources | /pricefx/{partition}/datamart.rundataload (type DM_REFRESH) | ||
Fetch data from Datamart | /pricefx/{partition}/datamart.fetch/{dm_typedId} | ||
Truncate Datamart | Truncates a Datamart specified by its name. | /pricefx/{partition}/datamart.rundataload (type TRUNCATE)
Payload Expand source
{"data":{ "type":"TRUNCATE", "targetName":"DM.<DatamartName>", "dtoFilter":{ } }} |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 4, "typedId": "797.DMDL", "targetDate": null, "label": "Datamart", "locale": null, "calculationMessages": "[\"Deleted 0 rows\"]", "type": "TRUNCATE", "targetName": "DM.Datamart", "sourceName": null, "sortBy": null, "sourceSortBy": null, "dtoFilter": null, "dtoSourceFilter": null, "withTargetSnapshot": false, "calculationContext": null, "allowBatching": null, "validationLogic": null, "schedules": null, "jstId": 2152108462, "progressInfo": null, "numberOfItems": 0, "actionUUID": "TruncateTask-3yoOM", "testRow": null, "testResult": null, "calculationConfig": { "skuField": null, "targetDateField": null, "simulationSet": null, "formulaName": null, "targetDate": null, "feederFormulaName": null, "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "requestTime": 1447843525000, "lastUpdateTime": 1447843872000, "loadCompleteTime": 1447843872000, "adhocDataLoadDefinition": null, "createDate": "2015-11-18T10:45:25", "createdBy": 51, "lastUpdateDate": "2015-11-18T10:51:12", "lastUpdateBy": 51, "status": "PENDING", "calculationStartDate": "2015-11-18T10:51:12", "calculationDate": "2015-11-18T10:51:12", "isDefault": true, "incremental": true, "distributed": false, "continuous": false, "valid": false, "isPlasma": false, "incLoadDate": "2015-11-18T10:51:12" } ], "status": 0 } } |
Note: When using datamart.importfile to upload a file with huge numbers (20+ significant decimal digits) it is recommended to use the Avro format. In CSV and XLSX files, you can use numbers within the double type or long type ranges.
PriceBuilder
Action | Description | Request | Response |
---|---|---|---|
Get a list of Price Lists | Fetches a list of Price Lists existing in the partition. | /pricefx/{partition}/fetch/PL
Payload Expand source
{ "startRow": 0, "endRow": 300, "data": {} } |
Response Expand source
{ "response": { "node": "user1", "startRow": 0, "data": [ { "version": 6, "typedId": "14239.PL", "targetDate": "2015-08-24", "label": "TC based Price List", "locale": "en", "calculationMessages": "[\"(10) Formula not found for 10\"]", "numberOfItems": 49, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"Listprice\",\"Net_Margin_pct\",\"Rebate\",\"Target_Discount\", \"Base\",\"Prod_Class_Adj\",\"StandardDiscount\",\"Volume_Discount\",\"Invoice_Price\"],\"hiddenElementNames\":[], \"resultElementName\":\"Invoice_Price\",\"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"TC_Logic\", \"formulaParameters\":{\"Customer\":\"CD-00081\"},\"notifyWhenFinished\":\"NONE\"}", "errorMode": "ABORT", "pricelistType": "SIMPLE", "approvalState": "NOT_APPROVED", "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 5351, "updateDate": "2020-02-27", "createDate": "2015-08-24T08:59:11", "createdBy": 51, "lastUpdateDate": "2020-02-27T14:42:04", "lastUpdateBy": 5351, "status": "READY", "calculationStartDate": "2020-02-27T14:42:04", "calculationDate": "2020-02-27T14:42:04", "id": 14239 }, { "version": 11, "typedId": "14240.PL", "targetDate": "2015-08-24", "label": "TEST TO REMOVE", "locale": "en", "calculationMessages": "[]", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"Listprice\",\"Net_Margin_pct\",\"Target_Discount\",\"StandardDiscount\",\"Volume_Discount\", \"Invoice_Price\"],\"hiddenElementNames\":[],\"productFilterCriteria\":{\"operator\":\"and\",\"_constructor\":\"AdvancedCriteria\", \"criteria\":[{\"fieldName\":\"sku\",\"operator\":\"iContainsPattern\",\"value\":\"0001\",\"_constructor\":\"AdvancedCriteria\"}]}, \"resultElementName\":\"Invoice_Price\",\"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"TC_Logic\", \"formulaParameters\":{\"Customer\":null,\"quantity\":null}}", "errorMode": "ABORT", "pricelistType": "SIMPLE", "approvalState": "NOT_APPROVED", "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 5308, "updateDate": "2017-07-19", "createDate": "2015-08-24T09:05:42", "createdBy": 51, "lastUpdateDate": "2017-07-19T10:16:58", "lastUpdateBy": 5308, "status": "READY", "calculationStartDate": "2015-10-08T10:50:56", "calculationDate": "2015-10-08T10:50:56", "id": 14240 } ], "endRow": 2, "totalRows": 2, "status": 0 } } |
Retrieve a Price List | Fetches basic data about the specified Price List (not its content). | /pricefx/{partition}/fetch/PL/{PriceListID} |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 6, "typedId": "14239.PL", "targetDate": "2015-08-24", "label": "My Price List", "locale": "en", "calculationMessages": "[\"(10) Formula not found for 10\"]", "numberOfItems": 49, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"Listprice\",\"Net_Margin_pct\",\"Rebate\", \"Target_Discount\",\"Base\",\"Prod_Class_Adj\", \"StandardDiscount\",\"Volume_Discount\",\"Invoice_Price\"], \"hiddenElementNames\":[],\"resultElementName\":\"Invoice_Price\",\"shotgunModeEnabled\":false, \"defaultFormulaOverride\":\"TC_Logic\", \"formulaParameters\":{\"Customer\":\"CD-00081\"},\"notifyWhenFinished\":\"NONE\"}", "errorMode": "ABORT", "pricelistType": "SIMPLE", "approvalState": "NOT_APPROVED", "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 5351, "updateDate": "2020-02-27", "createDate": "2015-08-24T08:59:11", "createdBy": 51, "lastUpdateDate": "2020-02-27T14:42:04", "lastUpdateBy": 5351, "status": "READY", "calculationStartDate": "2020-02-27T14:42:04", "calculationDate": "2020-02-27T14:42:04", "id": 14239 } ], "status": 0 } } |
Retrieve a complete Price List | Fetches the full content of the Price List, which can be thousands of rows. The PL is specified by the PriceListID path parameter. If there are no products in the PL (numberOfItems = 0), an empty array is returned. | /pricefx/{partition}/pricelistmanager.fetch/{PriceListID}
Payload Expand source
{ "startRow": 0, "endRow": 300, "data": {} } |
Response Expand source
{ "response": { "node": "user1", "startRow": 0, "data": [ { "version": 0, "typedId": "1851850.PLI", "sku": "MB-0034", "label": " Sausage LS", "unitOfMeasure": "1 EA", "currency": "EUR", "resultPrice": 16.34763, "alerts": "{}", "warnings": "{\"Volume_Discount\":[\"UserEntry parameter not found: quantity\",\"VLookup - Volume - called without key\"]}", "allowedOverrides": "", "calculatedResultPrice": 16.34763, "tainted": false, "pricelistId": 14239, "updateDate": "2015-08-24", "createDate": "2015-08-24T08:59:21", "lastUpdateDate": "2015-08-24T08:59:21", "attribute1": 12.25, "attribute2": 5.7575, "attribute3": 19.2325, "attribute4": 0.1, "attribute5": 2.884875, "attribute6": 0, "attribute7": 16.347625, "attribute8": 1.6347625, "attribute9": 0.3345, "completeResultsAvailable": true, "itemExtensions": {} }, { "version": 0, "typedId": "1851851.PLI", "sku": "MB-0028", "label": " Sausage BS", "unitOfMeasure": "1 EA", "currency": "EUR", "resultPrice": 11.7453, "alerts": "{}", "warnings": "{\"Volume_Discount\":[\"UserEntry parameter not found: quantity\",\"VLookup - Volume - called without key\"]}", "allowedOverrides": "", "calculatedResultPrice": 11.7453, "tainted": false, "pricelistId": 14239, "updateDate": "2015-08-24", "createDate": "2015-08-24T08:59:21", "lastUpdateDate": "2015-08-24T08:59:21", "attribute1": 9.8, "attribute2": 2.45, "attribute3": 13.818, "attribute4": 0.1, "attribute5": 2.0727, "attribute6": 0, "attribute7": 11.7453, "attribute8": 1.17453, "attribute9": 0.1985, "completeResultsAvailable": true, "itemExtensions": {} } ], "endRow": 2, "totalRows": 2, "status": 0 } } |
Get a (filtered) list of LPGs | Fetches a list of LPGs. The payload example applies a filter to fetch only LPGs with the status "Ready" and last updated by admin. | /pricefx/{partition}/fetch/PG
Payload Expand source
// filtered by Status - fetch only LPGs whose status is Ready { "data": { "criteria": [ { "fieldName": "status", "operator": "equals", "value": "READY" },{"fieldName": "lastUpdateByName", "operator": "equals", "value": "admin"} ] } } |
Response Expand source
{ "response": { "node": "user1", "startRow": 0, "data": [ { "version": 8, "typedId": "2147483791.PG", "label": "CurrentContextTest", "calculationMessages": "[]", "numberOfItems": 1, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"Number2\",\"Number1\",\"Result\"],\"hiddenElementNames\":[],\"hiddenDefaultFields\":[], \"productFilterCriteria\":{\"operator\":\"and\",\"_constructor\":\"AdvancedCriteria\",\"criteria\":[{\"fieldName\":\"sku\", \"operator\":\"iContains\",\"value\":\"1234567\",\"_constructor\":\"AdvancedCriteria\"}]},\"resultElementName\":\"Result\", \"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"CurrentContextTest\",\"inputs\":[], \"approvalTriggerFields\":[],\"productFilterMode\":\"auto\",\"allowFieldTypeChange\":false}", "nodeId": 9, "numberOfApprovedItems": 0, "numberOfOpenItems": 1, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "priceGridType": "SIMPLE", "createdByName": "root", "lastUpdateByName": "admin", "updatedBy": 51, "updateDate": "2019-10-15", "createDate": "2019-04-03T09:46:38", "createdBy": 3, "lastUpdateDate": "2019-10-15T12:26:07", "lastUpdateBy": 51, "status": "READY", "calculationStartDate": "2019-04-03T09:48:22", "calculationDate": "2019-04-03T09:48:22", "id": 2147483791 }, { "version": 21, "typedId": "2147483802.PG", "label": "GRT PTACB.ACB MTZ1 IEC.MAIN DEVICE MASTERPACT MTZ1 IEC", "calculationMessages": "[]", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"color\",\"size\"],\"shotgunModeEnabled\":false,\"outputs\":[{\"name\":\"testOutput1\", \"label\":\"Activity\",\"value\":\"PTXXX\",\"message\":\"\"},{\"name\":\"testOutput2\",\"label\":\"Range\",\"value\":\"XC3\", \"message\":\"OK\"},{\"name\":\"testOutput3\",\"label\":\"Cluster\",\"value\":\"1633\",\"message\":\"\"},{\"name\":\"testOutput4\", \"label\":\"Global Cluster Sales\",\"value\":\"$44.0M\",\"message\":\"\"}],\"outputChartDefinition\":{\"chart\":{\"type\":\"line\"}, \"title\":{\"text\":\"Sales\"},\"series\":[{\"name\":\"Results\",\"data\":[[0.1,0.3],[0.2,0.5],[0.3,0.6],[0.4,0.7]]}]},\"inputs\":[], \"allowFieldTypeChange\":false,\"headerInputs\":[{\"name\":\"Set price logic\",\"label\":\"Set price logic\",\"type\":\"INPUTMATRIX\", \"typedId\":\"2147483802.PG\",\"parameterConfig\":{\"columns\":[\"Value Attribute\",\"Feature\",\"Impact Type\",\"Current Coef\", \"New Coef\"]}},{\"name\":\"colorLabel\",\"label\":\"colorLabel\",\"type\":\"STRINGUSERENTRY\",\"typedId\":\"2147483802.PG\", \"parameterConfig\":{\"dataType\":\"text\"}}],\"headerFormulaName\":\"PLtest\"}", "nodeId": 9, "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "priceGridType": "SIMPLE", "headerTypeUniqueName": "jkTest", "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 5351, "updateDate": "2019-11-01", "createDate": "2019-10-15T11:22:49", "createdBy": 5351, "lastUpdateDate": "2019-11-01T14:44:25", "lastUpdateBy": 5351, "status": "READY", "calculationStartDate": "2019-10-15T11:23:01", "calculationDate": "2019-10-15T11:23:01", "id": 2147483802 } ], "endRow": 2, "totalRows": 2, "status": 0 } } |
Retrieve an LPG | Fetches basic data about the specified LPG (not its content). | /pricefx/{partition}/fetch/PG/{LPGID} |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 24, "typedId": "2147483802.PG", "label": "GRT PTACB.ACB MTZ1 IEC.MAIN DEVICE MASTERPACT MTZ1 IEC", "calculationMessages": "[]", "numberOfItems": 3, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"color\",\"size\"], \"shotgunModeEnabled\":false,\"outputs\":[{\"name\":\"testOutput1\", \"label\":\"Activity\",\"value\":\"PTXXX\",\"message\":\"\"}, {\"name\":\"testOutput2\", \"label\":\"Range\",\"value\":\"XC3\", \"message\":\"OK\"},{\"name\":\"testOutput3\",\"label\":\"Cluster\",\"value\":\"1633\", \"message\":\"\"},{\"name\":\"testOutput4\",\"label\":\"Global Cluster Sales\", \"value\":\"$44.0M\",\"message\":\"\"}], \"outputChartDefinition\":{\"chart\":{\"type\":\"line\"},\"title\":{\"text\":\"Sales\"}, \"series\":[{\"name\":\"Results\",\"data\":[[0.1,0.3],[0.2,0.5],[0.3,0.6],[0.4,0.7]]}]}, \"inputs\":[],\"allowFieldTypeChange\":false,\"headerInputs\":[{\"name\":\"Set price logic\", \"label\":\"Set price logic\",\"type\":\"INPUTMATRIX\",\"typedId\":\"2147483802.PG\", \"parameterConfig\":{\"columns\":[\"Value Attribute\",\"Feature\",\"Impact Type\",\"Current Coef\", \"New Coef\"]}},{\"name\":\"colorLabel\",\"label\":\"colorLabel\", \"type\":\"STRINGUSERENTRY\",\"typedId\":\"2147483802.PG\", \"parameterConfig\":{\"dataType\":\"text\"}}],\"headerFormulaName\":\"PLtest\"}", "nodeId": 9, "numberOfApprovedItems": 0, "numberOfOpenItems": 3, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "priceGridType": "SIMPLE", "headerTypeUniqueName": "LPGTest", "createdByName": "admin", "updateDate": "2020-10-26", "createDate": "2019-10-15T11:22:49", "createdBy": 5351, "lastUpdateDate": "2020-10-26T15:47:25", "status": "READY", "calculationStartDate": "2020-10-26T15:47:21", "calculationDate": "2020-10-26T15:47:25", "id": 2147483802 } ], "status": 0 } } |
Retrieve a complete LPG | Retrieves the full content of the LPG specified by its ID. | /pricefx/{partition}/pricegridmanager.fetch/{LPGID}
Payload Expand source
{ "data": {} } curl: curl -X POST \ https://{host}/pricefx/{partition}/pricegridmanager.fetch/<PG id> \ -H 'Accept: application/json' \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Authorization: Basic c25iLWRldi9pbnRlZ3JhdGlvbjpTdGFydDEyMw==' \ -H 'Cache-Control: no-cache' \ -H 'Connection: keep-alive' \ -H 'Content-Length: 142' \ -H 'Content-Type: application/json' \ -d '{ "operationType": "fetch", "startRow": 0, "endRow": 1, "textMatchStyle": "substring", "data": {}, "oldValues": null }' |
Response Expand source
{ "response": { "status": 0, "startRow": 0, "node": "user1", "data": [ { "version": 2, "typedId": "2147973134.PGI", "sku": "1234567890", "label": "TEST", "resultPrice": 5.0, "allowedOverrides": "", "calculatedResultPrice": 5.0, "tainted": false, "priceGridId": 2147483791, "approvalState": "NOT_APPROVED", "manualEditVersion": 0, "manualPriceExpired": false, "createDate": "2019-04-03T09:47:41", "createdBy": 3, "lastUpdateDate": "2019-04-03T09:48:22", "attribute1": 5, "attribute2": 999, "attribute3": 123, "itemExtensions": {}, "completeResultsAvailable": true } ], "endRow": 1 } } |
RebateManager
Action | Description | Request | Response |
---|---|---|---|
Get a (filtered) list of Rebate Agreements | Fetches a list of Rebate Agreements. The payload example applies a filter to fetch only Rebate Agreements with the label "New Rebate Agreement". | /pricefx/{partition}/fetch/RBA
Payload Expand source
// filtered to return only RBAs with label 'New Rebate Agreement' and sorted by creation day { "data": { "criteria": [ { "fieldName": "label", "operator": "iContainsPattern", "value": "New Rebate Agreement" } ] }, "sortBy": ["createDate"] } |
Response Expand source
{ "response": { "node": "user1", "startRow": 0, "data": [ { "version": 14, "typedId": "56.RBA", "uniqueName": "R-56", "label": "New Rebate Agreement", "targetDate": "2016-10-03", "workflowStatus": "NO_APPROVAL_REQUIRED", "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "startDate": "2016-10-03", "endDate": "2016-10-03", "payoutDate": "2016-10-03", "rebateAgreementStatus": "APPROVED", "renderInfo": {}, "approvedByName": "admin", "createDate": "2016-10-03T16:12:21", "createdBy": 5308, "lastUpdateDate": "2017-02-08T18:18:18", "lastUpdateBy": 5308, "rootUniqueName": "R-56" }, { "version": 30, "typedId": "2147483649.RBA", "uniqueName": "R-2147483649", "label": "New Rebate Agreement", "targetDate": "2017-03-06", "workflowStatus": "APPROVED", "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "customerGroup": { "label": "Customer Id is equal to customer_08", "customerFilterCriteria": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "customerId", "operator": "equals", "value": "customer_08" } ], "operator": "and" } }, "startDate": "2017-03-06", "endDate": "2017-03-06", "payoutDate": "2017-03-06", "rebateAgreementStatus": "REVOKED", "renderInfo": {}, "approvedByName": "admin", "createDate": "2017-03-06T13:11:33", "createdBy": 5351, "lastUpdateDate": "2017-03-06T13:23:28", "lastUpdateBy": 5351, "rootUniqueName": "R-2147483649" }, ], "endRow": 2, "totalRows": 2, "status": 0 } } |
Retrieve a Rebate Agreement | Fetches a Rebate Agreement specified by its typedId. | /pricefx/{partition}/rebateagreement.fetch/{RBATypedID}
Payload Expand source
{ "data": {} } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 14, "typedId": "56.RBA", "uniqueName": "R-56", "label": "New Rebate Agreement", "targetDate": "2016-10-03", "workflowStatus": "NO_APPROVAL_REQUIRED", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": {}, "valueOptions": null } ], "viewState": { "gridViewState": "({field:[{name:\"CLITN_Status\",frozen:true,width:25},{name:\"CLITN_Status1\",frozen:true,width:25}, {name:\"dirtyField\",frozen:true,width:25},{name:\"CLITN_Desc\",frozen:true},{name:\"rebateType\"},{name:\"productGroup\"}, {name:\"INPUT_CustomerGroup\",visible:false}]})", "openFolders": ["ROOT"], "selectedNodes": ["ROOT"] }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "customerGroup": null, "startDate": "2016-10-03", "endDate": "2016-10-03", "payoutDate": "2016-10-03", "rebateRecordSetId": null, "rebateRecordSetLabel": null, "simulationSet": null, "simulationType": null, "rebateAgreementStatus": "APPROVED", "serverMessagesExtended": null, "approvalRequiredEmailAttachmentsJson": null, "renderInfo": {}, "approvedByName": "admin", "deniedByName": null, "hasWorkflowHistory": false, "createDate": "2016-10-03T16:12:21", "createdBy": 5308, "lastUpdateDate": "2017-02-08T18:18:18", "lastUpdateBy": 5308, "supersededBy": null, "prevRev": null, "rootUniqueName": "R-56" } ], "status": 0 } } |
QuoteConfigurator
Action | Description | Request | Response |
---|---|---|---|
Get a (filtered) list of Quotes | Fetches a list of Quotes. The payload example applies a filter to fetch only Quotes updated on 18 March 2020 or later. | /pricefx/{partition}/quotemanager.fetchlist
Payload Expand source
{ "sortBy": ["createDate"], "data": { "criteria": [ { "fieldName": "lastUpdateDate", "operator": "greaterOrEqual", "value": "2020-03-18" } ] } } |
Response Expand source
{ "response": { "node": "user1", "startRow": 0, "data": [ { "version": 8, "typedId": "1986.Q", "uniqueName": "P-1021-v2.1", "label": "TEST_QUOTE_Ondrej", "targetDate": "2015-05-01", "workflowStatus": "DRAFT", "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "training", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "expiryDate": "2016-05-01", "quoteStatus": "DRAFT", "renderInfo": {}, "createDate": "2018-08-15T12:42:00", "createdBy": 5351, "lastUpdateDate": "2020-05-07T11:16:47", "lastUpdateBy": 51, "prevRev": "P-1021", "rootUniqueName": "P-1021" }, { "version": 14, "typedId": "1988.Q", "uniqueName": "P-1624-v2.1", "label": "New Quote2", "targetDate": "2017-02-27", "workflowStatus": "SUBMITTED", "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "expiryDate": "2017-02-27", "customerId": "customer_11", "customerName": "Customer 11", "quoteStatus": "DRAFT", "renderInfo": {}, "approvedByName": "admin", "approvalRequiredEmailAttachmentsJson": "[]", "createDate": "2018-08-15T12:42:00", "createdBy": 5351, "lastUpdateDate": "2020-05-14T10:43:21", "lastUpdateBy": 2147483655, "prevRev": "P-1624", "rootUniqueName": "P-1624" } ], "endRow": 2, "totalRows": 2, "status": 0 } } |
Retrieve a Quote | Retrieves a Quote specified by its typedId. | /pricefx/{partition}/quotemanager.fetch/{QuoteTypedID}
Payload Expand source
{ "data": {} } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 8, "typedId": "1986.Q", "uniqueName": "P-1021-v2.1", "label": "TEST_QUOTE_Ondrej", "targetDate": "2015-05-01", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "Iterations", "label": "Iterations", "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": "1986.Q", "alwaysEditable": null, "parameterConfig": { "dataType": "float" }, "valueOptions": null } ], "viewState": { "gridViewState": "({field:[{name:\"CLITN_Status\",frozen:true,width:25},{name:\"CLITN_Status1\", frozen:true,width:25},{name:\"dirtyField\",frozen:true,width:25},{name:\"CLITN_Desc\",frozen:true}, {name:\"sku\"},{name:\"label\",visible:false},{name:\"INPUT_Iterations\",visible:false}]})", "openFolders": ["ROOT"], "selectedNodes": ["ROOT"] }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "expiryDate": "2016-05-01", "externalRef": null, "customerId": null, "customerName": null, "customerGroup": null, "quoteStatus": "DRAFT", "renderInfo": {}, "serverMessagesExtended": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2018-08-15T12:42:00", "createdBy": 5351, "lastUpdateDate": "2020-05-07T11:16:47", "lastUpdateBy": 51, "supersededBy": null, "prevRev": "P-1021", "quoteType": null, "status": null, "rootUniqueName": "P-1021" } ], "status": 0 } } |
Add a Quote | Creates a new Quote according to the specification in the payload. | /pricefx/{partition}/quotemanager.save
Payload Expand source
{ "data": { "quote": { "version": null, "typedId": null, "uniqueName": null, "label": "New Quote", "targetDate": "2020-09-18", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": {}, "valueOptions": null } ], "outputs": [], "lineItems": [ { "version": null, "typedId": null, "clicId": null, "inputs": [ { "name": "Quantity", "label": "Quantity (default: 1)", "lookupTableId": null, "url": null, "type": "INTEGERUSERENTRY", "value": 900, "valueHint": null, "readOnly": false, "filter": null, "parameterGroup": null, "required": true, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": { "dataType": "integer" }, "valueOptions": null, "inheritedValue": null }, { "name": "Description", "label": "Description", "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": { "dataType": "float" }, "valueOptions": null, "inheritedValue": null } ], "outputs": [] } ] } } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 3, "typedId": "2474.Q", "uniqueName": "P-2474", "label": "New Quote", "targetDate": "2020-09-18", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": {}, "valueOptions": null } ], "viewState": { "gridViewState": "({field:[{name:\"CLITN_Status\",frozen:true,width:25},{name:\"CLITN_Status1\",frozen:true,width:25}, {name:\"dirtyField\",frozen:true,width:25},{name:\"CLITN_Desc\",frozen:true},{name:\"sku\"},{name:\"label\",visible:false}, {name:\"INPUT_Quantity\",visible:false},{name:\"INPUT_Description\",visible:false},{name:\"INPUT_CustomerGroup\",visible:false}, {name:\"OUTPUT_Discount\",visible:false}]})", "openFolders": ["ROOT"], "selectedNodes": ["FWIfthJiOAFlJlc"] }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": ["Quote calculated successfully", "Quote saved\t"], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [ { "version": 1, "typedId": "2147503031.QLI", "clicId": 2474, "inputs": [ { "name": "Quantity", "label": "Quantity (default: 1)", "lookupTableId": null, "url": null, "type": "INTEGERUSERENTRY", "value": 900, "valueHint": null, "readOnly": false, "filter": null, "parameterGroup": null, "required": true, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": { "dataType": "integer" }, "valueOptions": null }, { "name": "Description", "label": "Description", "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": { "dataType": "float" }, "valueOptions": null } ], "outputs": [ { "resultName": "Discount", "resultLabel": "Discount", "result": 900, "warnings": ["UserEntry parameter not found: Description"], "alertMessage": null, "alertType": null, "displayOptions": 16, "formatType": null, "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "FWIfthJiOAFlJlc", "parentId": null, "calculationStatus": 2, "editabilityStatus": 0, "label": "10", "sku": "10", "priceRecordId": null, "folder": false, "treeLabel": "10", "createDate": "2020-09-18T08:31:29", "createdBy": 5351, "lastUpdateDate": "2020-09-18T08:31:29", "lastUpdateBy": 5351 } ], "expiryDate": "2020-10-18", "externalRef": null, "customerId": null, "customerName": null, "customerGroup": null, "quoteStatus": "DRAFT", "renderInfo": { "headerText": { "position": "top", "text": "Comments - TOP" } }, "serverMessagesExtended": [ { "key": "QUOTE_CALCULATED", "message": "Quote calculated successfully" }, { "key": null, "message": "Quote saved\t" } ], "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2020-09-18T08:31:29", "createdBy": 5351, "lastUpdateDate": "2020-09-18T08:31:30", "lastUpdateBy": 5351, "supersededBy": null, "prevRev": null, "quoteType": null, "status": "DRAFT", "rootUniqueName": "P-2474" } ], "status": 0 } } |
Submit a Quote | Submits a Quote that is specified in the payload. | /pricefx/{partition}/quotemanager.submit
Payload Expand source
{ "data": { "quote": { "version": 3, "typedId": "2474.Q", "uniqueName": "P-2474", "label": "New Quote", "targetDate": "2020-09-18", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": {}, "valueOptions": null } ], "viewState": { "gridViewState": "({field: [{name:\"CLITN_Status\",frozen:true,width:25}, {name:\"CLITN_Status1\",frozen:true,width:25}, {name:\"dirtyField\",frozen:true,width:25}, {name:\"CLITN_Desc\",frozen:true},{name:\"sku\"}, {name:\"label\",visible:false}, {name:\"INPUT_CustomerGroup\",visible:false}, {name:\"INPUT_Quantity\",visible:false}, {name:\"INPUT_Description\",visible:false}, {name:\"OUTPUT_Discount\",visible:false}]})", "openFolders": ["ROOT"], "selectedNodes": ["FWIfthJiOAFlJlc"] }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": ["Quote calculated successfully", "Quote saved\t"], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [ { "version": 1, "typedId": "2147503031.QLI", "clicId": 2474, "inputs": [ { "name": "Quantity", "label": "Quantity (default: 1)", "lookupTableId": null, "url": null, "type": "INTEGERUSERENTRY", "value": 900, "valueHint": null, "readOnly": false, "filter": null, "parameterGroup": null, "required": true, "labelTranslations": null, "addUnknownValues": null, "typedId": "2474.Q", "alwaysEditable": null, "parameterConfig": { "dataType": "integer" }, "valueOptions": null, "inheritedValue": null }, { "name": "Description", "label": "Description", "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": "2474.Q", "alwaysEditable": null, "parameterConfig": { "dataType": "float" }, "valueOptions": null, "inheritedValue": null } ], "outputs": [], "dirty": false, "lineId": "FWIfthJiOAFlJlc", "parentId": null, "calculationStatus": 2, "editabilityStatus": 0, "label": "10", "sku": "10", "priceRecordId": null, "folder": false, "treeLabel": "10", "createDate": "2020-09-18T08:31:29", "createdBy": 5351, "lastUpdateDate": "2020-09-18T08:31:29", "lastUpdateBy": 5351 } ], "expiryDate": "2020-10-18", "externalRef": null, "customerId": null, "customerName": null, "customerGroup": null, "quoteStatus": "DRAFT", "renderInfo": { "headerText": { "position": "top", "text": "Comments - TOP" } }, "serverMessagesExtended": [ { "key": "QUOTE_CALCULATED", "message": "Quote calculated successfully" }, { "key": null, "message": "Quote saved\t" } ], "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2020-09-18T08:31:29", "createdBy": 5351, "lastUpdateDate": "2020-09-18T08:31:30", "lastUpdateBy": 5351, "supersededBy": null, "prevRev": null, "quoteType": null, "status": "DRAFT", "rootUniqueName": "P-2474", "approvalRequiredEmailAttachments": [] }, "actionComment": "Please approve" } } |
Response Expand source
{ "response": { "node": "user1", "data": [ { "version": 5, "typedId": "2474.Q", "uniqueName": "P-2474", "label": "New Quote", "targetDate": "2020-09-18", "workflowStatus": "SUBMITTED", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "parameterConfig": {}, "valueOptions": null } ], "viewState": { "gridViewState": "({field:[{name:\"CLITN_Status\",frozen:true,width:25},{name:\"CLITN_Status1\",frozen:true,width:25}, {name:\"dirtyField\",frozen:true,width:25},{name:\"CLITN_Desc\",frozen:true},{name:\"sku\"},{name:\"label\",visible:false}, {name:\"INPUT_CustomerGroup\",visible:false},{name:\"INPUT_Quantity\",visible:false},{name:\"INPUT_Description\",visible:false}, {name:\"OUTPUT_Discount\",visible:false}]})", "openFolders": ["ROOT"], "selectedNodes": ["FWIfthJiOAFlJlc"] }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "Quote calculated successfully", "Quote saved\t", "Quote submitted" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [ { "version": 1, "typedId": "2147503031.QLI", "clicId": null, "inputs": [ { "name": "Quantity", "label": "Quantity (default: 1)", "lookupTableId": null, "url": null, "type": "INTEGERUSERENTRY", "value": 900, "valueHint": null, "readOnly": false, "filter": null, "parameterGroup": null, "required": true, "labelTranslations": null, "addUnknownValues": null, "typedId": "2474.Q", "alwaysEditable": null, "parameterConfig": { "dataType": "integer" }, "valueOptions": null }, { "name": "Description", "label": "Description", "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": "2474.Q", "alwaysEditable": null, "parameterConfig": { "dataType": "float" }, "valueOptions": null } ], "outputs": [ { "resultName": "Discount", "resultLabel": "Discount", "result": 900, "warnings": ["UserEntry parameter not found: Description"], "alertMessage": null, "alertType": null, "displayOptions": 16, "formatType": null, "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "FWIfthJiOAFlJlc", "parentId": null, "calculationStatus": 2, "editabilityStatus": 0, "label": "10", "sku": "10", "priceRecordId": null, "folder": false, "treeLabel": "10", "createDate": "2020-09-18T08:35:19", "createdBy": 5351, "lastUpdateDate": "2020-09-18T08:35:19", "lastUpdateBy": 5351 } ], "expiryDate": "2020-10-18", "externalRef": null, "customerId": null, "customerName": null, "customerGroup": null, "quoteStatus": "DRAFT", "renderInfo": { "headerText": { "position": "top", "text": "Comments - TOP" } }, "serverMessagesExtended": [ { "key": "QUOTE_CALCULATED", "message": "Quote calculated successfully" }, { "key": null, "message": "Quote saved\t" }, { "key": null, "message": "Quote submitted" } ], "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachmentsJson": "[]", "hasWorkflowHistory": true, "createDate": "2020-09-18T08:31:29", "createdBy": 5351, "lastUpdateDate": "2020-09-18T08:35:20", "lastUpdateBy": 5351, "supersededBy": null, "prevRev": null, "quoteType": null, "status": "DRAFT", "rootUniqueName": "P-2474" } ], "status": 0 } } |
PromotionManager
Action | Description | Request | Response |
---|---|---|---|
Retrieve a Contract | Retrieves a Contract specified by its uniqueName. | /pricefx/{partition}/contractmanager.fetch/{ContractUniqueName}
Payload Expand source
{ "data": {} } |
Response Expand source
{ "response":{ "node":"user1", "data":[ { "version":5, "typedId":"1.CT", "uniqueName":"C-1", "label":"New Contract TBR", "targetDate":"2015-12-03", "workflowStatus":null, "headerText":"", "inputs":[ { "name":"CustomerGroup", "label":"Customer(s)", "lookupTableId":null, "url":null, "type":"CUSTOMERGROUP", "value":null, "valueHint":"", "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ }, "formatingOptions":{ }, "valueOptions":null }, { "name":"ProductGroup", "label":"Product(s)", "lookupTableId":null, "url":null, "type":"PRODUCTGROUP", "value":{ "productFilterCriteria":{ "_constructor":"AdvancedCriteria", "operator":"and", "criteria":[ { "fieldName":"sku", "operator":"inSet", "value":[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ], "_constructor":"AdvancedCriteria" } ] }, "label":"Part-Id is one of 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20" }, "valueHint":"Part-Id is one of 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20", "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ }, "formatingOptions":{ }, "valueOptions":null } ], "viewState":{ "gridViewState":"({field:[{name:\"CLITN_Status\",frozen:true,width:25}, {name:\"CLITN_Status1\",frozen:true,width:25},{name:\"dirtyField\",frozen:true,width:25}, {name:\"CLITN_Desc\",frozen:true},{name:\"label\"},{name:\"customerGroup\"},{name:\"productGroup\"}]})", "openFolders":[ "ROOT" ], "selectedNodes":[ "ROOT" ] }, "outputs":[ ], "lastUpdateByName":"admin", "createdByName":"admin", "submittedByName":null, "calculationStatus":2, "dirty":false, "refreshInputs":false, "nodeId":0, "userGroupEdit":null, "userGroupViewDetails":null, "serverMessages":null, "additionalInfo1":null, "additionalInfo2":null, "additionalInfo3":null, "additionalInfo4":null, "numberOfAttachments":0, "creationWorkflowStatus":null, "creationWorkflowCurrentStep":null, "creationWorkflowStepCount":null, "creationWorkflowStepLabel":null, "signature":null, "lineItems":[ { "version":1, "typedId":"6.CTLI", "clicId":1, "inputs":[ { "name":"ProductSKU", "label":"ProductSKU", "lookupTableId":null, "url":null, "type":"PRODUCT", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ "dataType":"product" }, "formatingOptions":{ }, "valueOptions":null }, { "name":"Customer", "label":"Customer", "lookupTableId":null, "url":"/fetch/C/", "type":"CUSTOMER", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ }, "formatingOptions":{ }, "valueOptions":null }, { "name":"quantity", "label":"quantity", "lookupTableId":null, "url":null, "type":"USERENTRY", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ "dataType":"float" }, "formatingOptions":{ }, "valueOptions":null }, { "name":"Sales Discount in %", "label":"Sales Discount in %", "lookupTableId":null, "url":null, "type":"USERENTRY", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ "dataType":"float" }, "formatingOptions":{ }, "valueOptions":null } ], "outputs":[ { "resultName":"Listprice", "resultLabel":"Listprice", "result":0, "warnings":[ "Product not defined", "Product not defined", "Lookup table Prod_Class_Adj not found", "Product not defined", "Lookup table PLCAdjustment not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Target_Discount", "resultLabel":"Discount Guideline", "result":null, "warnings":[ "Customer not set", "Lookup table DiscountGuide not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"PERCENT", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"StandardDiscount", "resultLabel":"Standard Discount DG", "result":0, "warnings":[ "Product not defined", "Product not defined", "Lookup table Std_Discount not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Volume_Discount", "resultLabel":"Discount based on quantity", "result":0, "warnings":[ "UserEntry parameter not found: quantity", "Lookup table Volume not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Invoice_Price", "resultLabel":"Invoice Price", "result":0E-10, "warnings":[ "UserEntry parameter not found: Sales Discount in %" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Net_Margin_pct", "resultLabel":"Net_Margin_pct", "result":null, "warnings":[ "Customer not set", "Lookup table Bonus not found", "Product not defined", "Product not defined", "ERROR(@31): Arithmetic exception caught(/ by zero)", "Product not defined", "Product not defined", "ERROR(@32): Arithmetic exception caught(/ by zero)" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"PERCENT", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null } ], "dirty":false, "lineId":"1xpkBmqT0gBF7Cf", "parentId":null, "calculationStatus":2, "editabilityStatus":0, "label":"ctType", "startDate":null, "endDate":null, "priceRecordId":null, "customerGroup":null, "productGroup":{ "label":"Part-Id is one of 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20", "productFieldName":null, "productFieldLabel":null, "productFieldValue":null, "productFilterCriteria":{ "_constructor":"AdvancedCriteria", "criteria":[ { "fieldName":"sku", "operator":"inSet", "value":[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ], "_constructor":"AdvancedCriteria" } ], "operator":"and" } }, "calculationBaseJson":"{\"includedCustomerGroups\":[], \"includedProductGroups\":[{\"label\":\"Part-Id is one of 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20\", \"productFilterCriteria\":{\"_constructor\":\"AdvancedCriteria\",\"operator\":\"and\", \"criteria\":[{\"fieldName\":\"sku\", \"operator\":\"inSet\", \"value\":[\"1\",\"2\",\"3\",\"4\",\"5\",\"6\",\"7\",\"8\",\"9\",\"10\", \"11\",\"12\", \"13\",\"14\",\"15\",\"16\",\"17\",\"18\",\"19\",\"20\"], \"_constructor\":\"AdvancedCriteria\"}]}}],\"excludedCustomerGroups\":[],\"excludedproductGroups\":[], \"includedTimePeriods\":[{\"timeUnit\":\"DAY\",\"startDate\":\"2015-12-03\",\"endDate\":\"2015-12-03\",\"single\":false}], \"excludedTimePeriods\":[],\"otherFilters\":[],\"dateDimFieldName\":\"<timeField>\"}", "calculationBase":{ "includedCustomerGroups":[ ], "includedProductGroups":[ { "label":"Part-Id is one of 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20", "productFieldName":null, "productFieldLabel":null, "productFieldValue":null, "productFilterCriteria":{ "_constructor":"AdvancedCriteria", "operator":"and", "criteria":[ { "fieldName":"sku", "operator":"inSet", "value":[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ], "_constructor":"AdvancedCriteria" } ] } } ], "excludedCustomerGroups":[ ], "excludedproductGroups":[ ], "includedTimePeriods":[ { "timeUnit":"DAY", "startDate":"2015-12-03", "endDate":"2015-12-03", "single":false } ], "excludedTimePeriods":[ ], "otherFilters":[ ], "dateDimFieldName":"<timeField>" }, "treeLabel":"ctType", "folder":false, "createDate":"2017-04-06T09:02:22", "createdBy":5351, "lastUpdateDate":"2017-04-06T09:02:22", "lastUpdateBy":51, "contractTermType":"ctType" } ], "customerGroup":null, "productGroup":{ "label":"Part-Id is one of 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20", "productFieldName":null, "productFieldLabel":null, "productFieldValue":null, "productFilterCriteria":{ "_constructor":"AdvancedCriteria", "criteria":[ { "fieldName":"sku", "operator":"inSet", "value":[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ], "_constructor":"AdvancedCriteria" } ], "operator":"and" } }, "externalRef":null, "contractStatus":"DRAFT", "startDate":"2015-12-03", "endDate":"2015-12-03", "renderInfo":{ }, "serverMessagesExtended":null, "approvedByName":null, "deniedByName":null, "approvalRequiredEmailAttachmentsJson":null, "hasWorkflowHistory":false, "createDate":"2015-12-03T09:32:17", "createdBy":51, "lastUpdateDate":"2017-04-06T09:02:22", "lastUpdateBy":51, "supersededBy":null, "prevRev":null, "rootUniqueName":"C-1" } ], "status":0 } } |
Add Contract items | /pricefx/{partition}/contractmanager.additems
Payload Expand source
{ "data":{ "contract":{ "version":null, "typedId":null, "uniqueName":null, "label":"New Contract", "targetDate":"2021-02-08", "workflowStatus":"DRAFT", "headerText":"", "inputs":[ { "label":"Customer(s)", "name":"CustomerGroup", "type":"CUSTOMERGROUP" }, { "label":"Product(s)", "name":"ProductGroup", "type":"PRODUCTGROUP" } ], "viewState":{ "gridViewState":null, "openFolders":null, "selectedNodes":null }, "outputs":[ ], "lastUpdateByName":null, "createdByName":null, "submittedByName":null, "calculationStatus":0, "dirty":false, "refreshInputs":false, "nodeId":null, "userGroupEdit":null, "userGroupViewDetails":null, "serverMessages":[ "Contracts calculated successfully" ], "additionalInfo1":null, "additionalInfo2":null, "additionalInfo3":null, "additionalInfo4":null, "numberOfAttachments":0, "creationWorkflowStatus":null, "creationWorkflowCurrentStep":null, "creationWorkflowStepCount":null, "creationWorkflowStepLabel":null, "signature":null, "lineItems":[ ], "customerGroup":null, "productGroup":null, "externalRef":null, "status":"DRAFT", "startDate":"2021-02-08", "endDate":"2021-02-08", "renderInfo":null, "serverMessagesExtended":[ { "key":null, "message":"Contracts calculated successfully" } ], "approvedByName":null, "deniedByName":null, "approvalRequiredEmailAttachmentsJson":null, "hasWorkflowHistory":false, "createDate":"2021-02-08T14:09:15", "createdBy":5351, "lastUpdateDate":"2021-02-08T14:09:15", "lastUpdateBy":5351, "supersededBy":null, "prevRev":null, "rootUniqueName":null }, "parent":null, "contractTermTypes":[ "ctType" ] } } |
Response Expand source
{ "response":{ "node":"user1", "data":[ { "version":null, "typedId":null, "uniqueName":null, "label":"New Contract", "targetDate":"2021-02-08", "workflowStatus":"DRAFT", "headerText":"", "inputs":[ { "name":"CustomerGroup", "label":"Customer(s)", "lookupTableId":null, "url":null, "type":"CUSTOMERGROUP", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ }, "formatingOptions":{ }, "valueOptions":null }, { "name":"ProductGroup", "label":"Product(s)", "lookupTableId":null, "url":null, "type":"PRODUCTGROUP", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ }, "formatingOptions":{ }, "valueOptions":null } ], "viewState":{ "gridViewState":null, "openFolders":null, "selectedNodes":null }, "outputs":[ ], "lastUpdateByName":null, "createdByName":null, "submittedByName":null, "calculationStatus":2, "dirty":false, "refreshInputs":false, "nodeId":null, "userGroupEdit":null, "userGroupViewDetails":null, "serverMessages":[ "Contracts calculated successfully" ], "additionalInfo1":null, "additionalInfo2":null, "additionalInfo3":null, "additionalInfo4":null, "numberOfAttachments":0, "creationWorkflowStatus":null, "creationWorkflowCurrentStep":null, "creationWorkflowStepCount":null, "creationWorkflowStepLabel":null, "signature":null, "lineItems":[ { "version":null, "typedId":null, "clicId":null, "inputs":[ { "name":"ProductSKU", "label":"ProductSKU", "lookupTableId":null, "url":null, "type":"PRODUCT", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ "dataType":"product" }, "formatingOptions":{ }, "valueOptions":null }, { "name":"Customer", "label":"Customer", "lookupTableId":null, "url":"/fetch/C/", "type":"CUSTOMER", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ }, "formatingOptions":{ }, "valueOptions":null }, { "name":"quantity", "label":"quantity", "lookupTableId":null, "url":null, "type":"USERENTRY", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ "dataType":"float" }, "formatingOptions":{ }, "valueOptions":null }, { "name":"Sales Discount in %", "label":"Sales Discount in %", "lookupTableId":null, "url":null, "type":"USERENTRY", "value":null, "valueHint":null, "readOnly":null, "filter":null, "parameterGroup":null, "required":null, "labelTranslations":null, "addUnknownValues":null, "typedId":null, "alwaysEditable":null, "parameterConfig":{ "dataType":"float" }, "formatingOptions":{ }, "valueOptions":null } ], "outputs":[ { "resultName":"Listprice", "resultLabel":"Listprice", "result":0, "warnings":[ "Product not defined", "Product not defined", "VLookup table Prod_Class_Adj not found", "Product not defined", "VLookup table PLCAdjustment not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Target_Discount", "resultLabel":"Discount Guideline", "result":null, "warnings":[ "Customer not set", "VLookup table DiscountGuide not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"PERCENT", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"StandardDiscount", "resultLabel":"Standard Discount DG", "result":0, "warnings":[ "Product not defined", "Product not defined", "VLookup table Std_Discount not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Volume_Discount", "resultLabel":"Discount based on quantity", "result":0, "warnings":[ "UserEntry parameter not found: quantity", "VLookup table Volume not found" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Invoice_Price", "resultLabel":"Invoice Price", "result":0E-10, "warnings":[ "UserEntry parameter not found: Sales Discount in %" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"MONEY_EUR", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":"{\n \"cs\":\"Cena\", \n \"de\":\"Rechnungspreis\"\n}", "overridable":false, "overridden":false, "resultDescription":null }, { "resultName":"Net_Margin_pct", "resultLabel":"Net_Margin_pct", "result":null, "warnings":[ "Customer not set", "VLookup table Bonus not found", "Product not defined", "Product not defined", "ERROR(@31): Arithmetic exception caught (/ by zero)", "Product not defined", "Product not defined", "ERROR(@32): Arithmetic exception caught (/ by zero)" ], "alertMessage":null, "alertType":null, "displayOptions":3, "formatType":"PERCENT", "suffix":null, "resultType":"SIMPLE", "cssProperties":null, "userGroup":null, "resultGroup":null, "overrideValueOptions":null, "overrideAllowEmpty":true, "labelTranslations":null, "overridable":false, "overridden":false, "resultDescription":null } ], "dirty":false, "lineId":"5MMga4uB53RYyzD", "parentId":null, "calculationStatus":2, "editabilityStatus":0, "label":"ctType", "startDate":null, "endDate":null, "priceRecordId":null, "customerGroup":null, "productGroup":null, "calculationBaseJson":"{\"includedCustomerGroups\":[], \"includedProductGroups\":[],\"excludedCustomerGroups\":[], \"excludedproductGroups\":[],\"includedTimePeriods\":[{\"timeUnit\":\"DAY\", \"startDate\":\"2021-02-08\",\"endDate\":\"2021-02-08\",\"single\":false}], \"excludedTimePeriods\":[],\"otherFilters\":[],\"dateDimFieldName\":\"<timeField>\"}", "calculationBase":{ "includedCustomerGroups":[ ], "includedProductGroups":[ ], "excludedCustomerGroups":[ ], "excludedproductGroups":[ ], "includedTimePeriods":[ { "timeUnit":"DAY", "startDate":"2021-02-08", "endDate":"2021-02-08", "single":false } ], "excludedTimePeriods":[ ], "otherFilters":[ ], "dateDimFieldName":"<timeField>" }, "treeLabel":"ctType", "folder":false, "createDate":"2021-02-08T14:09:48", "createdBy":5351, "lastUpdateDate":"2021-02-08T14:09:48", "lastUpdateBy":5351, "contractTermType":"ctType" } ], "customerGroup":null, "productGroup":null, "externalRef":null, "contractStatus":"DRAFT", "startDate":"2021-02-08", "endDate":"2021-02-08", "renderInfo":null, "serverMessagesExtended":[ { "key":null, "message":"Contracts calculated successfully" } ], "approvedByName":null, "deniedByName":null, "approvalRequiredEmailAttachmentsJson":null, "hasWorkflowHistory":false, "createDate":"2021-02-08T14:09:48", "createdBy":5351, "lastUpdateDate":"2021-02-08T00:00:00", "lastUpdateBy":5351, "supersededBy":null, "prevRev":null, "rootUniqueName":null }, { "addedLineIds":[ "5MMga4uB53RYyzD" ] } ], "status":0 } } |
Workflow
Action | Description | Request | Response |
---|---|---|---|
Get a list of pending approvals | Fetches the list of all the documents awaiting the user's approval. | /pricefx/{partition}/workflowsmanager.fetch/active
Payload Expand source
{ "data": {} } |
Response Expand source
{ "response": { "status": 0, "startRow": 0, "node": "user1", "data": [ { "version": 4, "typedId": "2147483713.W", "uniqueName": "R-2147483660-2147483713", "label": "R-2147483660 (New Rebate Agreement)", "approvableTypedId": "2147483660.RBA", "approvableUniqueName": "R-2147483660", "currentStepId": "ea303804-6807-4244-8aac-0eacc078964f", "workflowStatus": "SUBMITTED", "code": "RBA", "storesOnlyHeaderOfApprovableState": false, "expandedActiveUsers": "", "createDate": "2017-03-09T15:10:42", "createdBy": 5351, "lastUpdateDate": "2017-03-09T15:11:09", "lastUpdateBy": 2147483655, "delegation": "None" }, { "version": 2, "typedId": "2147483750.W", "uniqueName": "P-1625-2147483750", "label": "P-1625 (New Quote 3)", "approvableTypedId": "1625.Q", "approvableUniqueName": "P-1625", "currentStepId": "87eeffbe-40b7-4b88-8cb7-db1a649f8106", "workflowStatus": "SUBMITTED", "code": "Q", "storesOnlyHeaderOfApprovableState": false, "expandedActiveUsers": "", "createDate": "2017-04-03T09:17:32", "createdBy": 5351, "lastUpdateDate": "2017-04-03T09:17:32", "lastUpdateBy": 5351, "delegation": "None" } ], "endRow": 2 } } |
Approve a document | Executes the approve action on the workflow step specified by the External Action Token. As the External Action Token use the "currentStepId" value that you can find in the response when you call the workflowsmanager.fetch/active endpoint. | /pricefx/{partition}/workflowsmanager.approve/{ExternalActionToken}
Payload Expand source
{"data":{"actionComment":"Approved"}} |
Response Expand source
{ "response": { "node": "user1", "data": [ { "workflow": { "workflowStatus": "APPROVED", "isSelectStepOnDeny": null, "type": "quote", "steps": [ { "reason": "Standard approval", "reasons": [ "Standard approval" ], "isUserApprover": "true", "userGroupNames": null, "type": "ApprovalWorkflowStep", "minApprovalsForGroups": [], "isPostStepLogicFailed": null, "postStepLogicName": null, "id": "87eeffbe-40b7-4b88-8cb7-db1a649f8106", "executedByNames": [ "janek" ], "userLoginNames": null, "userGroupTypedId": null, "approvalRequiredEmailAttachments": [], "subSteps": [ { "approver": "Admin", "approverLoginName": null, "approverTypedId": "5351.U", "executionStatus": "EXECUTED_APPROVED", "lastExecutedBy": "Admin", "lastExecutedByName": "Admin", "approvedCount": 1, "minApprovalsNeeded": 1, "reason": "Standard approval", "comment": "Approved - well done!", "comments": null, "lastExecutionDate": "2021-02-10T08:53:51" } ], "executionStatus": "EXECUTED_APPROVED", "userTypedIds": [ "5351.U" ], "lastAccess": "2021-02-10T08:53:51", "minApprovalsNeeded": 1, "userName": "Admin", "delegatedToTypedIds": [], "userGroupTypedIds": null, "userTypedId": "5351.U", "uniqueName": "DefaultApproval", "denialReasons": [], "userGroupName": null, "isDenialReasonOptional": "true", "userNames": [ "janek" ], "comment": "Approved - well done!", "mandatoryComments": [] } ], "approvableTypedId": "1625.Q", "currentStepId": null, "submitReason": null, "submitterUserName": "Admin", "denialReasons": [], "submitterTypedId": "5351.U", "isDenialReasonOptional": "true", "id": "ed447a8a-2fdc-427d-b55a-244dea6e90b3", "isAddStepRestrictedToWFAdmin": "false" } } ], "status": 0 } } |
Deny a document | Executes the deny action on the workflow step specified by the External Action Token. As the External Action Token use the "currentStepId" value that you can find in the response when you call the workflowsmanager.fetch/active endpoint. | /pricefx/{partition}/workflowsmanager.deny/{ExternalActionToken}
Payload Expand source
{"data":{"actionComment":"Not approved"}} |
Response Expand source
{ "response":{ "node":"e2e-stable-node", "data":[ { "workflow":{ "workflowStatus":"DENIED", "isSelectStepOnDeny":"false", "type":"quote", "steps":[ { "reason":"Admin has to approve - 2017", "reasons":[ "Admin has to approve - 2017" ], "isUserApprover":"true", "userGroupNames":null, "type":"ApprovalWorkflowStep", "minApprovalsForGroups":[ ], "isPostStepLogicFailed":null, "postStepLogicName":null, "id":"e724ac84-1160-4604-89c8-f1eb1f9fe3f5", "executedByNames":[ "Admin" ], "userLoginNames":[ "e2e-admin" ], "userGroupTypedId":null, "approvalRequiredEmailAttachments":[ ], "subSteps":[ { "approver":"e2e admin", "approverLoginName":"e2e-admin", "approverTypedId":"2147483721.U", "executionStatus":"EXECUTED_DENIED", "lastExecutedBy":"Admin", "lastExecutedByName":"Admin on behalf of Manager", "approvedCount":1, "minApprovalsNeeded":1, "reason":"Admin has to approve - 2017", "comment":"Not approved", "comments":null, "lastExecutionDate":"2021-02-10T08:35:13" } ], "executionStatus":"EXECUTED_DENIED", "userTypedIds":[ "2147483721.U" ], "lastAccess":"2021-02-10T08:35:13", "minApprovalsNeeded":1, "userName":"e2e admin", "delegatedToTypedIds":[ ], "userGroupTypedIds":null, "userTypedId":"2147483721.U", "uniqueName":"Admin Approval", "denialReasons":[ ], "userGroupName":null, "isDenialReasonOptional":"true", "userNames":[ "e2e admin" ], "comment":"Not approved", "mandatoryComments":[ ] } ], "approvableTypedId":"2147489670.Q", "currentStepId":null, "submitReason":null, "submitterUserName":"Admin", "denialReasons":[ ], "submitterTypedId":"2147483691.U", "isDenialReasonOptional":"true", "id":"29fa9901-4938-4c3b-a551-3b7c6f0f099f", "isAddStepRestrictedToWFAdmin":"false" } } ], "status":0 } } |
Get a list of approved documents | Retrieves a list of all documents with workflow status 'Approved' where the current user was involved as an approver. | /pricefx/{partition}/workflowsmanager.fetch
Payload Expand source
{ "data": { "criteria": [ { "fieldName": "workflowStatus", "operator": "equals", "value": "APPROVED" } ] } } |
Response Expand source
{ "response":{ "status":0, "startRow":0, "node":"user1", "data":[ { "version":6, "typedId":"2147483664.W", "uniqueName":"R-2147483648-2147483664", "label":"R-2147483648 (Test Rebate Agreement)", "approvableTypedId":"2147483648.RBA", "approvableUniqueName":"R-2147483648", "workflowStatus":"APPROVED", "code":"RBA", "storesOnlyHeaderOfApprovableState":false, "createDate":"2017-03-06T13:08:02", "createdBy":5351, "lastUpdateDate":"2017-03-06T13:09:01", "lastUpdateBy":2147483655 }, { "version":10, "typedId":"2147483679.W", "uniqueName":"R-2147483651-2147483679", "label":"R-2147483651 (New Rebate Agreement)", "approvableTypedId":"2147483651.RBA", "approvableUniqueName":"R-2147483651", "workflowStatus":"APPROVED", "code":"RBA", "storesOnlyHeaderOfApprovableState":false, "createDate":"2017-03-06T15:01:17", "createdBy":5351, "lastUpdateDate":"2017-03-06T15:05:02", "lastUpdateBy":5351 }, { "version":5, "typedId":"2147483683.W", "uniqueName":"R-2147483652-2147483683", "label":"R-2147483652 (New Rebate Agreement)", "approvableTypedId":"2147483652.RBA", "approvableUniqueName":"R-2147483652", "workflowStatus":"APPROVED", "code":"RBA", "storesOnlyHeaderOfApprovableState":false, "createDate":"2017-03-06T15:19:33", "createdBy":5351, "lastUpdateDate":"2017-03-06T15:19:50", "lastUpdateBy":2147483655 }, { "version":5, "typedId":"2147483684.W", "uniqueName":"R-2147483653-2147483684", "label":"R-2147483653 (New Rebate Agreement)", "approvableTypedId":"2147483653.RBA", "approvableUniqueName":"R-2147483653", "workflowStatus":"APPROVED", "code":"RBA", "storesOnlyHeaderOfApprovableState":false, "createDate":"2017-03-06T15:23:33", "createdBy":5351, "lastUpdateDate":"2017-03-06T15:24:15", "lastUpdateBy":2147483655 } ], "endRow":4 } } |
Logics
Action | Description | Request | Response |
---|---|---|---|
Execute a Calculation Logic | When you use the output=rawjson parameter, it returns the response in the simple format: listing only calculation results and excluding all other fields. | /pricefx/{partition}/formulamanager.executeformula/{formula name}?output=rawjson |
- No labels