Page History

/rest/v2/workset/:workset_id/header

• GET: getWorksetCOHeader

/rest/v2/pi/summary

• GET: getWorksetScenario: input parms: piKey (opt), returns default workset and and forecast keys for a PI

/rest/v2/pi/forecast/:forecast_id

• GET: getBalance/getBalOne: input parms: worksetKey (req), costObjectKey (opt) if costObjectKey is provided, then the call returns balances for a single costobject ONLY

/rest/v2/pi/forecast/cache

• GET: checkWorksetCache
• PUT: populateWorksetCache: input parms: scenarioKey, worksetKey, output: success/fail
• DELETE: deleteWorksetCache: input parms: scenarioKey, output: success/fail

/rest/v2/pi/forecast/period

• GET: getBiCalendar

/rest/v2/pi/

...

forecast/:

...

forecast_id/

...

balance

• GET: getWorksetCOHeadergetBalance/getBalOne: input parms: worksetKey (req), costObjectKey (opt) if costObjectKey is provided, then the call returns balances for a single costobject ONLY

/rest/v2/pi/forecast/:forecast_id/glcategory/:glcategory_id/lineitem/:lineitem_id

• GET: getWorksetPeopleLines | getWorksetExpenseLines | getWorksetExpenseSumm: lineitem_id is omitted | input parms: worksetKey (req), granularity (req if glcategory_id == 'CRAFT-1' --> M = Monthly, S = Semester, FY = Fiscal Year, AY = Academic Year, Y = Calendar Year, CY = Current Year), startDate (opt), endDate (opt), output: array of expense line, NOTE: glcategory_id == 'CRAFT-0' gives 'all expenses' summary; glcategory_id == 'CRAFT-1' gives people line items
  
• POST: (update) expenses (:glcategory_id != 'CRAFT1') - updateExpenseWrk: input parms: worksetKey, costObjectKey, lineItemName, description, startDate, endDate, isRollOff [Y|N], amount, isAmortized [Y|N]
                            people (:glcategory_id == 'CRAFT1') - updatePeopleWrk: input parms: costObjectKey, personnelKey, hrPositionKey, glAccountKey, appointmentKey, granularity, allocation, period
• PUT: (create expense) updateExpenseWrkColl: lineitem_id is omitted | input parms: worksetKey (req), costObjectCollection (req), lineItemName (req), description (req), startDate (req), endDate (req), isRollOff [Y|N] (req), isAmortized [Y|N] (req)
  costObjectCollection must be a json array in the following format:
  

  [

      {"costObjectKey": "P2744125-001", "amount": "111"},

      {"costObjectKey": "P2744125-002", "amount": "222"}

  ]
  (create people – :glcategory_id == 'CRAFT-1') addPeopleWrkColl: lineitem_id is omitted | input parms: personnelKey, hrPositionKey, glAccountKey, appointmentKey, granularity, period, allocationCollection must be a json array in the following format:

  [

      {"costObjectKey": "P2744125-001", "allocation": "50"},

      {"costObjectKey": "P2744125-002", "allocation": "50"}

  ]

• DELETE: deleteExpenseWrk | deletePeopleWrk (:glcategory_id == 'CRAFT1') | revertPeopleWrk (glcategory_id == 'CRAFT1' && revert == 'Y)
  

/rest/v2/pi/forecast/:forecast_id/glcategory/:glcategory_id

...

getWorkset: output: Scenario Key, Workset Key, described in RAFTTHREE-605.

getCalendar: GET, returns calendar data, described in https://jira.mit.edu/jira/browse/RAFTTHREE-571

...