7.3.2　ステータス情報オブジェクト

ユニットのステータス情報を示すオブジェクトです。

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

形式

{
  "unitName":"ユニット完全名",
  "execID":"実行ID",
  "status":"状態",
  "schStartTime":"開始予定日時",
  "startTime":"開始日時",
  "reStartTime":"再実行開始日時",
  "endTime":"終了日時",
  "startDelayStatus":"開始遅延有無",
  "nestStartDelayStatus":"ユニット配下の開始遅延有無",
  "endDelayStatus":"終了遅延有無",
  "nestEndDelayStatus":"ユニット配下の終了遅延有無",
  "startDelayTime":"開始遅延日時",
  "endDelayTime":"終了遅延日時",
  "changeType":"計画一時変更の有無",
  "holdAttr":"保留属性",
  "registerTime":"ジョブ登録日時",
  "jobNumber":ジョブ番号,
  "retCode":"終了コード",
  "execHost":"実行ホスト名",
  "holdPlan":"保留予定の有無",
  "executionType":"登録種別",
  "startConditionTimes":起動条件の有効範囲の回数,
  "startConditionPeriodType":"起動条件の有効範囲の時間種別",
  "startConditionPeriod":"起動条件の有効範囲の時間",
  "statusInSummary":[ユニットの状態を示すサマリー,…],
  "execDateBaseTime":"ルートジョブネットの実行日の基準時刻",
  "simpleUnitName":"ユニット名"
}

メンバー

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

表7‒22　ステータス情報オブジェクトのメンバー一覧
メンバー	データ型	説明
`unitName`	string	ユニット完全名を1〜930バイトの文字列で返却します。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`execID`	string	実行IDを「`@[`mmmm`]{`A〜Z`}`nnnn」の形式で返却します（例：`@10A200`）。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`status`	string	ユニットの状態を，定数`Status`に規定されている文字列定数で返却します。定数`Status`の詳細については，「7.4.5(1) Status」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`schStartTime`	string	開始予定日時を返却します。開始予定日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`startTime`	string	開始日時を返却します。開始日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`reStartTime`	string	再実行開始日時を返却します。再実行開始日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`endTime`	string	終了日時を返却します。終了日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`startDelayStatus`	string	このユニットの開始遅延の有無を，定数`DelayStart`に規定されている文字列定数で返却します。定数`DelayStart`の詳細については，「7.4.5(2) DelayStart」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`nestStartDelayStatus`	string	このユニットの配下の開始遅延の有無を，定数`DelayStart`に規定されている文字列定数で返却します。定数`DelayStart`の詳細については，「7.4.5(2) DelayStart」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`endDelayStatus`	string	このユニットの終了遅延の有無を，定数`Delayend`に規定されている文字列定数で返却します。定数`DelayEnd`の詳細については，「7.4.5(3) DelayEnd」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`nestEndDelayStatus`	string	このユニットの配下の終了遅延の有無を，定数`Delayend`に規定されている文字列定数で返却します。定数`DelayEnd`の詳細については，「7.4.5(3) DelayEnd」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`startDelayTime`	string	開始遅延日時を返却します。開始遅延日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`endDelayTime`	string	終了遅延日時を返却します。終了遅延日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`changeType`	string	計画一時変更の有無を，定数`ChangeType`に規定されている文字列定数で返却します。定数`ChangeType`の詳細については，「7.4.5(4) ChangeType」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`holdAttr`	string	保留属性を，定数`HoldAttr`に規定されている文字列定数で返却します。定数`HoldAttr`の詳細については，「7.4.5(5) HoldAttr」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`registerTime`	string	ジョブ登録日時を返却します。ジョブ登録日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`jobNumber`	int	ジョブ番号を数値で返却します。情報を取得できない場合，または情報がないユニットの場合は，「`-1`」を返却します。
`retCode`	string	終了コードを文字列で返却します。情報を取得できない場合，または情報がないユニットの場合は，長さ0バイトの文字列を返却します。
`execHost`	string	実行ホスト名を0〜255バイトの文字列で返却します。情報を取得できない場合，またはユニットが開始していない場合は，長さ0バイトの文字列を返却します。
`holdPlan`	string	保留予定の有無を，定数`HoldPlan`に規定されている文字列定数で返却します。定数`HoldPlan`の詳細については，「7.4.5(6) HoldPlan」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`executionType`	string	登録種別を，定数`ExecutionType`に規定されている文字列定数で返却します。定数`ExecutionType`の詳細については，「7.4.5(7) ExecutionType」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`startConditionTimes`	int	起動条件を使用している場合に，起動条件の有効範囲の回数を数値で返却します。回数が無制限の場合は「`0`」を返却します。情報を取得できない場合は，「`-1`」を返却します。
`startConditionPeriod`	string	起動条件を使用している場合に，起動条件の有効範囲の時間を返却します。メンバー`startConditionPeriodType`で取得した定数`TimeType`によって，次に示すとおりに返却します。定数`TimeType`が「`ABSOLUTE`（絶対時間）」または「`RELATIVE`（相対時間）」の場合 1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。定数`TimeType`が「`ABSOLUTE`」，「`RELATIVE`」以外の場合，または情報を取得できない場合長さ0バイトの文字列を返却します。
`startConditionPeriodType`	string	起動条件を使用している場合に，起動条件の有効範囲の時間種別を，定数`TimeType`に規定されている文字列定数で返却します。定数`TimeType`の詳細については，「7.4.5(8) TimeType」を参照してください。情報を取得できない場合は，「`NONE`（該当せず）」を返却します。また，起動条件の有効範囲の時間種別を指定していない場合は「`NO`（指定なし）」を返却します。
`statusInSummary`	string	サマリー（ユニットの状態を示す7種の区分）を，定数`StatusInSummary`に規定されている文字列定数の配列で返却します。定数`StatusInSummary`の詳細については，「7.4.5(9) StatusInSummary」を参照してください。情報を取得できない場合は，「`NONE`（該当なし）」を返却します。
`execDateBaseTime`	string	ルートジョブネットの実行日の基準時刻を返却します。ルートジョブネットの実行日の基準時刻は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。情報を取得できない場合は，長さ0バイトの文字列を返却します。
`simpleUnitName`	string	ユニット名を0〜30バイトの文字列で返却します。情報を取得できない場合は，長さ0バイトの文字列を返却します。

ページの先頭へ

7.3.2 ステータス情報オブジェクト

7.3.2　ステータス情報オブジェクト