機械翻訳について
  1. Oracle EssbaseのREST API
  2. タスク
  3. ジョブ

ジョブ・リストの取得

get

/essbase/rest/v1/jobs

ジョブ・ステータス、タイプ、入出力情報など、指定された問合せパラメータのジョブ・リストを返します。 問合せパラメータが指定されていない場合は、すべてのジョブのリストを返します。

要求

問合せパラメータ

  • ジョブ・レコードを取得するアプリケーション名。

  • ジョブID、アプリケーション名、データベース名、ジョブ・ファイル名(スクリプト)またはユーザー名の一部である可能性があるキーワードを使用して、ジョブ・レコードをフィルタします。 このパラメータとfullAppNameの両方が指定されている場合、fullAppNameが優先されます。

  • フェッチするジョブの最大数。

    デフォルト値: 50

  • 結果セットの先頭から除外するジョブの数。

    デフォルト値: 0

  • Order By仕様。 デフォルトでは、ジョブ・レコードはジョブIDによって降順で返されます。

    デフォルト値 : job_ID:desc

  • ジョブ・レコードにバックアップ・ジョブを含めます。

    デフォルト値: false
先頭に戻る

レスポンス

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

200 レスポンス

OK

ジョブ・レコードが正常に返されました。

本文()
ルート・スキーマ : JobRecordPaginatedResultWrapper
タイプ: object
Show Source
ネストされたスキーマ : items
タイプ: array
Show Source
ネストされたスキーマ : properties
タイプ: object
許可される追加プロパティ
Show Source
ネストされたスキーマ : JobRecordBean
タイプ: object
Show Source
ネストされたスキーマ : jobInputInfo
タイプ: object
許可される追加プロパティ
Show Source
ネストされたスキーマ : jobOutputInfo
タイプ: object
許可される追加プロパティ
Show Source
ネストされたスキーマ : additionalProperties
タイプ: object
ネストされたスキーマ : additionalProperties
タイプ: object

500 レスポンス

内部サーバー・エラー。

503 レスポンス

サービスは使用できません

ネーミング例外またはサーバー例外。

先頭に戻る

例

次の例では、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、フィルタされたジョブ・リストを返す方法を示します。

コール元のユーザーIDおよびパスワードは、properties.batで値が設定される変数です。

cURLコマンドを含むスクリプト

curl -X GET "https://192.0.2.1:443/essbase/rest/v1/jobs?keyword=ASO_Sample.xlsx&offset=0&limit=10&systemjobs=false"
     -H  "accept: application/json"
     -u %User%:%Password%

レスポンス本体の例

{
  "items": [
    {
      "job_ID": 3,
      "appName": "ASOSamp",
      "dbName": "Basic",
      "jobType": "Import Excel",
      "jobfileName": "ASO_Sample.xlsx",
      "userName": "power1",
      "startTime": 1574812065000,
      "endTime": 1574812135000,
      "statusCode": 200,
      "statusMessage": "Completed",
      "links": [
        {
          "rel": "canonical",
          "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/3",
          "method": "GET"
        },
        {
          "rel": "post",
          "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/3",
          "method": "POST"
        }
      ]
    },
    {
      "job_ID": 2,
      "appName": "ASOSamp",
      "dbName": "Basic",
      "jobType": "Import Excel",
      "jobfileName": "ASO_Sample.xlsx",
      "userName": "power1",
      "startTime": 1574810127000,
      "endTime": 1574810180000,
      "statusCode": 200,
      "statusMessage": "Completed",
      "links": [
        {
          "rel": "canonical",
          "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/2",
          "method": "GET"
        },
        {
          "rel": "post",
          "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/2",
          "method": "POST"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 10,
  "count": 2,
  "totalResults": 2,
  "hasMore": false
}
先頭に戻る