移動先

• リクエスト
• レスポンス

参加者の取得

get

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

シナリオIDで指定してシナリオ参加者を取得します。

リクエスト

パス・パラメータ

• scenarioId(required): integer(int64)

  シナリオID。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

シナリオ参加者が正常に返されました。

本体()

ルート・スキーマ : Participants

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: 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"
    }
}

ネストされたスキーマ : items

型: array

ソースの表示

• 配列: object Participant

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

ネストされたスキーマ : properties

型: object

使用可能なその他のプロパティ

ソースの表示

• string

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

ネストされたスキーマ : Participant

型: object

ソースの表示

• email: string
• id: string
• name: string

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

400 レスポンス

不正なリクエスト

シナリオ参加者の取得に失敗しました。シナリオIDが無効である可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る