Systemwalker Operation Manager リファレンス集

18.3.3 jobsリソース

Systemwalker Operation Managerに登録済みのジョブを操作します。

以下の操作が可能です。

エンドポイント (/Systemwalker-omgr/api 以降)	HTTP メソッド	操作内容
/v1/projects/{projectname}/jobnets/{jobnetname}/jobs/{jobnumber}	GET	指定したジョブの情報を取得します。
	POST	指定したジョブを操作します。
/v1/jobs	GET	ジョブ情報の一覧を取得します。

jobsリソースのオブジェクトのフィールドは、以下のとおりです。

なお、システムで一意のプロジェクトを指定する場合、SE版では、プロジェクト名とジョブネット名、ジョブ番号を指定します。EE版およびGEE版では、サブシステム番号とプロジェクト名、ジョブネット名、ジョブ番号を指定します。

フィールド名	型	説明
host	文字列	接続先のホスト名
subsystem	数値	サブシステム番号
projectname	文字列	プロジェクト名
jobnetname	文字列	ジョブネット名
jobnumber	数値	ジョブ番号
jobname_jes	文字列	ジョブ実行制御でのジョブ名
jobiconex	文字列	アイコン種別の説明文
jobicon	リスト	アイコン種別 返却値は“4.10.2 ジョブ制御文”のアイコン種別を参照してください。
jobname	文字列	アイコン種別によって返却値が異なります。 JNET：子ジョブネットのジョブネット名 LNET：リンクジョブネットのジョブネット名 BJOB：バッチジョブ定義名 INTS：ワークユニット名 上記以外：ジョブとして起動するバッチプログラム名、コマンド名、またはプログラム名
jobparam	文字列	ジョブのパラメータ
directory	文字列	ディレクトリ
jobcomment	文字列	アイコン種別によって返却値が異なります。 JNET：子ジョブネットのジョブネット名称 LNET：リンクジョブネットのジョブネット名称 上記以外：ジョブへのコメント
req_host	文字列	依頼ホスト名 複数指定されている場合は、,(カンマ)区切りで返却します。
status	リスト	ジョブの状態(注1)
starttime	日時	前回の開始日時
endtime	日時	前回の終了日時
endcode	数値	終了コード 未実行のジョブの終了コードは0です。

注1)

statusフィールドの返却値は以下のとおりです。

フィールド値	ジョブの状態
Abend	異常終了
Forced	強制終了
Pause	停止中
Execute	実行中
Wait	実行待ち
Pseudo	疑似正常
Normal	正常終了
Disable	無効状態
Delay	実行遅延
Warning	警告
Pass & W	パス状態(実行待ち)
Pass & P	パス状態(停止中)
Pass & D	パス状態(無効状態)

18.3.3.1 ジョブ情報の取得

機能説明

jobsリソースを指定したGETメソッドのリクエストを送ることで、対象のジョブ情報を取得します。

実行に必要な権限/実行環境

指定のジョブが存在するプロジェクトに対して、参照権以上の権限が必要です。

リクエスト

HTTPメソッド

GET

リクエストURI

/v1/subsystems/{subsystem}/projects/{projectname}/jobnets/{jobnetname}/jobs/{jobnumber}

/v1/projects/{projectname}/jobnets/{jobnetname}/jobs/{jobnumber}  (サブシステム番号を省略する場合)

リクエストパラメータ

パスパラメータで、以下のパラメータを指定します。

パラメータ	指定方法	型	説明
subsystem	パス	数値	対象のジョブが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。
projectname(*)	パス	文字列	対象のジョブが存在するプロジェクト名を指定します。
jobnetname(*)	パス	文字列	対象のジョブが存在するジョブネット名を指定します。
jobnumber(*)	パス	数値	対象のジョブ番号(注1)を指定します。

(*)：必須のパラメータ

パス：パスパラメータ

注1)

ジョブ番号は、ジョブ制御文で指定した番号です。“18.3.3.3 ジョブ情報の一覧取得”のWeb APIで取得し、そのジョブネットに登録されているジョブのジョブ番号を確認できます。

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード	説明
200	リクエストの処理が正常終了しました。
401	認証情報の指定に誤りがあります。
404	対象のジョブは存在しません。 システムに対象のジョブが存在しない パスパラメータの指定内容が誤っている
500	リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

対象のjobsリソースのオブジェクトを返却します。

使用例

サブシステム番号0、プロジェクト名が“SampleProject”、ジョブネット名が“SampleJobnet”、ジョブ番号が1のジョブを取得する場合のAPIの使用例を以下に示します。なお、レスポンス例は、dataフィールドに格納されるjobsリソースのオブジェクトを示しており、レスポンスヘッダおよび他のフィールドは省略しています。

リクエスト例

GET /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject/jobnets/SampleJobnet/jobs/1 HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************

レスポンス例

