Jump to

• Request
• Response

Get Participants

get

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

Gets scenario participants by scenario ID.

Request

Path Parameters

• scenarioId: integer(int64)

  Scenario ID.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario participants returned successfully.

Body ()

Root Schema : Participants

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

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

Nested Schema : items

Type: array

Show Source

• Array of: object Participant

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "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"
    }
}

400 Response

Bad Request

Failed to get scenario participants. The scenario ID may be invalid.

500 Response

Internal Server Error.

Back to Top