Workset
...
[PUT
...
]
...
/rest/v2/workset/:worksetId/forecast/:forecastId/link
...
--
...
> associate forecast with workset
service
Not found in service file
Forecast
...
[GET
...
]
...
/rest/v2/forecast
...
--> get all forecasts
CostObject::listCOScenarios
...
service:
raft.services.CostObject.calls.forecast.list.url: '/rest/v2/forecast?worksetKey=:wsKey&costObjectKey=:coKey'
raft.services.CostObject.calls.forecast.list.type: getWiki Markup
[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: getunmigrated-wiki-markup\
[PUT
...
]
...
/rest/v2/forecast
...
--> create new forecast
CostObject::createCOScenario
...
service:
raft.services.CostObject.calls.forecast.create.url: '/rest/v2/forecast'
raft.services.CostObject.calls.forecast.create.type: putunmigrated-wiki-markup\
[POST
...
]
...
/rest/v2/forecast/:forecastId
...
--> update forecast metadata
CostObject::updateCOScenario
...
service:
raft.services.CostObject.calls.forecast.update.url: '/rest/v2/forecast/:forecastId?costObjectKey=:coKey'
raft.services.CostObject.calls.forecast.update.type: postunmigrated-wiki-markup\
[DELETE
...
]
...
/rest/v2/forecast/:forecastId
...
--> delete a single forecast
CostObject::deleteCOScenario
...
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: getunmigrated-wiki-markup\
[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: postunmigrated-wiki-markup\
[DELETE
...
]
...
/rest/v2/forecast/
...
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: deleteunmigrated-wiki-markup\
[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
...
service
raft.services.Scenario.calls.cache.speculation.expense.add.url: '/rest/v2/speculation/expense'
raft.services.Scenario.calls.cache.speculation.expense.add.type: 'put';Wiki Markup
[POST
...
]
...
/rest/v2/speculation/expense/:
...
speculationId --> update/save an expense
Ledger::updateExpenseSpeculation(speculation)
returns ForecastData
...
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';Wiki Markup
[DELETE
...
]
...
/rest/v2/speculation/expense/:
...
speculationId --> delete an expense speculation
Ledger::deleteExpenseSpeculation(speculationKey)
returns balance/subtotals
...
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
...
service
raft.services.Scenario.calls.cache.speculation.person.add.url: 'rest/v2/speculation/person
raft.services.Scenario.calls.cache.speculation.person.add.type: 'put';Wiki Markup
[POST
...
]
...
/rest/v2/speculation/person/:
...
speculationId --> update/save person
Ledger::updatePersonSpeculation(speculation)
returns ForecastData ...*Currently subject to cleanup/parm pruning
...
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';Wiki Markup
[DELETE
...
]
...
/rest/v2/speculation/person/:
...
speculationId --> delete person speculation
Ledger::deletePersonSpeculation(speculationKey)
returns balance/subtotals
...
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
...
service
raft.services.Scenario.calls.cache.speculation.expense.addTBH.url: 'rest/v2/speculation/tbh
raft.services.Scenario.calls.cache.speculation.expense.add.type: 'put';Wiki Markup
[POST
...
]
...
/rest/v2/speculation/tbh/:
...
speculationId --> update/save TBH
Ledger::updateTBHLedger(speculation)
returns ForecastData ...*Currently subject to cleanup/parm pruning
...
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 callunmigrated-wiki-markup
\[GET\] /rest/v2/autocomplete/people people --> takes a string (at least 3-character long) an returns a list
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 fileWiki Markup
[GET
...
]
...
/rest/v2/person/:personId/appointment
...
--> get appointments for a person
Forecast::listPersonAppt
service
...
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 fileunmigrated-wiki-markup\
[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
...