Jump to

• Request
• Response

Update Scenario with Script

put

/essbase/rest/v1/scenarios/{scenarioId}/scripts/{scriptType}

Updates scenario using script of specified type.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• scenarioId: integer(int64)

  Scenario ID.

• scriptType: string

  Script type. Valid values are: refresh to revert to base, apply to commit to base, and clear to set to #Missing.

Body ()

Script details.

Root Schema : Script

Type: object

Show Source

• content(optional): string
• type(optional): string
  Allowed Values: [ "REFRESH", "CLEAR", "APPLY" ]

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "REFRESH",
                "CLEAR",
                "APPLY"
            ]
        }
    },
    "xml":{
        "name":"Script"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

204 Response

OK

Scenario updated successfully.

400 Response

Bad Request

Failed to update scenario with script. The scenario ID or script type may be invalid.

500 Response

Internal Server Error.

Back to Top