機械翻訳について

ジャンプ先

• 要求
• レスポンス
• 例

ジョブの取得

get

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

ジョブ・ステータス、タイプ、入出力情報など、指定されたジョブIDのジョブ情報を返します。

要求

パス・パラメータ

• id: string
  ジョブID

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

OK

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

本文()

ルート・スキーマ : JobRecordBean

タイプ: object

Show Source

• appName(optional): string

  アプリケーション名

• dbName(optional): string

  キューブ名。

• endTime(optional): integer(int64)

  ジョブの終了時間。

• job_ID(optional): integer(int64)

  ジョブのID番号。

• jobfileName(optional): string
• jobInputInfo(optional): object jobInputInfo
  許可される追加プロパティ: additionalProperties
• jobOutputInfo(optional): object jobOutputInfo
  許可される追加プロパティ: additionalProperties
• jobType(optional): string

  ジョブのタイプ。 例: dataload, dimbuild, calc, clear, importExcel, exportExcel, lcmExport, lcmImport, clearAggregation, buildAggregation, asoBufferDataLoad, asoBufferCommit, exportData, mdxScript。

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

  ジョブの開始時間。

• statusCode(optional): integer(int32)

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

  
  

  statusCode	statusMessage
  100	IN_PROGRESS
  200	COMPLETED
  300	COMPLETED_WITH_WARNINGS
  400	FAILED

• statusMessage(optional): string

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

  
  

  statusCode	statusMessage
  100	IN_PROGRESS
  200	COMPLETED
  300	COMPLETED_WITH_WARNINGS
  400	FAILED

• userName(optional): 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"
        },
        "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

許可される追加プロパティ

Show Source

• object additionalProperties

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

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

タイプ: object

許可される追加プロパティ

Show Source

• object additionalProperties

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

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

タイプ: array

Show Source

• Array of: object Link

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

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

タイプ: object

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

タイプ: object

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

500 レスポンス

内部サーバー・エラー。

503 レスポンス

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

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

先頭に戻る

例

次の例では、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、特定のジョブIDのジョブ情報を取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://192.0.2.1:443/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://192.0.2.1:443/essbase/rest/v1/jobs/1534",
      "method": "GET"
    },
    {
      "rel": "post",
      "href": "https://192.0.2.1:443/essbase/rest/v1/jobs/1534",
      "method": "POST"
    }
  ]
}

先頭に戻る