移動先

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

シナリオ・アクションの実行

post

/essbase/rest/v1/scenarios/{id}

指定されたシナリオ・ワークフロー・アクションを実行します。一般的なアクションとしては、承認のためにシナリオを送信するsubmit、シナリオを承認するapprove、それを却下するreject、および基本データをシナリオ・データで上書きするapplyがあります。その他のアクションとしては、copy、refreshおよびclearがあります。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• id(required): integer(int64)

  シナリオID。

問合せパラメータ

• action: string

  有効な値は、submit、approve、reject、apply、copy、refreshおよびclearです。

• overwrite: boolean

  オプションのoverwriteパラメータは、actionがrefreshの場合のみ適用できます。trueの場合、基本データとシナリオ・データとで異なる値があるときは、基本値でシナリオの変更内容が上書きされます。デフォルトはfalseです。

  デフォルト値: false

本体()

アクションのパラメータ。コピー・オプションは、コピーの場合のみ適用できます。コメントは、ワークフロー・アクションの場合のみ適用できます。

ルート・スキーマ : ScenarioActionPayload

型: object

ソースの表示

• comment: string
• copyOptions: object CopyOptions
• to: string

{
    "type":"object",
    "properties":{
        "comment":{
            "type":"string"
        },
        "to":{
            "type":"string"
        },
        "copyOptions":{
            "$ref":"#/definitions/CopyOptions"
        }
    }
}

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

型: object

ソースの表示

• approvers: boolean
• comments: boolean
• data: boolean
• keyMetrics: boolean
• layouts: boolean
• participants: boolean
• properties: boolean
• slice: boolean
• tasks: boolean

{
    "type":"object",
    "properties":{
        "properties":{
            "type":"boolean"
        },
        "comments":{
            "type":"boolean"
        },
        "data":{
            "type":"boolean"
        },
        "tasks":{
            "type":"boolean"
        },
        "keyMetrics":{
            "type":"boolean"
        },
        "slice":{
            "type":"boolean"
        },
        "layouts":{
            "type":"boolean"
        },
        "approvers":{
            "type":"boolean"
        },
        "participants":{
            "type":"boolean"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

シナリオ・アクションが正常に実行されました。

本体()

ルート・スキーマ : Scenario

型: object

ソースの表示

• application: string
• appliedTime: integer(int64)
• approvers: array approvers
• commentsCount: integer(int32)
• createdTime: integer(int64)
• database: string
• description: string
• dueDate: integer(int64)
• id: integer(int64)
• links: array links
• name: string
• overdue: boolean
• owner: string
• participants: array participants
• priority: string
  指定可能な値: [ "LOW", "MEDIUM", "HIGH" ]
• refreshedTime: integer(int64)
• sandbox: string
• scenarioUser: boolean
• scripts: array scripts
• state: string
  指定可能な値: [ "NEW", "SUBMITTED", "APPROVED", "REJECTED", "APPLIED" ]
• submittedTime: integer(int64)
• useCalculatedValues: boolean

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "scenarioUser":{
            "type":"boolean"
        },
        "scripts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScriptBean"
            }
        },
        "approvers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApproverBean"
            }
        },
        "sandbox":{
            "type":"string"
        },
        "dueDate":{
            "type":"integer",
            "format":"int64"
        },
        "commentsCount":{
            "type":"integer",
            "format":"int32"
        },
        "overdue":{
            "type":"boolean"
        },
        "createdTime":{
            "type":"integer",
            "format":"int64"
        },
        "submittedTime":{
            "type":"integer",
            "format":"int64"
        },
        "appliedTime":{
            "type":"integer",
            "format":"int64"
        },
        "refreshedTime":{
            "type":"integer",
            "format":"int64"
        },
        "useCalculatedValues":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "participants":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParticipantBean"
            }
        },
        "database":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "state":{
            "type":"string",
            "enum":[
                "NEW",
                "SUBMITTED",
                "APPROVED",
                "REJECTED",
                "APPLIED"
            ]
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "priority":{
            "type":"string",
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH"
            ]
        }
    },
    "xml":{
        "name":"Scenario"
    }
}

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

型: array

ソースの表示

• 配列: object Approver

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

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

型: array

ソースの表示

• 配列: object Link

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

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

型: array

ソースの表示

• 配列: object Participant

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

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

型: array

ソースの表示

• 配列: object Script

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

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

型: object

ソースの表示

• approved: boolean
• email: string
• id: string
• name: string
• time: integer(int64)

{
    "type":"object",
    "properties":{
        "email":{
            "type":"string"
        },
        "approved":{
            "type":"boolean"
        },
        "time":{
            "type":"integer",
            "format":"int64"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "xml":{
        "name":"Approver"
    }
}

ネストされたスキーマ : 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"
        }
    }
}

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

型: object

ソースの表示

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

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

ネストされたスキーマ : 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 レスポンス

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

先頭に戻る