機械翻訳について

ジャンプ先

• 要求
• レスポンス

シナリオ処理の実行

post

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

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

要求

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

• application/json
• application/xml

パス・パラメータ

• id: integer(int64)

  シナリオID。

問合せパラメータ

• action(optional): string

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

• overwrite(optional): boolean

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

  デフォルト値: false

本文()

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

ルート・スキーマ : ScenarioActionPayload

タイプ: object

Show Source

• comment(optional): string
• copyOptions(optional): object CopyOptions
• to(optional): string

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

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

タイプ: object

Show Source

• approvers(optional): boolean
• comments(optional): boolean
• data(optional): boolean
• keyMetrics(optional): boolean
• layouts(optional): boolean
• participants(optional): boolean
• properties(optional): boolean
• slice(optional): boolean
• tasks(optional): 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

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "scenarioUser":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "database":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "createdTime":{
            "type":"integer",
            "format":"int64"
        },
        "participants":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParticipantBean"
            }
        },
        "useCalculatedValues":{
            "type":"boolean"
        },
        "overdue":{
            "type":"boolean"
        },
        "submittedTime":{
            "type":"integer",
            "format":"int64"
        },
        "appliedTime":{
            "type":"integer",
            "format":"int64"
        },
        "refreshedTime":{
            "type":"integer",
            "format":"int64"
        },
        "commentsCount":{
            "type":"integer",
            "format":"int32"
        },
        "owner":{
            "type":"string"
        },
        "scripts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScriptBean"
            }
        },
        "approvers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApproverBean"
            }
        },
        "sandbox":{
            "type":"string"
        },
        "dueDate":{
            "type":"integer",
            "format":"int64"
        },
        "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"
    }
}

ネストされたスキーマ : 承認者

タイプ: array

Show Source

• Array of: object Approver

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

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

タイプ: array

Show Source

• Array of: object Link

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

ネストされたスキーマ : 参加者

タイプ: array

Show Source

• Array of: object Participant

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

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

タイプ: array

Show Source

• Array of: object Script

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

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

タイプ: object

Show Source

• approved(optional): boolean
• email(optional): string
• id(optional): string
• name(optional): string
• time(optional): 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"
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

ネストされたスキーマ : 参加者

タイプ: 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"
    }
}

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

タイプ: object

Show Source

• content(optional): string
• type(optional): string
  許可される値: [ "REFRESH", "CLEAR", "APPLY" ]

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "REFRESH",
                "CLEAR",
                "APPLY"
            ]
        }
    },
    "xml":{
        "name":"Script"
    }
}

400 レスポンス

不正なリクエスト

シナリオ・アクションの実行に失敗しました。 シナリオIDが無効である可能性があります。

500 レスポンス

内部サーバー・エラー。

先頭に戻る