付録D.3 APIで取得できるステータス情報オブジェクトのメンバーの一覧
APIで取得できるステータス情報オブジェクトのメンバーの一覧を次の表に示します。
|
項番 |
メンバー |
取得情報 |
ユニット一覧の取得API |
情報を取得できない場合のデフォルト値 |
|---|---|---|---|---|
|
1 |
unitName |
ユニット完全名 |
○ |
""（空文字） |
|
2 |
simpleUnitName |
ユニット名 |
○ |
""（空文字） |
|
3 |
execID |
実行ID |
○ |
""（空文字） |
|
4 |
status |
ユニットの状態 |
○ |
"NONE" |
|
5 |
execDateBaseTime |
ルートジョブネットの実行日の基準時刻 |
× |
""（空文字） |
|
6 |
schStartTime |
開始予定日時 |
○ |
""（空文字） |
|
7 |
startTime |
開始日時 |
○ |
""（空文字） |
|
8 |
reStartTime |
再実行開始日時 |
○ |
""（空文字） |
|
9 |
endTime |
終了日時 |
○ |
""（空文字） |
|
10 |
startDelayStatus |
開始遅延有無 |
○ |
"NONE" |
|
11 |
nestStartDelayStatus |
配下の開始遅延有無 |
○ |
"NONE" |
|
12 |
endDelayStatus |
終了遅延有無 |
○ |
"NONE" |
|
13 |
nestEndDelayStatus |
配下の終了遅延有無 |
○ |
"NONE" |
|
14 |
startDelayTime |
開始遅延日時 |
○ |
""（空文字） |
|
15 |
endDelayTime |
終了遅延日時 |
○ |
""（空文字） |
|
16 |
changeType |
計画一時変更の有無 |
○ |
"NONE" |
|
17 |
holdAttr |
保留属性 |
○ |
"NONE" |
|
18 |
registerTime |
ジョブ登録日時 |
○ |
""（空文字） |
|
19 |
jobNumber |
ジョブ番号 |
○ |
-1 |
|
20 |
retCode |
終了コード |
○ |
""（空文字） |
|
21 |
execHost |
実行ホスト名 |
○ |
""（空文字） |
|
22 |
holdPlan |
保留予定の有無 |
×※ |
"NONE" |
|
23 |
executionType |
登録種別 |
× |
"NONE" |
|
24 |
startConditionTimes |
起動条件の有効範囲の回数 |
× |
-1 |
|
25 |
startConditionPeriod |
起動条件の有効範囲の時間 |
× |
""（空文字） |
|
26 |
startConditionPeriodType |
起動条件の有効範囲の時間種別 |
× |
"NONE" |
|
27 |
statusInSummary |
ユニットの状態を示すサマリー |
× |
["NONE"] |
- （凡例）
-
○：取得できます。
×：取得できません。デフォルト値を返却します。
- 注※
-
保留予定の有無（holdPlan）は，保留属性（holdAttr）から算出してください。