1. Oracle EssbaseのREST API
  2. タスク
  3. ジョブ

ジョブ・リストの取得

get

/essbase/rest/v1/jobs

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

リクエスト

問合せパラメータ

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

  • ジョブ・レコードを取得するデータベースの名前。

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

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

    デフォルト値: 50

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

    デフォルト値: 0

  • 順序の指定。デフォルトでは、ジョブ・レコードはジョブIDを基準として降順で返されます。

    デフォルト値: job_ID:desc

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

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

レスポンス

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

200 レスポンス

OK

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

本体()
ルート・スキーマ : JobRecordPaginatedResultWrapper
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : JobRecordBean
型: object
ソースの表示
ネストされたスキーマ : jobInputInfo
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : jobOutputInfo
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : additionalProperties
型: object
ネストされたスキーマ : additionalProperties
型: object

500 レスポンス

サーバーの内部エラーです。

503 レスポンス

使用できないサービス

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

先頭に戻る

例

次の例では、フィルタされたEssbaseジョブ・リストを返す方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

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

次の例では、キーワードASO_Sample.xlsxを使用するジョブを最大10個取得します。 

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

レスポンス本体の例

ASO_Sample.xlsxに関連する2つのジョブが返されました。 

{
  "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://myserver.example.com:9001/essbase/rest/v1/jobs/3",
          "method": "GET"
        },
        {
          "rel": "post",
          "href": "https://myserver.example.com:9001/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://myserver.example.com:9001/essbase/rest/v1/jobs/2",
          "method": "GET"
        },
        {
          "rel": "post",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/2",
          "method": "POST"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 10,
  "count": 2,
  "totalResults": 2,
  "hasMore": false
}

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

次の例では、Facilityという名前のアプリケーションのRatingsキューブのすべてのジョブを取得します。

call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/jobs?fullAppName=Facility&fullDatabaseName=Rating&links=none" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

3つのジョブが返されました。

{
  "items" : [ {
    "job_ID" : 128,
    "appName" : "Facility",
    "dbName" : "Rating",
    "jobType" : "Export Data",
    "jobfileName" : null,
    "userName" : "power1",
    "startTime" : 1712778858000,
    "endTime" : 1712778858000,
    "statusCode" : 200,
    "statusMessage" : "Completed"
  }, {
    "job_ID" : 127,
    "appName" : "Facility",
    "dbName" : "Rating",
    "jobType" : "Data Load",
    "jobfileName" : "[\"\"]",
    "userName" : "power1",
    "startTime" : 1712697441000,
    "endTime" : 1712697441000,
    "statusCode" : 200,
    "statusMessage" : "Completed"
  }, {
    "job_ID" : 126,
    "appName" : "Facility",
    "dbName" : "Rating",
    "jobType" : "Clear Data",
    "jobfileName" : null,
    "userName" : "power1",
    "startTime" : 1712697424000,
    "endTime" : 1712697424000,
    "statusCode" : 200,
    "statusMessage" : "Completed"
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" : 3,
  "totalResults" : 3,
  "hasMore" : false
}
先頭に戻る