Jump to

• Request
• Response

Get Scenario

get

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

Gets a scenario by ID.

Request

Path Parameters

• id: integer(int64)

  Scenario ID.

Query Parameters

• expand(optional): string

  Value can be all or none. Default value is none, meaning only links are returned. If all is specified, then approvers, participants and scripts are included in the response.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario details returned 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 get scenario details. The scenario ID may be invalid.

500 Response

Internal Server Error.

Back to Top