REST API for Oracle Essbase

Get Scenarios

get

/essbase/rest/v1/scenarios

Get scenarios matching search criteria. Response includes links to all basic scenario attributes, excluding approvers, participants, comments, and scripts.

Request

Query Parameters

application: string

Application name.
approvalPending: boolean

Scenario is in submitted state, and approval is pending from logged in user.

Default Value: false
count: boolean

If true, response contains only the count of scenarios, and not actual scenarios.

Default Value: false
database: string

Database name.
filter: string

Scenario name wildcard pattern.
limit: integer(int64)

Maximum number of scenarios to return. Default is 50.

Default Value: 50
offset: integer(int64)

Number of scenarios to omit from the start of the result set. Default is 0.

Default Value: 0
orderBy: string

Order-by field and order for the result set. The value of this parameter must follow the format of fieldName:asc|desc. For example: name:asc. Default value is createdTime:desc, meaning that scenarios are listed with the most recently created scenarios first.

Default Value: createdTime:desc
overdue: boolean

If true, returns all scenarios past the due date. Default is false, meaning all scenarios are returned.
role: string

Optional user role by which to filter the scenario list. Value can be owner, participant, or approver. If role is specified as approver, this API returns all scenarios for which the logged in user is the approver. By default, all scenarios are returned for which the logged in user is either an owner, a participant, or an approver.
state: string

Scenario state.

Response

Supported Media Types

application/json
application/xml

200 Response

Scenario list and details returned successfully.

Root Schema : Scenarios

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScenarioBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"Scenarios"
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Scenario

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : Scenario

Type: object

Show Source

application: string
appliedTime: integer(int64)
approvers: array approvers
commentsCount: integer(int32)
createdTime: integer(int64)
database: string
description: string
dueDate: integer(int64)
id: integer(int64)
links: array links
name: string
overdue: boolean
owner: string
participants: array participants
priority: string

Allowed Values: [ "LOW", "MEDIUM", "HIGH" ]
refreshedTime: integer(int64)
sandbox: string
scenarioUser: boolean
scripts: array scripts
state: string

Allowed Values: [ "NEW", "SUBMITTED", "APPROVED", "REJECTED", "APPLIED" ]
submittedTime: integer(int64)
useCalculatedValues: 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: boolean
email: string
id: string
name: string
time: 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: string
method: string
rel: string
type: string

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

Nested Schema : Participant

Type: object

Show Source

email: string
id: string
name: string

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

Nested Schema : Script

Type: object

Show Source

content: string

Script contents.
type: string

Allowed Values: [ "REFRESH", "CLEAR", "APPLY" ]

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string",
            "description":"<p>Script contents.</p>"
        },
        "type":{
            "type":"string",
            "enum":[
                "REFRESH",
                "CLEAR",
                "APPLY"
            ]
        }
    },
    "xml":{
        "name":"Script"
    }
}

400 Response

Bad Request

Failed to get scenarios.

500 Response

Internal Server Error.