ジョブ起動情報の登録

登録済みのジョブ起動情報を取得します。

Examples

REQUEST EXAMPLE

HULFT for zOS のサンプルは以下となります。

{
  "id": "JOBID",
  "comment": "COMMENT",
  "startup_job": [
    "DUMP1",
    "COMP1",
    "COMP2"
  ],
  "zos": {
    "jcl_library": "HUL.FT01.JCL",
    "job_rc_criterion": 4
  }
}

Request Interface

http://ControlURL/api/v1/hulft/{hulft-host-id}/managements/jobs/detail

= 備考 =

上のRequest InterfaceのURLで、斜体の文字部分に指定するパスについては以下を参照してください。

HULFT10 API Gateway ガイド : Request Interfaceの指定

REQUEST BODY SCHEMA : application/json

id : string

ジョブID （必須）

起動するジョブを認識するID

1～50バイト以内で指定します。

このジョブIDと配信管理情報および集信管理情報のジョブIDが関連づけされます。

comment : string

起動ジョブに対するコメント

0～60バイト以内で指定します。

startup_job : array

メンバー名（必須）

起動するジョブのメンバー名

1ジョブにつき、8バイト以内

最大起動ジョブ数：90

zos : object

z/OS（汎用機）環境管理情報（必須）

jcl_library : string

JCLライブラリ名（必須）

「起動ジョブ」が格納されているJCLライブラリ名

1～44バイト以内で指定します。

MainframeのJCLライブラリ名の命名規約に従って指定します。

job_rc_criterion : integer

ジョブRC判定正常の最大値

起動するジョブのリターンコードを正常とみなす最大値

0～4095の値を指定します。

省略すると、“0”が設定されます。

「起動ジョブ」で指定したジョブを実行したときのリターンコードが「ジョブRC判定正常の最大値」で指定した値以下の場合、正常終了とみなされます。

Response Interface

201 Created 情報登録

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

meta : object

メタデータ

os_type : string

接続先ホスト機種

以下のいずれかが取得されます。

windows: : Windows環境管理情報
linux: : Linux/AIX環境管理情報
ibmi: : IBM i（AS/400）環境管理情報
zos: : z/OS（汎用機）環境管理情報

request_user_role : string

API実行ユーザーの権限

以下のいずれかが取得されます。

admin: : ユーザーの管理や接続先HULFTの追加を行うことができる権限
member: : 登録済みのHULFTへの接続を行うことができる権限

strong_key_mode : string

高強度暗号強制モードの設定値

以下のいずれかが取得されます。

disable: : 無効
enable: : 有効

product_version : string

製品バージョン

id : string

ジョブID

comment : string

startup_job : array

メンバー名

zos : object

z/OS（汎用機）環境管理情報

jcl_library : string: JCLライブラリ名
job_rc_criterion : integer: ジョブRC判定正常の最大値

400 リクエストエラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string

エラー種別

description : string

エラーの説明

measure : string

対処方法

detail : string

詳細エラー情報

additional : (Error1(object or null)) or (Error2(object or null))

"Error1"、"Error2"のいずれかが取得されます。

Error1

message : string: バリデーションエラーメッセージ
fields : string: バリデーションフィールド情報

Error2

code : integer: HULFT実行結果
detail : string: HULFT詳細コード
latest_process_id : string: 最新処理ID
message : string: HULFTエラーメッセージ

]

401 認証エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

403 認可エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

409 登録済みのIDを指定

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

500 サーバー内部エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

502 HULFT接続エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string

エラー種別

description : string

エラーの説明

measure : string

対処方法

detail : string

詳細エラー情報

additional : object

HULFTエラー追加情報

code : integer: HULFT実行結果
detail : string: HULFT詳細コード
latest_process_id : string: 最新処理ID
message : string: HULFTエラーメッセージ

]

504 タイムアウトエラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]