Workset
...
[PUT] /rest/v2/workset/:worksetId/forecast/:forecastId/link --> associate forecast with workset
...
service
Not found in service file
Forecast
[GET]
Forecast
...
/rest/v2/forecast
...
-->
...
get
...
all
...
forecasts
CostObject::listCOScenarios
params:
worksetKey (required)
costObjectKey (required)
service:
raft.services.CostObject.calls.forecast.list.url: '/rest/v2/forecast?worksetKey=:wsKey&costObjectKey=:coKey'
raft.services.CostObject.calls.forecast.list.type: get
[GET] /rest/v2/forecast/:forecastId
...
-->
...
get
...
a
...
single forecast
Ledger::getLedger
params:
costObjectKey (required)
budgetVersion (required)
startDate (required)
endDate (required)
service:
raft.services.CostObject.calls.forecast.get.url: '/rest/v2/forecast/:forecastId?worksetKey=:wsKey&costObjectKey=:coKey&startData=:startDate&endDate=:endDate'
raft.services.CostObject.calls.forecast.get.type: get
[PUT] /rest/v2/forecast
...
-->
...
create
...
| Wiki Markup |
|---|
\[POST\] /rest/v2/forecast/:forecastId \--> save/commit a single forecast |
...
new forecast
CostObject::createCOScenario
params:
costObjectKey (required)
worksetKey (required)
title (required)
description (required)
service:
raft.services.CostObject.calls.forecast.create.url: '/rest/v2/forecast'
raft.services.CostObject.calls.forecast.create.type: put
...
[POST] /rest/v2/forecast/:forecastId --> update forecast metadata
...
CostObject::updateCOScenario
params:
costObjectKey (required)
title (required)
description (required)
service:
raft.services.CostObject.calls.forecast.update.url: '/rest/v2/forecast/:forecastId?costObjectKey=:coKey'
raft.services.CostObject.calls.forecast.update.type: post
...
[DELETE] /rest/v2/forecast/:forecastId --> delete a single forecast
...
CostObject::deleteCOScenario
params:
costObjectKey (required)
service:
raft.services.CostObject.calls.forecast.delete.url: '/rest/v2/forecast/:forecastId'
raft.services.CostObject.calls.forecast.delete.type: delete
Forecast Copy
...
[PUT] /forecast/:forecastId/copy -- covers share and publish forecast -- call is implemented and needs to be documented
...
params:
costObjectKey (required)
targetWorkset (required)
targetScenario (required ??)
fromCache (required ??)
appendCO (required ??)
service
raft.services.CostObject,calls.forecast.publish.url: '/rest/v2/forecast/:id/copy'
raft.services.CostObject,calls.forecast.publish.typel: put
Forecast Cache
...
[GET] /rest/v2/forecast/cache --> retrieves forecast stored in cache
...
Ledger::getCacheLedger
params:
scenarioKey (required)
service:
raft.services.Scenario.calls.cache.get.url: '/rest/v2/forecast/cache'
raft.services.Scenario.calls.cache.get.type: get
...
[POST] /rest/v2/forecast/cache --> save/commit a single forecast that is currently in cache
...
Ledger::commitTemp
params:
scenarioKey (required)
service:
raft.services.Scenario.calls.cache.commit.url: '/rest/v2/forecast/cache'
raft.services.Scenario.calls.cache.commit.type: post
[DELETE] /rest/v2/forecast/
...
Speculation
...
cache --> clears all forecast temps for a given user
Ledger::releaseTemp
service:
raft.services.Scenario.calls.cache.clear.url: '/rest/v2/forecast/cache'
raft.services.Scenario.calls.cache.get.type: delete
...
[GET] /rest/v2/forecast/cache/status --> provides cache status with the type & key of the resource stored in cache
...
Ledger::checkTemp
service:
raft.services.Scenario.calls.cache.getStatus.url: '/rest/v2/forecast/cache/status'
raft.services.Scenario.calls.cache.getStatus.type: get
Speculation
[GET] /rest/v2/speculation/expense/gl
...
-->
...
return
...
a
...
hierarchical
...
list
...
of
...
GLs
...
-
...
- this call is NOT needed at the moment
*Ledger::getGls(glcat_key)
service
Not found in service file
Expense
[PUT] /rest/v2/speculation/expense
...
-->
...
create
...
new
...
expense
...
speculation(needs
...
GL
...
category)
Ledger::createExpenseSpeculation
params:
costObjectKey (required)
scenarioKey (required)
glCategory (required)
startDate (required) – start date of the view
endDate (required) – end date of the view
speculationStartDate (required) – start date of the speculation
speculationEndDate (required) – end date of the speculation
service
raft.services.Scenario.calls.cache.speculation.expense.add.url: '/rest/v2/speculation/expense'
raft.services.Scenario.calls.cache.speculation.expense.add.type: 'put';
...
[POST] /rest/v2/speculation/expense/:speculationId --> update/save an expense
...
Ledger::updateExpenseSpeculation(speculation)
returns ForecastData
params:
costObjectKey (required)
scenarioKey (required)
speculationName (optional)
description (optional)
glKey (optional)
startDate (required) – start date of the view
endDate (required) – end date of the view
speculationStartDate (required) – start date of the speculation
speculationEndDate (required) – end date of the speculation
cost (required)
isRollOff (required)
service
raft.services.Scenario.calls.cache.speculation.expense.add.url: 'rest/v2/speculation/expense/:speculationId'
raft.services.Scenario.calls.cache.speculation.expense.add.type: 'post';
[DELETE] /rest/v2/speculation
...
/expense/:speculationId --> delete an expense speculation
Ledger::deleteExpenseSpeculation(speculationKey)
returns balance/subtotals
params:
costObjectKey (required)
scenarioKey (required)
startDate (required) – start date of the view
endDate (required) – end date of the view
service
raft.services.Scenario.calls.cache.speculation.expense.add.url: 'rest/v2/speculation/expense/:speculationId'
raft.services.Scenario.calls.cache.speculation.expense.add.type: 'delete';
Person
[PUT] /rest/v2/speculation/person
...
-->
...
create
...
new person speculation
Ledger::createPersonSpeculation
returns Personspeculation
params:
costObjectKey (required)
scenarioKey (required)
startDate (required)
endDate (required)
service
raft.services.Scenario.calls.cache.speculation.person.add.url: 'rest/v2/speculation/person
raft.services.Scenario.calls.cache.speculation.person.add.type: 'put';
[POST] /rest/v2/speculation/
...
person/:
...
speculationId -->
...
update/save person
Ledger::updatePersonSpeculation(speculation)
returns ForecastData ...*Currently subject to cleanup/parm pruning
params:
costObjectKey (required)
scenarioKey (required)
speculationName (optional)
description (optional) (maps to front end "comment")
appointmentSubtypeKey (required)
personnelKey (required)
hrPositionKey (required)
speculationStartDate (required) – start date of the speculation
speculationEndDate (required) – end date of the speculation
percent (required)
onOffCampus (required) ON|OFF
service
raft.services.Scenario.calls.cache.speculation.person.add.url: 'rest/v2/speculation/person/:speculationId'
raft.services.Scenario.calls.cache.speculation.person.add.type: 'post';
[DELETE] /rest/v2/speculation/person/:
...
speculationId --> delete person speculation
Ledger::deletePersonSpeculation(speculationKey)
returns balance/subtotals
params:
costObjectKey (required)
scenarioKey (required)
startDate (required) – start date of the view
endDate (required) – end date of the view
service
raft.services.Scenario.calls.cache.speculation.person.add.url: 'rest/v2/speculation/person/:speculationId'
raft.services.Scenario.calls.cache.speculation.person.add.type: 'delete';
TBH
[PUT] /rest/v2/speculation/
...
tbh --> create new TBH speculation
Ledger::createTBHSpeculation
params:
jobKey (required)
costObjectKey (required)
scenarioKey (required)
startDate (required)
endDate (required)
service
raft.services.Scenario.calls.cache.speculation.expense.addTBH.url: 'rest/v2/speculation/tbh
raft.services.Scenario.calls.cache.speculation.expense.add.type: 'put';
[POST] /rest/v2/speculation/
...
tbh/:
...
Person
...
speculationId --> update/save TBH
Ledger::updateTBHLedger(speculation)
returns ForecastData ...*Currently subject to cleanup/parm pruning
params:
costObjectKey (required)
scenarioKey (required)
speculationName (optional)
description (optional) (maps to front end "comment")
appointmentSubtypeKey (required)
personnelKey (required)
hrPositionKey (required)
startDate (required) – start date of the view
endDate (required) – end date of the view
speculationStartDate (required) – start date of the speculation
speculationEndDate (required) – end date of the speculation
percent (required)
onOffCampus (required) ON|OFF
appointmentChange: (Y|N) (required) if appointmentChange is Y, one or more of the following four fields is required
fullName
baseAmount
payBasis
hourlyRate
workWeek
service
raft.services.Scenario.calls.cache.speculation.person.update.url: 'rest/v2/speculation/person/:speculationId'
raft.services.Scenario.calls.cache.speculation.person.update.type: post
Person
[GET] /rest/v2/person/:personId
...
-->
...
return
...
person
...
data
...
(perhaps
...
only
...
data
...
subset)
MOVE TO STRIKE updated person data appears in the returned speculation from an update call
[GET] Wiki Markup Wiki Markup
costObject::listautocomplete(people)
params:
filter (required) -- string (at least 3-character long)
limit (optional) -- integer (NOT working at the moment)
service
Not found in service file
[GET] /rest/v2/person/:personId/appointment
...
-->
...
get
...
appointments
...
for a person
Forecast::listPersonAppt
service
raft.services.Person.getAppointments.url: '/rest/v2/person/:id/appointment'
raft.services.Person.getAppointments.type: get
Appointment
TBH
...
[GET] /rest/v2/tbh/list --> takes a string (at least 3-character long) an returns a list
...
costObject::listautocomplete(positions)
service
Not found in service file
...
[GET] /rest/v2/tbh/:tbhId/appointment --> takes a string (at least 3-character long) an returns a list
...
costObject::listautocomplete(positionsAppt)
service
Not found in service file
* Model call not ready a person