Jump to

• Request
• Response

Perform Scenario Action

post

/essbase/rest/v1/scenarios/{id}

Performs the specified scenario workflow action. Common actions are submit to submit a scenario for approval, approve to approve a scenario, reject to reject it, and apply to overwrite the base data with the scenario data. Additional actions include copy, refresh, and clear.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)

  Scenario ID.

Query Parameters

• action(optional): string

  Valid values are submit, approve, reject, apply, copy, refresh, and clear.

• overwrite(optional): boolean

  Optional overwrite parameter, applicable only when action is refresh. If true, when the base and scenario data have different values, the base value overwrites the scenario changes. Default is false.

  Default Value: false

Body ()

Action parameters. Copy options are applicable only in case of copy. Comment is applicable only for workflow actions.

Root Schema : ScenarioActionPayload

Type: object

Show Source

• comment(optional): string
• copyOptions(optional): object CopyOptions
• to(optional): string

{
    "type":"object",
    "properties":{
        "comment":{
            "type":"string"
        },
        "to":{
            "type":"string"
        },
        "copyOptions":{
            "$ref":"#/definitions/CopyOptions"
        }
    }
}

Nested Schema : CopyOptions

Type: object

Show Source

• approvers(optional): boolean
• comments(optional): boolean
• data(optional): boolean
• keyMetrics(optional): boolean
• layouts(optional): boolean
• participants(optional): boolean
• properties(optional): boolean
• slice(optional): boolean
• tasks(optional): boolean

{
    "type":"object",
    "properties":{
        "properties":{
            "type":"boolean"
        },
        "comments":{
            "type":"boolean"
        },
        "data":{
            "type":"boolean"
        },
        "tasks":{
            "type":"boolean"
        },
        "keyMetrics":{
            "type":"boolean"
        },
        "slice":{
            "type":"boolean"
        },
        "layouts":{
            "type":"boolean"
        },
        "approvers":{
            "type":"boolean"
        },
        "participants":{
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario action performed successfully.

Body ()

Root Schema : Scenario

Type: object

Show Source

• application(optional): string
• appliedTime(optional): integer(int64)
• approvers(optional): array approvers
• commentsCount(optional): integer(int32)
• createdTime(optional): integer(int64)
• database(optional): string
• description(optional): string
• dueDate(optional): integer(int64)
• id(optional): integer(int64)
• links(optional): array links
• name(optional): string
• overdue(optional): boolean
• owner(optional): string
• participants(optional): array participants
• priority(optional): string
  Allowed Values: [ "LOW", "MEDIUM", "HIGH" ]
• refreshedTime(optional): integer(int64)
• sandbox(optional): string
• scenarioUser(optional): boolean
• scripts(optional): array scripts
• state(optional): string
  Allowed Values: [ "NEW", "SUBMITTED", "APPROVED", "REJECTED", "APPLIED" ]
• submittedTime(optional): integer(int64)
• useCalculatedValues(optional): boolean

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "scenarioUser":{
            "type":"boolean"
        },
        "scripts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScriptBean"
            }
        },
        "approvers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApproverBean"
            }
        },
        "sandbox":{
            "type":"string"
        },
        "dueDate":{
            "type":"integer",
            "format":"int64"
        },
        "commentsCount":{
            "type":"integer",
            "format":"int32"
        },
        "overdue":{
            "type":"boolean"
        },
        "createdTime":{
            "type":"integer",
            "format":"int64"
        },
        "submittedTime":{
            "type":"integer",
            "format":"int64"
        },
        "appliedTime":{
            "type":"integer",
            "format":"int64"
        },
        "refreshedTime":{
            "type":"integer",
            "format":"int64"
        },
        "useCalculatedValues":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "participants":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParticipantBean"
            }
        },
        "database":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "state":{
            "type":"string",
            "enum":[
                "NEW",
                "SUBMITTED",
                "APPROVED",
                "REJECTED",
                "APPLIED"
            ]
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "priority":{
            "type":"string",
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH"
            ]
        }
    },
    "xml":{
        "name":"Scenario"
    }
}

Nested Schema : approvers

Type: array

Show Source

• Array of: object Approver

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApproverBean"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : participants

Type: array

Show Source

• Array of: object Participant

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParticipantBean"
    }
}

Nested Schema : scripts

Type: array

Show Source

• Array of: object Script

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScriptBean"
    }
}

Nested Schema : Approver

Type: object

Show Source

• approved(optional): boolean
• email(optional): string
• id(optional): string
• name(optional): string
• time(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "email":{
            "type":"string"
        },
        "approved":{
            "type":"boolean"
        },
        "time":{
            "type":"integer",
            "format":"int64"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "xml":{
        "name":"Approver"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Participant

Type: object

Show Source

• email(optional): string
• id(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "email":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "xml":{
        "name":"Participant"
    }
}

Nested 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"
    }
}

400 Response

Bad Request

Failed to perform scenario action. The scenario ID may be invalid.

500 Response

Internal Server Error.

Back to Top