Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

params:
    worksetKey (required)
    costObjectKey (required)

service:
    calls raft.services.costobjectCostObject.forecast.list.url: '/rest/v2/forecast?worksetKey=:wsKey&costObjectKey=:coKey'  
      calls raft.services.costobjectCostObject.forecast.list.type: get

Wiki Markup
\[GET\] /rest/v2/forecast/:forecastId
--> get a single forecast
Ledger::getLedger

params:
    costObjectKey (required)
    budgetVersion (required)
    startDate (required)
    endDate (required)

service:
     callsraft.services.costobjectCostObject.forecast.get.url: '/rest/v2/forecast/:forecastId?worksetKey=:wsKey&costObjectKey=:coKey&startData=:startDate&endDate=:endDate'
     callsraft.services.costobjectCostObject.forecast.get.type: get

Wiki Markup
\[PUT\] /rest/v2/forecast
--> create new forecast
CostObject::createCOScenario

params:
    costObjectKey (required)
    worksetKey (required)
    title (required)
    description (required)

service:
    calls raft.services.costobjectCostObject.forecast.create.url: '/rest/v2/forecast'
    calls raft.services.costobjectCostObject.forecast.create.type: put

...

params:
    costObjectKey (required)
    title (required)
    description (required)

service:  
    calls raft.services.costobjectCostObject.forecast.update.url: '/rest/v2/forecast/:forecastId?costObjectKey=:coKey'
    calls raft.services.costobjectCostObject.forecast.update.type: post

...

params:
    costObjectKey (required)

service:
    calls raft.services.costobjectCostObject.forecast.delete.url: '/rest/v2/forecast/:forecastId'
    calls raft.services.costobjectCostObject.forecast.delete.type: delete

...

params:
    scenarioKey (required)

service:
    callsraft.services.scenarioScenario.cache.commit.url: '/rest/v2/forecast/cache'
    calls raft.services.scenarioScenario.cache.commit.type: post

Wiki Markup
\[DELETE\] /rest/v2/forecast/cache
 --> clears all forecast temps for a given user
Ledger::releaseTemp

service:
    calls raft.services.scenarioScenario.cache.clear.url: '/rest/v2/forecast/cache'
    calls raft.services.scenarioScenario.cache.get.type: delete

Wiki Markup
\[GET\] /rest/v2/forecast/cache/status
 --> provides cache status with the type & key of the resource stored in cache 
Ledger::checkTemp

service:
    calls raft.services.scenarioScenario.cache.getStatus.url: '/rest/v2/forecast/cache/status'
    calls raft.services.scenarioScenario.cache.getStatus.type: get

...

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
    Not found in service file

Wiki Markup
\[POST\] /rest/v2/speculation/expense/:speculationId
 --> update/save an expense
Ledger::updateExpenseSpeculation(speculation)
returns ForecastData

...