Oracle Analytics ServerのためのREST API

シーケンスの実行

post

/api/20210901/catalog/sequences/{sequenceId}/actions/run

指定されたIDの既存のシーケンスを実行します。進行状況をモニターできるように、oa-work-request-idを返します。

リクエスト

パス・パラメータ

sequenceId(必須): string(byte)

Base64URLエンコーディングを使用したシーケンスのオブジェクトID。たとえば、シーケンスにオブジェクトID 'User1'.'sequence1'がある場合、Base64URLでエンコードされた値J1VzZXIxJy4nc2VxdWVuY2UxJw==を入力します。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

202レスポンス

非同期操作が開始されました。

ヘッダー

oa-work-request-id:

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404レスポンス

見つかりません。リクエストされたリソースが見つかりませんでした。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

409レスポンス

競合(操作によって制約違反が発生し、操作が現在の状態と互換性がないなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る

例

この例では、特定のsequenceIDを使用してシーケンスを実行します。シーケンスのオブジェクトIDは'adminuser'.'mySequence'で、Base64URLセーフでエンコードされたsequenceID値はJ2FkbWludXNlcicuJ215U2VxdWVuY2Unです。

cURLの例:

まず、削除するデータ・フローのオブジェクトIDを取得し、この値をBase64URLセーフでエンコードしてdataFlowIDを決定します。「オブジェクトID」の値は、Oracle Analyticsインスタンスのデータ・フローの「検査」ダイアログから取得できます。

必要なsequenceIDを指定してcURLコマンドを実行します。

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request POST 'https://<hostname>/api/20210901/catalog/sequences/J2FkbWludXNlcicuJ215U2VxdWVuY2Un/actions/run' \

リクエスト本文の例

適用不可。

レスポンス本文の例

Status 200:

先頭に戻る