Jump to

• Request
• Response

Add Participant

post

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

Adds a scenario participant to the specified scenario ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• scenarioId: integer(int64)

  Scenario ID.

Body ()

Participant details.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario participant added successfully.

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top