移動先

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

コメントの追加

post

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

指定されたシナリオIDにコメントを追加します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• scenarioId(required): integer(int64)

  シナリオID。

本体()

コメントの詳細。

ルート・スキーマ : Comment

型: object

ソースの表示

• id: integer(int64)
• links: array links
• message: string
• owner: object Owner
• time: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "owner":{
            "$ref":"#/definitions/Owner"
        },
        "time":{
            "type":"integer",
            "format":"int64"
        },
        "message":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"Comment"
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

ソースの表示

• id: string
• name: string

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

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

シナリオ・コメントが正常に追加されました。

本体()

ルート・スキーマ : Comment

型: object

ソースの表示

• id: integer(int64)
• links: array links
• message: string
• owner: object Owner
• time: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "owner":{
            "$ref":"#/definitions/Owner"
        },
        "time":{
            "type":"integer",
            "format":"int64"
        },
        "message":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"Comment"
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

ソースの表示

• id: string
• name: string

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

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

コメントの追加に失敗しました。シナリオIDが無効である可能性があります。

500 レスポンス

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

先頭に戻る