{
  "host": "Systemwalker Operation Managerサーバのホスト名",
  "subsystem": 0,
  "projectname": "SampleProject",
  "jobnetname": "SampleJobnet",
  "jobnumber": 1,
  "jobname_jes": "SampleJob",
  "jobiconex": "Execute command",
  "jobicon": "CMND",
  "jobname": "SampleJob",
  "jobparam": "",
  "directory": "",
  "jobcomment": "コマンド実行",
  "req_host": "",
  "status": "Normal",
  "starttime": "2019/12/31 12:00:00",
  "endtime": "2019/12/31 12:00:01",
  "endcode": 0
}

18.3.3.2 ジョブの操作

機能説明

jobsリソースを指定したPOSTメソッドのリクエストを送ることで、対象のジョブを操作します。

実行に必要な権限/実行環境

指定のジョブが存在するプロジェクトに対して、操作権以上の権限が必要です。

リクエスト

HTTPメソッド

POST

リクエストURI

/v1/subsystems/{subsystem}/projects/{projectname}/jobnets/{jobnetname}/jobs/{jobnumber}

/v1/projects/{projectname}/jobnets/{jobnetname}/jobs/{jobnumber}  (サブシステム番号を省略する場合)

リクエストパラメータ

パスパラメータおよびリクエストボディで、以下のパラメータを指定します。

パラメータ	指定方法	型	説明
subsystem	パス	数値	対象のジョブが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。
projectname(*)	パス	文字列	対象のジョブが存在するプロジェクト名を指定します。
jobnetname(*)	パス	文字列	対象のジョブが存在するジョブネット名を指定します。
jobnumber(*)	パス	数値	対象のジョブ番号(注1)を指定します。
control(*)	ボディ	リスト	ジョブへの操作種別を指定します。(注2)

(*)：必須のパラメータ

パス：パスパラメータ

ボディ：リクエストボディ

注1)

ジョブ番号は、ジョブ制御文で指定した番号です。“18.3.3.3 ジョブ情報の一覧取得”のWeb APIで任意のジョブネットに絞り込むことで、そのジョブネットに登録されているジョブのジョブ番号を確認できます。

注2)

メッセージボディのcontrolパラメータで指定可能な値は、以下のとおりです。

指定値	説明
cancel	実行中のジョブや実行遅延のジョブを強制的に終了します。
pause	実行待ちのジョブや終了したジョブを停止状態にします。
continue	停止中のジョブを停止解除します。
disable	実行待ち/停止中/終了したジョブを無効状態にします。
enable	無効状態のジョブを無効解除します。
rerun	異常終了または強制終了したジョブを再起動します。

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード	説明
202	リクエストの処理が正常終了しました。
400	リクエストパラメータに誤りがあります。 必須パラメータを指定していない 指定不要のパラメータを指定している パラメータの指定値に誤りがある
401	認証情報の指定に誤りがあります。
403	対象のプロジェクトへの権限がありません。
404	対象のジョブは存在しません。 システムに対象のジョブが存在しない パスパラメータの指定内容が誤っている
409	対象のジョブへの指定の操作はできません。 指定の操作ができるジョブの状態ではない
500	リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

指定したjobsリソースのオブジェクトを返却します。

注意

Web APIによるジョブネットへの操作は、Systemwalker Operation Managerサーバの処理と同期を取っていません。そのため、Web APIのレスポンスはサーバでの処理の完了を保証するものではありません。レスポンスボディで返却するオブジェクトは、操作が反映されていない場合があります。

使用例

サブシステム番号0、プロジェクト名が“SampleProject、ジョブネット名が“SampleJobnet”、ジョブ番号が5のジョブを再起動する場合のAPIの使用例を次に示します。

リクエスト例

POST /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject/jobnets/SampleJobnet/jobs/5 HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
Content-Type: application/json

{
  "control": "rerun"
}

レスポンス例

“18.3.3.1 ジョブ情報の取得”のレスポンス例を参照してください。

18.3.3.3 ジョブ情報の一覧取得

機能説明

jobsリソースの一覧を取得します。

対象は、認証情報に指定したユーザが参照権以上を持つプロジェクトに存在するジョブネットのジョブとなります。

リクエスト

HTTPメソッド

GET

リクエストURI

/v1/jobs

リクエストパラメータ

共通仕様のクエリパラメータが使用できます。

詳細については、“18.2.3.2 リクエストの形式”を参照してください。

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード	説明
200	リクエストの処理が正常終了しました。
400	リクエストパラメータに誤りがあります。 指定不要のパラメータを指定している 同じクエリパラメータを複数指定している
401	認証情報の指定に誤りがあります。
500	リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

jobsリソースのオブジェクトを返却します。

使用例

サブシステム0に登録されたジョブの一覧を取得する場合のAPIの使用例を次に示します。

リクエスト例

GET /Systemwalker-omgr/api/v1/jobs?subsystem=0 HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************

レスポンス例

dataフィールドのオブジェクト配列として、jobsリソースのオブジェクトを返却します。jobsリソースのオブジェクトについては、“18.3.3.1 ジョブ情報の取得”のレスポンス例を参照してください。