1. REST API Reference
  2. APIs for Management Ledger
  3. Run ML Calculation

Run ML Calculation

Use this operation to run calculations for a selected Management Ledger application.

Table 3-10 Run ML Calculation

Name Description
Action Type POST
Request URI http://{HostName}/profitability/rest/v1/applications/{applicationName}/povs/{povGroupMember}/jobs/runLedgerCalculationJob
Request Payload 
{
"isClearCalculated":"true",
"isExecuteCalculations":"true",
"isRunNow":"true",
"comment":"This is run by user1",
"subsetStart":10,
"subsetEnd":20,
"ruleName":"Utilities Expense Adjustment",
"ruleSetName":"Occupancy Expense Allocations",
"exeType":"ALL_RULES",
"stringDelimter":"_"
}
Response 
{
  "type": "Profitability",
  "links": [
    {
      "href": "http://slc06vya.mydomain.com:19000/profitability/rest/v1/applications/BksML1/povs/2010_January_Actual/jobs/runLedgerCalculationJob",
      "action": "POST",
      "rel": "self",
      "data": {
        "isExecuteCalculations": true,
        "subsetStart": 10,
        "ruleSetName": "Occupancy Expense Allocations",
        "comment": "This is run by user1",
        "subsetEnd": 20,
        "stringDelimter": "_",
        "ruleName": "Utilities Expense Adjustment",
        "isClearCalculated": true,
        "isRunNow": true,
        "exeType": "ALL_RULES"
      }
    },
    {
      "href": "http://SLC06VYA.mydomain.com:19000/profitability/rest/v1/applications/jobs/ChecktaskStatusJob/BksML1_BksML1_RunCalcs_D20160113T070358_1da_1",
      "action": "GET",
      "rel": "Job status"
    }
  ],
  "status": -1,
  "details": "BksML1_BksML1_RunCalcs_D20160113T070358_1da_1",
  "statusMessage": "IN_PROGRESS"
}
Process Type Asynchronous

Table 3-11 Request Parameters

Parameter Description Example
applicationName Application Name BksML1
povGroupMember POV member group 2023_January_Actual

Table 3-12 Response Values

Parameter Description Example
Details CES Task Id BksML1_BksML1_RunCalcs_D20160113T060906_868_1