scenario

Update an existing scenario

patch/v1/org/{orgId}/scenario/{scenarioId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/scenario/{scenarioId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

scenarioIdstring required

Scenario id

Query parameters

silentboolean

Suppress notification emails

Request body

namestring

scenario name

descriptionstring

scenario description

startDatestring date

date that this scenario diverges from primary

status'OPEN' | 'INACTIVE' | 'MERGED' | 'DRAFT' | 'ARCHIVED'

status of scenario

startDateFixed'FIXED' | 'TODAY'

FIXED keeps startDate as set; TODAY moves the start date to the current date as time passes. BUDGET scenarios use FIXED.

validJobIdSetstring[]

This scenario changes are restricted to the following jobIds

entityIdstring

The entity this scenario is associated with

entityType'COMP_REVIEW' | 'ASSESSMENT'

The type of entity associated with this scenario

Example request

{
  "name": "Q4 Conservative Plan",
  "description": "Q4 Conservative Plan",
  "startDate": "2017-01-15",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "validJobIdSet": [
    "588f7ee98f138b19220041a7"
  ],
  "entityId": "588f7ee98f138b19220041a7",
  "sharedViewConfig": [
    {
      "updateId": "588f7ee98f138b19220041a7"
    }
  ]
}

Response

scenario updated

Changes

No recorded changes to this operation across all 22 revisions of this API.