Systemwalker Operation Managerに登録済みのジョブネットを操作します。
以下の操作が可能です。
エンドポイント | HTTP | 操作内容 |
|---|---|---|
/v1/projects/{projectname}/jobnets/{jobnetname} | GET | 指定したジョブネットの情報を取得します。 |
POST | 指定したジョブネットを操作します。 | |
/v1/jobnets | GET | ジョブネット情報の一覧を取得します。 |
jobnetsリソースのオブジェクトのフィールドは、以下のとおりです。
なお、システムで一意のプロジェクトを指定する場合、SE版では、プロジェクト名とジョブネット名を指定します。EE版およびGEE版では、サブシステム番号とプロジェクト名、ジョブネット名を指定します。
フィールド名 | 型 | 説明 |
|---|---|---|
host | 文字列 | 接続先のホスト名 |
subsystem | 数値 | サブシステム番号 |
projectname | 文字列 | プロジェクト名 |
jobnetname | 文字列 | ジョブネット名 |
jobnetcomment | 文字列 | ジョブネット名称 |
parentname | 文字列 | 親ジョブネット名 子ジョブネットまたはリンクジョブネットの場合、親ジョブネット名を返却します。また、グループに登録されたジョブネットの場合、グループ名を返却します。 上記のいずれでもない場合、空文字を返却します。 |
layertype | リスト | 階層の種別(注1) |
linktype | リスト | リンクジョブネットの種別(注2) |
copystarttype | リスト | 複写起動の種別(注3) |
execcondition | リスト | ジョブネットの起動条件(注4) |
defaulthost | 文字列 | デフォルトホスト名 複数指定されている場合は、,(カンマ)区切りで返却します。 |
execpattern | 文字列 | 起動日雛形名 複数指定されている場合は、半角空白区切りで返却します。 |
holidaycalendar | 文字列 | カレンダ名 複数指定されている場合は、,(カンマ)区切りで返却します。 |
messagename | 文字列 | メッセージ事象名 複数指定されている場合は、,(カンマ)区切りで返却します。 |
status | リスト | ジョブネットの状態(注5) |
remarks | 文字列 | ジョブネットメモ |
starttime | 日時 | 前回の開始日時 |
endtime | 日時 | 前回の終了日時 |
scheduledtime | 日時 | 次回の起動予定日時 |
estimatedendtime | 日時 | 次回の終了予定日時 |
layertypeフィールドの返却値は以下のとおりです。
フィールド値 | 階層の種別 |
|---|---|
None | なし |
Parent | 親ジョブネット |
Child | 子ジョブネット |
Grouped | グループに登録されたジョブネット |
linktypeフィールドの返却値は以下のとおりです。
フィールド値 | リンクジョブネットの種別 |
|---|---|
None | なし |
Linked | リンクジョブネット |
MasterLinked | マスタリンクジョブネット |
copystarttypeフィールドの返却値は以下のとおりです。
フィールド値 | 複写起動の種別 |
|---|---|
None | なし |
CopySource | 複写元ジョブネット |
Copied | 複写先ジョブネット |
execconditionフィールドの返却値は以下のとおりです。
フィールド値 | ジョブネットの起動条件 |
|---|---|
None | なし |
SingleTime | 時刻起動(単一起動) |
MultiTime | 時刻起動(複数起動) |
Interval | 間隔起動 |
ServerStartup | サーバ起動時に起動 |
MessageEvent | メッセージ事象発生時のみ起動 |
statusフィールドの返却値は以下のとおりです。
フィールド値 | ジョブネットの状態 |
|---|---|
Abend | 異常終了 |
Warning | 警告 |
Forced | 強制終了 |
CarryOver | 持ち越し |
StartDelay | 開始遅延 |
EndDelay | 終了遅延 |
Pause | 一時停止 |
Execute | 実行中 |
Wait | 実行待ち |
Pseudo | 疑似正常 |
Normal | 正常終了 |
Coped | 確認済 |
Disable | 無効状態 |
機能説明
jobnetsリソースを指定したGETメソッドのリクエストを送ることで、対象のジョブネット情報を取得します。
実行に必要な権限/実行環境
指定のジョブネットが存在するプロジェクトに対して、参照権以上の権限が必要です。
リクエスト
GET
/v1/subsystems/{subsystem}/projects/{projectname}/jobnets/{jobnetname}
/v1/projects/{projectname}/jobnets/{jobnetname} (サブシステム番号を省略する場合)
パスパラメータで、以下のパラメータを指定します。
パラメータ | 指定方法 | 型 | 説明 |
|---|---|---|---|
subsystem | パス | 数値 | 対象のジョブネットが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。 |
projectname(*) | パス | 文字列 | 対象のジョブネットが存在するプロジェクト名を指定します。 |
jobnetname(*) | パス | 文字列 | 対象のジョブネット名を指定します。 |
(*)：必須のパラメータ
パス：パスパラメータ
レスポンス
以下のHTTPステータスコードを返却します。
コード | 説明 |
|---|---|
200 | リクエストの処理が正常終了しました。 |
401 | 認証情報の指定に誤りがあります。 |
404 | 対象のジョブネットは存在しません。
|
500 | リクエストの処理中にサーバで異常が発生しました。 |
対象のjobnetsリソースのオブジェクトを返却します。
使用例
サブシステム番号0、プロジェクト名が“SampleProject”、ジョブネット名が“SampleJobnet”のジョブネットを取得する場合のAPIの使用例を以下に示します。なお、レスポンス例は、dataフィールドに格納されるjobnetsリソースのオブジェクトを示しており、レスポンスヘッダおよび他のフィールドは省略しています。
GET /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject/jobnets/SampleJobnet HTTP/1.1 Host: Systemwalker Operation Managerサーバのホスト名:9900 Authorization: Basic ********************
{
"host": "Systemwalker Operation Managerサーバのホスト名",
"subsystem": 0,
"projectname": "SampleProject",
"jobnetname": "SampleJobnet",
"jobnetcomment": "SampleJobnet_Comment",
"parentname": "",
"layertype": "None",
"linktype": "None",
"copystarttype": "None",
"execcondition": "SingleTime",
"defaulthost": "SampleHost",
"execpattern": "execpattern1",
"holidaycalendar": "holidaycalendar1",
"messagename": "message1",
"status": "Normal",
"remarks": "SampleJobnet_Memo",
"starttime": "2019/12/31 12:00:00",
"endtime": "2019/12/31 12:00:01",
"scheduledtime": "2020/01/01 12:00:00",
"estimatedendtime": "2020/01/01 12:00:01"
}機能説明
jobnetsリソースを指定したPOSTメソッドのリクエストを送ることで、対象のジョブネットを操作(強制終了/起動/再起動/停止/停止解除/無効/無効解除/確認/終了取消/持越解除)します。
実行に必要な権限/実行環境
指定のジョブネットが存在するプロジェクトに対して、操作権以上の権限が必要です。
リクエスト
POST
/v1/subsystems/{subsystem}/projects/{projectname}/jobnets/{jobnetname}
/v1/projects/{projectname}/jobnets/{jobnetname} (サブシステム番号を省略する場合)
パスパラメータおよびリクエストボディで、以下のパラメータを指定します。
パラメータ | 指定方法 | 型 | 説明 |
|---|---|---|---|
subsystem | パス | 数値 | 対象のジョブネットが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。 |
projectname(*) | パス | 文字列 | 対象のジョブネットが存在するプロジェクト名を指定します。 |
jobnetname(*) | パス | 文字列 | 対象のジョブネット名を指定します。 |
control(*) | ボディ | リスト | ジョブネットへの操作種別を指定します。(注1) |
vparam | ボディ | 文字列 | 可変パラメタを指定します。 |
(*)：必須のパラメータ
パス：パスパラメータ
ボディ：リクエストボディ
メッセージボディのcontrolパラメータで指定可能な値は、以下のとおりです。
指定値 | 説明 |
|---|---|
start | ジョブネットを起動します。 |
cancel | ジョブネットを強制終了します。 |
cope | 異常終了したジョブネットを確認済状態にします。 |
reinstate | ジョブネットの終了取消を行います。 |
revoke | ジョブネットの持越解除を行います。 |
pause | ジョブネットを停止中の状態にします。 |
continue | ジョブネットの“停止”を行う前の状態にします。 |
disable | ジョブネットを無効状態にします。 |
enable | ジョブネットの“無効”を行う前の状態にします。 |
rerun | 異常終了、強制終了または確認済にしたジョブネットを再起動します。 |
レスポンス
以下のHTTPステータスコードを返却します。
コード | 説明 |
|---|---|
202 | リクエストの処理が正常終了しました。 |
400 | リクエストパラメータに誤りがあります。
|
401 | 認証情報の指定に誤りがあります。 |
403 | 対象のプロジェクトへの権限がありません。 |
404 | 対象のジョブネットは存在しません。
|
409 | 対象のジョブネットへの指定の操作はできません。
|
500 | リクエストの処理中にサーバで異常が発生しました。 |
指定したjobnetsリソースのオブジェクトを返却します。
注意
Web APIによるジョブネットへの操作は、Systemwalker Operation Managerサーバの処理と同期を取っていません。そのため、Web APIのレスポンスはサーバでの処理の完了を保証するものではありません。レスポンスボディで返却するオブジェクトは、操作が反映されていない場合があります。
複写元ジョブネットの起動操作をした場合、複写元ジョブネットの情報を返却します。複写先ジョブネットの情報は、ジョブネット情報の一覧取得から取得してください。
使用例
サブシステム番号0、プロジェクト名“SampleProject”、ジョブネット名“SampleJobnet”のジョブネットを可変パラメタ“SampleParam”で起動する場合のAPIの使用例を次に示します。
POST /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject/jobnets/SampleJobnet HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
Content-Type: application/json
{
"control": "start",
"vparam": "SampleParam"
}“18.3.2.1 ジョブネット情報の取得”のレスポンス例を参照してください。
機能説明
jobnetsリソースの一覧を取得します。
対象は、認証情報に指定したユーザが参照権以上を持つプロジェクトに存在するジョブネットとなります。
リクエスト
レスポンス
以下のHTTPステータスコードを返却します。
コード | 説明 |
|---|---|
200 | リクエストの処理が正常終了しました。 |
400 | リクエストパラメータに誤りがあります。
|
401 | 認証情報の指定に誤りがあります。 |
500 | リクエストの処理中にサーバで異常が発生しました。 |
jobnetsリソースのオブジェクトを返却します。
使用例
サブシステム0に存在するジョブネットの一覧を取得する場合の、APIの使用例を次に示します。
GET /Systemwalker-omgr/api/v1/jobnets?subsystem=0 HTTP/1.1 Host: Systemwalker Operation Managerサーバのホスト名:9900 Authorization: Basic ********************
dataフィールドのオブジェクト配列として、jobnetsリソースのオブジェクトを返却します。jobnetsリソースのオブジェクトについては、“18.3.2.1 ジョブネット情報の取得”のレスポンス例を参照してください。