7.3.1　ユニット定義情報オブジェクト

ユニット定義情報を示すオブジェクトです。

ユニット定義情報オブジェクトのAPIでの取得可否については，「付録D.2 APIで取得できるユニット定義情報オブジェクトのメンバーの一覧」を参照してください。

形式

{
  "unitName":"ユニット完全名",
  "unitComment":"ユニットのコメント",
  "unitType":"ユニット種別",
  "owner":"所有者",
  "execAgent":"実行エージェント名",
  "execFileName":"実行ファイル名またはスクリプトファイル名",
  "parameters":"パラメーター",
  "customJobType":"カスタムジョブの種別",
  "customEventJobType":"カスタムイベントジョブの種別",
  "registerStatus":"ユニットの登録状態",
  "recoveryUnit":リカバリーユニットかどうか,
  "unitID":ユニットID,
  "wait":待ち合わせ条件付きユニットかどうか,
  "jobnetReleaseUnit":ユニットがリリース登録されているかどうか,
  "jp1ResourceGroup":"JP1資源グループ名",
  "simpleUnitName":"ユニット名",
  "rootJobnetName":"ルートジョブネットのユニット完全名"
}

メンバー

返却されるメンバーを次の表に示します。

表7‒41　ユニット定義情報オブジェクトのメンバー一覧
メンバー	データ型	説明
`unitName`	string	ユニット完全名を1〜930バイトの文字列で返却します。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`unitComment`	string	ユニットのコメントを0〜80バイトの文字列で返却します。情報を取得できない場合，またはユニットにコメントが定義されていない場合は，長さ0バイトの文字列を返却します。
`unitType`	string	ユニットの種別を，定数`Type`に規定されている文字列定数で返却します。定数`Type`の詳細については，「7.4.4(1) Type」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`owner`	string	ユニットに定義されている所有者名を0〜31バイトの文字列で返却します。情報を取得できない場合，またはユニットに所有者が定義されていない場合は，長さ0バイトの文字列を返却します。
`execAgent`	string	ユニットに定義されている実行エージェント（実行エージェント名または実行エージェントグループ名）を0〜255バイトの文字列で返却します。情報を取得できない場合，またはユニットに実行エージェントが定義されていない場合は，長さ0バイトの文字列を返却します。
`execFileName`	string	ユニットに定義されている実行ファイル名またはスクリプトファイル名を0〜511バイトの文字列で返却します。次の場合は，長さ0の文字列を返却します。情報を取得できない場合実行ファイル名，スクリプトファイル名が定義されていない場合ユニットがUNIXジョブ，PCジョブ，フレキシブルジョブ，およびQUEUEジョブ以外の場合
`parameters`	string	PCジョブ，UNIXジョブ，フレキシブルジョブ，またはQUEUEジョブに定義されているパラメーターを0〜1,023バイトの文字列で返却します。次の場合は，長さ0の文字列を返却します。情報を取得できない場合パラメーターが定義されていない場合ユニットがUNIXジョブ，PCジョブ，フレキシブルジョブ，およびQUEUEジョブ以外の場合
`customJobType`	string	メンバー`unitType`の値が「`CUSTOM`（カスタムジョブ）」の場合，カスタムジョブの種別を文字列で返却します。カスタムジョブ種別の一覧については，表7-42を参照してください。情報を取得できない場合，またはメンバー`unitType`の値が「`CUSTOM`」でない場合は，長さ0バイトの文字列を返却します。
`customEventJobType`	string	メンバー`unitType`の値が「`EVCUSTOM`（カスタムイベントジョブ）」の場合，カスタムイベントジョブの種別を文字列で返却します。カスタムイベントジョブ種別の一覧については，表7-43を参照してください。情報を取得できない場合，またはメンバー`unitType`の値が「`EVCUSTOM`」でない場合は，長さ0バイトの文字列を返却します。
`registerStatus`	string	ユニットの実行登録状態を，定数`RegisterStatus`に規定されている文字列定数で返却します。定数`RegisterStatus`の詳細については，「7.4.4(2) RegisterStatus」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`recoveryUnit`	boolean	ユニットにリカバリー属性が設定されているかどうかを返却します。ユニットにリカバリー属性が設定されている場合，「`true`」を返却します。情報を取得できない場合，またはユニットにリカバリー属性が設定されていない場合は，「`false`」を返却します。
`unitID`	int	ユニットIDを数値で返却します。情報を取得できない場合は，「`-1`」を返却します。
`wait`	boolean	待ち合わせ条件付きユニットかどうかを返却します。待ち合わせ条件付きユニットの場合は，「`true`」を返却します。情報を取得できない場合，または待ち合わせ条件付きユニットではない場合は，「`false`」を返却します。
`jobnetReleaseUnit`	boolean	ユニットがリリース登録されているかどうかを返却します。リリース登録されている場合は，「`true`」を返却します。情報を取得できない場合，またはリリース登録されていない場合は，「`false`」を返却します。
`jp1ResourceGroup`	string	ユニットに定義されているJP1資源グループ名を0〜63バイトの文字列で返却します。情報を取得できない場合，またはユニットにJP1資源グループが定義されていない場合は，長さ0バイトの文字列を返却します。
`simpleUnitName`	string	ユニット名を1〜30バイトの文字列で返却します。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`rootJobnetName`	string	ルートジョブネットのユニット完全名を1〜930バイトの文字列で返却します。情報を取得できない場合は，長さ0バイトの文字列を返却します。

表7‒42　カスタムジョブの種別の一覧
カテゴリ		説明
標準カスタムジョブ		CUSTOM_PC_ADSHPC
		CUSTOM_PC_ADSHAPPEXEC
		CUSTOM_PC_ADSHUX
		CUSTOM_PC_COSMNGAP
		CUSTOM_PC_COSMNGSV
		CUSTOM_PC_CPALINK
		CUSTOM_PC_DHAJEL
		CUSTOM_PC_DHAJEW
		CUSTOM_PC_JP1AMOAP
		CUSTOM_PC_JP1AMR3
		CUSTOM_PC_JP1AMR3BW
		CUSTOM_PC_JP1AMR3CP
		CUSTOM_PC_JP1AMR3UX
		CUSTOM_PC_JP1AMR3BWUX
		CUSTOM_PC_JP1AMR3CPUX
		CUSTOM_PC_JP1FTP
		CUSTOM_PC_JP1SOVAR
		CUSTOM_PC_OAP_JOB
		CUSTOM_PC_R3_JOB
		CUSTOM_UX_JP1AMOAP
		CUSTOM_UX_JP1AMR3
		CUSTOM_UX_JP1AMR3BW
		CUSTOM_UX_JP1AMR3CP
		CUSTOM_UX_JP1FTP
ユーザーカスタムジョブ	カスタムPCジョブ	CUSTOM_PC_USER_クラス名
ユーザーカスタムジョブ	カスタムUNIXジョブ	CUSTOM_UX_USER_クラス名

注: クラス名はJP1/AJS3が連携するプログラムごとに異なります。詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド　12.13.2 ［カスタムジョブ登録情報］ダイアログボックス」を参照してください。

表7‒43　カスタムイベントジョブの種別の一覧
カテゴリ	説明
カスタムイベントジョブ	CE_任意の名称^※

注※: 連携プログラムが定義する名称です。詳細は各連携プログラムのマニュアルを参照してください。

ページの先頭へ

7.3.1 ユニット定義情報オブジェクト

7.3.1　ユニット定義情報オブジェクト