Oracle Analytics ServerのためのREST API

作業リクエスト・アイテムの取得

get

/api/20210901/workRequests/{id}

単一の作業リクエスト・アイテムをIDで返します。

リクエスト

パス・パラメータ

id(必須): string

base64url形式のカタログ品目ID。

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

WorkRequestアイテム。

ルート・スキーマ: WorkRequest

Type: object

ソースを表示

Errors: array Errors

この作業リクエストからのエラー(ある場合)。
id(必須): string
operationType(必須): string

指定できる値: [ "CREATE_SNAPSHOT", "RESTORE_SNAPSHOT", "RELOAD_DATASET", "CREATE_WORKBOOK_EXPORT" ]
percentComplete(必須): number (float)

完了したリクエストの割合。
resources: array resources

この作業リクエストが影響を及ぼすリソース。
resourceType: string

指定できる値: [ "SNAPSHOT", "SYSTEM", "DATASET", "WORKBOOK_EXPORT" ]

作業リクエストに関連付けられたリソースのタイプ。
status(必須): string

指定できる値: [ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]

作業リクエストのステータス。
timeAccepted(必須): string (date-time)

作業リクエストが受け入れられた時刻(RFC3339で定義された形式)。例: `2016-08-25T21:10:29.600Z`
timeFinished: string (date-time)

作業リクエストが終了した時刻(RFC3339で定義された形式)。例: `2016-08-25T21:10:29.600Z`
timeStarted: string (date-time)

作業リクエストが開始された時刻(RFC3339で定義された形式)。例: `2016-08-25T21:10:29.600Z`

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "operationType":{
            "$ref":"#/components/schemas/WorkRequestOperationType"
        },
        "resourceType":{
            "$ref":"#/components/schemas/WorkRequestResourceType"
        },
        "status":{
            "$ref":"#/components/schemas/WorkRequestStatus"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkRequestResource"
            },
            "description":"Resources this work request affects.\n"
        },
        "Errors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkRequestError"
            },
            "description":"Errors from this work request, if any.\n"
        },
        "percentComplete":{
            "type":"number",
            "format":"float",
            "description":"Percentage of the request completed.\n"
        },
        "timeAccepted":{
            "type":"string",
            "format":"date-time",
            "description":"Time the work request was accepted, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n"
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "description":"Time the work request was started, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "description":"Time the work request was finished, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n"
        }
    },
    "required":[
        "id",
        "operationType",
        "status",
        "percentComplete",
        "timeAccepted"
    ]
}

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

Type: array

この作業リクエストからのエラー(ある場合)。

ソースを表示

Array of: WorkRequestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkRequestError"
    },
    "description":"Errors from this work request, if any.\n"
}

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

Type: array

この作業リクエストが影響を及ぼすリソース。

ソースを表示

Array of: object WorkRequestResource

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkRequestResource"
    },
    "description":"Resources this work request affects.\n"
}

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

すべてに一致

ソースを表示

object Error
object WorkRequestError-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "type":"object",
            "properties":{
                "timestamp":{
                    "type":"string",
                    "format":"date-time"
                }
            }
        }
    ]
}

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

ネストされたスキーマ: WorkRequestError-allOf[1]

Type: object

ソースを表示

timestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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

Type: object

ソースを表示

actionResult(必須): string

この作業リクエストによってこのリソースが受けた影響。
id: string

作業リクエストが影響を及ぼすリソースのID。
metadata: object metadata

使用可能なその他のプロパティ: additionalProperties

リソースの追加メタデータ。
resourceType(必須): string

指定できる値: [ "SNAPSHOT", "SYSTEM", "DATASET", "WORKBOOK_EXPORT" ]

作業リクエストに関連付けられたリソースのタイプ。
resourceUri: string

影響を受けるリソースのURI。

{
    "properties":{
        "actionResult":{
            "type":"string",
            "description":"Way in which this resource was affected by this work request.\n"
        },
        "resourceType":{
            "$ref":"#/components/schemas/WorkRequestResourceType"
        },
        "id":{
            "type":"string",
            "description":"ID of the resource the work request is affecting."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Additional metadata of the resource.\n"
        },
        "resourceUri":{
            "type":"string",
            "description":"The URI of the affected resource."
        }
    },
    "required":[
        "actionResult",
        "resourceType"
    ]
}

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

Type: object

使用可能なその他のプロパティ

ソースを表示

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Additional metadata of the resource.\n"
}

リソースの追加メタデータ。

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"
    ]
}

401レスポンス

未承認(資格情報の欠落や期限切れなど)。

ルート・スキーマ: 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"
    ]
}

412レスポンス

前提条件が失敗しました。操作を続行するための1つ以上の前提条件が満たされていません。

ルート・スキーマ: 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"
    ]
}

先頭に戻る

例

workRequestIdまたはoa-work-request-idを使用して、作業リクエストの詳細なステータス情報を取得できます。詳細には、リクエスト・タイプ、リクエストの現在のステータス(RUNNING、SUCCEEDED、FAILEDなど)、完了率および作業リクエストの受入れ、開始および完了の時刻が含まれます。

例: oa-work-request-idを使用したデータセットの作業リクエスト・ステータスの取得

この例では、oa-work-request-idがbidr-1E309E468A4518E149438E31294EB54の作業リクエストに関する情報を取得します。

cURLの例:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request GET 'https://<hostname>/api/20210901/workRequests/bidr-1E309E468A4518E149438E31294EB54'

リクエスト本文の例

Not applicable.

レスポンス本文の例

Status 200:

{

  "id": "bidr-1E309E468A4518E149438E31294EB54",

  "operationType": "RELOAD_DATASET",

  "percentComplete": 100,

  "resourceType": "DATASET",

  "status": "SUCCEEDED",

  "timeAccepted": "2022-07-06T20:25:11.0+0000",

  "timeStarted": "2022-07-06T20:25:32.0+0000",

  "timeFinished": "2022-07-06T20:25:42.0+0000",

}

先頭に戻る