移動先

• リクエスト
• レスポンス
• 例

ジョブの取得

get

/essbase/rest/v1/jobs/{id}

ジョブのステータス、タイプおよび入出力情報を含め、指定されたジョブIDのジョブの情報を返します。

リクエスト

パス・パラメータ

• id(required): string
  ジョブID

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

OK

ジョブ情報が正常に返されました。

本体()

ルート・スキーマ : JobRecordBean

型: object

ソースの表示

• appName: string

  アプリケーション名。

• dbName: string

  キューブ名。

• endTime: integer(int64)

  ジョブの終了時間。

• job_ID: integer(int64)

  ジョブのID番号。

• jobfileName: string

  ジョブに使用されるスクリプト・ファイル。

• jobInputInfo: object jobInputInfo
  使用可能なその他のプロパティ: additionalProperties
• jobOutputInfo: object jobOutputInfo
  使用可能なその他のプロパティ: additionalProperties
• jobType: string

  ジョブのタイプ。たとえば、dataload、dimbuild、calc、clear、importExcel、exportExcel、lcmExport、lcmImport、clearAggregation、buildAggregation、asoBufferDataLoad、asoBufferCommit、exportData、mdxScriptです。

• links: array links
• startTime: integer(int64)

  ジョブの開始時間。

• statusCode: integer(int32)

  進行状況を示すジョブ・ステータス・コード。各コードには、対応するstatusMessageがあります。

  
  

  statusCode	statusMessage
  100	IN_PROGRESS
  200	COMPLETED
  300	COMPLETED_WITH_WARNINGS
  400	FAILED

• statusMessage: string

  進行状況を示すジョブ・ステータス・メッセージ文字列。各文字列には、対応するstatusCodeがあります。

  
  

  statusCode	statusMessage
  100	IN_PROGRESS
  200	COMPLETED
  300	COMPLETED_WITH_WARNINGS
  400	FAILED

• userName: string

  ジョブを実行したユーザー。ユーザーは、割り当てられているユーザー役割に基づいてジョブ・リストにアクセスできます。たとえば、サービス管理者役割がある場合は、すべてのジョブを表示できます。ユーザー役割がある場合は、自分が実行したジョブのみを表示できます。

{
    "type":"object",
    "properties":{
        "job_ID":{
            "type":"integer",
            "format":"int64",
            "description":"<p>ID number of the job.</p>"
        },
        "appName":{
            "type":"string",
            "description":"<p>Application name.</p>"
        },
        "dbName":{
            "type":"string",
            "description":"<p>Cube name.</p>"
        },
        "jobType":{
            "type":"string",
            "description":"<p>The type of job. Examples: <code>dataload</code>, <code>dimbuild</code>, <code>calc</code>, <code>clear</code>, <code>importExcel</code>, <code>exportExcel</code>, <code>lcmExport</code>, <code>lcmImport</code>,  <code>clearAggregation</code>, <code>buildAggregation</code>, <code>asoBufferDataLoad</code>, <code>asoBufferCommit</code>, <code>exportData</code>, <code>mdxScript</code>.</p>"
        },
        "jobfileName":{
            "type":"string",
            "description":"<p>The script file used for the job.</p>"
        },
        "userName":{
            "type":"string",
            "description":"<p>User who ran the job. Users have access to job listings based on their assigned user role. For example, if you have the Service Administrator role, you can see all jobs; if you have the User role, you can see only the jobs you ran.</p>"
        },
        "startTime":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Start time of the job.</p>"
        },
        "endTime":{
            "type":"integer",
            "format":"int64",
            "description":"<p>End time of the job.</p>"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Job status code indicating progress. Each code has a corresponding <i>statusMessage</i>.</p><br><table><tr><th>statusCode</th><th>statusMessage</th></tr><tr><td>100</td><td>IN_PROGRESS</td></tr><tr><td>200</td><td>COMPLETED</td></tr><tr><td>300</td>    <td>COMPLETED_WITH_WARNINGS</td></tr><tr><td>400</td><td>FAILED</td></tr></table>"
        },
        "statusMessage":{
            "type":"string",
            "description":"<p>Job status message string indicating progress. Each string has a corresponding <i>statusCode</i>.</p><br><table><tr><th>statusCode</th><th>statusMessage</th></tr><tr><td>100</td><td>IN_PROGRESS</td></tr><tr><td>200</td><td>COMPLETED</td></tr><tr><td>300</td>    <td>COMPLETED_WITH_WARNINGS</td></tr><tr><td>400</td><td>FAILED</td></tr></table>"
        },
        "jobInputInfo":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "jobOutputInfo":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: object

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

ソースの表示

• object additionalProperties

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

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

型: object

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

ソースの表示

• object additionalProperties

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

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

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

型: object

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

500 レスポンス

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

503 レスポンス

使用できないサービス

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

先頭に戻る

例

次の例では、指定されたジョブIDのジョブ情報を取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/jobs/1534" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "job_ID": 1534,
  "appName": "ASOSamp",
  "dbName": "Basic",
  "jobType": "Import Excel",
  "jobfileName": "ASO_Sample.xlsx",
  "userName": "power1",
  "startTime": 1574811654000,
  "endTime": 1574811688000,
  "statusCode": 200,
  "statusMessage": "Completed",
  "jobInputInfo": {
    "catalogExcelPath": "/gallery/Applications/Demo Samples/Aggregate Storage/",
    "importExcelFileName": "ASO_Sample.xlsx",
    "isLoadData": false,
    "recreateApplication": true,
    "isCreateFiles": true,
    "isExecuteScript": false
  },
  "jobOutputInfo": {
    "errorMessage": ""
  },
  "links": [
    {
      "rel": "self",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/1534",
      "method": "GET"
    },
    {
      "rel": "post",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/1534",
      "method": "POST"
    }
  ]
}

先頭に戻る