移動先

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

シナリオ・スクリプトの取得

get

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

シナリオ・スクリプトを取得します。

リクエスト

パス・パラメータ

• scenarioId(required): integer(int64)

  シナリオID。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

シナリオ・スクリプトが正常に返されました。

本体()

ルート・スキーマ : Comments

型: 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/ScriptBean"
            }
        },
        "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":"Comments"
    }
}

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

型: array

ソースの表示

• 配列: object Script

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• content: string

  スクリプトの内容。

• type: string
  指定可能な値: [ "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 レスポンス

不正なリクエスト

シナリオ・スクリプトの取得に失敗しました。シナリオIDが無効である可能性があります。

500 レスポンス

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

先頭に戻る