Jump to

• Request
• Response

Add Approver

post

/essbase/rest/v1/scenarios/{scenarioId}/approvers

Adds a scenario approver. Approvers are optional, and must have Database Access or higher role. They monitor and approve or reject scenarios. If a scenario has multiple approvers, each one must approve before it can be submitted.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• scenarioId: integer(int64)

  Scenario ID.

Body ()

Approver details.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario approver added successfully.

400 Response

Bad Request

Failed to add approver. The scenario ID may be invalid, or the scenario may already have been submitted for approval.

500 Response

Internal Server Error.

Back to Top