7.1.3 実行結果詳細の取得API
実行が終了したユニットの，実行結果の詳細を取得します。
実行結果の詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド 12.3.39 ［実行結果詳細］ダイアログボックス」を参照してください。
- 実行権限
-
ログインしたJP1ユーザーが，情報を取得するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。
-
JP1_AJS_Admin権限
-
JP1_AJS_Manager権限
-
JP1_AJS_Editor権限
-
JP1_AJS_Operator権限
-
JP1_AJS_Guest権限
-
- リクエストの形式
-
- リクエスト行
GET /application/component/apiVersion/objects/statuses/unitName:execID/actions/execResultDetails/invoke?query httpVersion
- APIのバージョン
-
v1
- リソースを一意に識別する情報
-
リソースを一意に識別する情報を次の表に示します。
なお，パラメーターの指定に誤りがある場合，またはパラメーターを指定しなかった場合は，リソースを一意に識別できないため，ステータスコード「404」のエラーになります。
リソースを一意に識別する情報
データ型
説明
必須・任意
unitName
string
要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。
必須
execID
string
実行IDを，文字列で指定します。
指定する形式は「@[mmmm]{A〜Z}nnnn」です（例：@10A200）。
必須
- パラメーター
-
「query」に指定するパラメーターを次の表に示します。
表7‒3 実行結果詳細の取得APIのパラメーター一覧 パラメーター
値の説明
必須・任意
manager
マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。
必須
serviceName
スケジューラーサービス名を，1〜30バイトの文字列で指定します。
必須
- ステータスコード
-
レスポンスで返却するステータスコードを次の表に示します。
ステータスコード
メッセージ
説明
200
OK
実行結果詳細の取得に成功しました。
400
Bad Request
クエリ文字列が不正です。
401
Unauthorized
認証が必要です。
403
Forbidden
実行権限がありません。
404
Not found
リソースにアクセスする権限がありません。または，リソースがありません。
409
Conflict
リクエストは現在のリソースの状態と矛盾しているため，処理を続行できません。
412
Precondition failed
Web Consoleサーバが利用できません。
500
Server-side error
Web Consoleサーバ処理エラーが発生しました。
- レスポンスの形式
-
- レスポンスのメッセージボディ
{ "execResultDetails":"実行結果詳細", "all":すべての情報を取得できたかどうか }
- 戻り値
-
ステータスコードが「200」の場合，次の情報を返却します。
メンバー
データ型
説明
execResultDetails
string
実行結果詳細を5メガバイト以内の文字列で返却します。実行結果詳細が5メガバイトを超える場合，5メガバイトを超える情報は切り捨てられるため，末尾の文字を文字として識別できないおそれがあります。
実行結果詳細には，ジョブを実行した環境の改行コード（¥nまたは¥r¥n）が含まれます。表示する環境に合わせて改行コードを置換してください。
実行結果詳細がない場合は，空文字列（0バイト）を返却します。
all
boolean
すべての実行結果詳細を取得できたかどうかを返却します。
すべての実行結果詳細を取得できた場合，「true」を返却します。すべての実行結果詳細を取得できなかった場合，「false」を返却します。
- 使用例
-
指定したジョブの実行結果詳細を取得するAPIの使用例を次に示します。
- リクエストの例
GET /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet%2FJob:%40A100/actions/execResultDetails/invoke?manager=HOSTM&serviceName=AJSROOT1 HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
- レスポンスの例
HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store, no-cache, max-age=0 Date: Mon, 08 Aug 2016 09:39:28 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server { "execResultDetails": "実行結果詳細", "all": true }