機械翻訳について

ジャンプ先

• 要求
• レスポンス

シナリオの取得

get

/essbase/rest/v1/scenarios

検索基準に一致するシナリオを取得します。 レスポンスには、承認者、参加者、コメントおよびスクリプトを除く、すべての基本シナリオ属性へのリンクが含まれます。

要求

問合せパラメータ

• application(optional): string

  アプリケーション名

• approvalPending(optional): boolean

  シナリオは送信済状態で、承認はログイン・ユーザーから保留中です。

  デフォルト値: false
• count(optional): boolean

  trueの場合、レスポンスにはシナリオの数のみが含まれ、実際のシナリオは含まれません。

  デフォルト値: false
• database(optional): string

  データベース名

• filter(optional): string

  シナリオ名ワイルドカード・パターン。

• limit(optional): integer(int64)

  返されるシナリオの最大数。 デフォルトは50です。

  デフォルト値: 50
• offset(optional): integer(int64)

  結果セットの先頭から除外するシナリオの数。 デフォルトは0です。

  デフォルト値: 0
• orderBy(optional): string

  Order-byフィールドおよび結果セットの順序。 このパラメータの値は、fieldName:asc|descの形式に従う必要があります。 たとえば : name:asc。 デフォルト値はcreatedTime:descです。つまり、最近作成されたシナリオが最初にリストされます。

  デフォルト値 : createdTime:desc
• overdue(optional): boolean

  trueの場合、期日を過ぎたすべてのシナリオを返します。 デフォルトはfalseで、すべてのシナリオが返されることを意味します。

• role(optional): string

  シナリオ・リストをフィルタするためのオプションのユーザー・ロール。 値は、owner、participantまたはapproverです。 ロールがapproverとして指定されている場合、このAPIは、ログイン・ユーザーが承認者であるすべてのシナリオを返します。 デフォルトでは、ログイン・ユーザーが所有者、参加者または承認者であるすべてのシナリオが返されます。

• state(optional): string

  シナリオの状態。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

シナリオ・リストおよび詳細が正常に返されました。

本文()

ルート・スキーマ : シナリオ

タイプ: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScenarioBean"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"Scenarios"
    }
}

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

タイプ: array

Show Source

• Array of: object Scenario

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

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

タイプ: object

許可される追加プロパティ

Show Source

• string

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

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

不正なリクエスト

シナリオの取得に失敗しました。

500 レスポンス

内部サーバー・エラー。

先頭に戻る