7.3.2 Status information object

This object indicates the status information of the unit.

For details about whether the API can acquire the status information object, see D.3 List of members of the status information object that can be acquired by the API.

Format

{
  "unitName":"unit-full-path-name",
  "execID":"execution-ID",
  "status":"status",
  "schStartTime":"scheduled-start-time",
  "startTime":"start-time",
  "reStartTime":"rerun-start-time",
  "endTime":"end-time",
  "startDelayStatus":"whether-the-start-delayed",
  "nestStartDelayStatus":"whether-the-start-delayed-under-the-unit",
  "endDelayStatus":"whether-the-end-delayed",
  "nestEndDelayStatus":"whether-the-end-delayed-under-the-unit",
  "startDelayTime":"time-when-start-delayed",
  "endDelayTime":"time-when-end-delayed",
  "changeType":"whether-the-plan-has-changed",
  "holdAttr":"hold-attribute",
  "registerTime":"time-when-job-registered",
  "jobNumber":job-number,
  "retCode":"return-code",
  "execHost":"execution-host-name",
  "simpleUnitName":"unit-name",
  "waiting":"whether-there-are-wait-conditions-that-have-not-been-met",
  "delayedStart":"start-delay-monitoring-method",
  "delayedStartTime":"time-to-start-monitoring-of-start-delay",
  "delayedEnd":"end-delay-monitoring-method",
  "delayedEndTime":"time-to-start-monitoring-of-end-delay",
  "monitoringJobnet":"end-delay-monitoring-method-using-the-time-required-to-execute-jobnet",
  "timeRequiredForExecution":"time-required-to-execute-jobnet"
  "destHostName":"connection-destination-host-name",
  "destServiceName":"connection-destination-scheduler-service-name",
  "destUnitName":"connection-destination-unit-name",
  "destExecID":"connection-destination-execution-ID",
  "srcHostName":"connection-source-host-name",
  "srcServiceName":"connection-source-scheduler-service-name",
  "srcUnitName":"connection-source-unit-name",
  "srcExecID":"connection-source-execution-ID",
  "execOrderMethod":"execution-order-control-method"
}

Member

The following table lists and describes the members to be returned.

Table 7‒44: List of members of the status information object
Member	Data type	Description
`unitName`	string	Returns the full name of the unit, by using a character string in the range from 1 to 930 bytes. If information cannot be acquired, a character string of 0 bytes is returned.
`execID`	string	Returns the execution ID in the format of `@`[`mmmm`]{`A` to `Z`}`nnnn` (for example, `@10A200`). If information cannot be acquired, a character string of 0 bytes is returned.
`status`	string	Returns the unit status, by using a character string constant specified for the `Status` constant. For details about the `Status` constant, see 7.4.1(2) Status. If information cannot be acquired, `NONE` (not applicable) is returned.
`schStartTime`	string	Returns the scheduled start time. For the scheduled start time, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`startTime`	string	Returns the start date. For the start date, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`reStartTime`	string	Returns the return start time. For the return start time, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`endTime`	string	Returns the end time. For the end time, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`startDelayStatus`	string	Returns whether the start delay occurred for this unit, by using a character string constant specified for the `DelayStart` constant. For details about the `DelayStart` constant, see 7.4.1(3) DelayStart. If information cannot be acquired, `NONE` (not applicable) is returned.
`nestStartDelayStatus`	string	Returns whether the start delay occurred under this unit, by using a character string constant specified for the `DelayStart` constant. For details about the `DelayStart` constant, see 7.4.1(3) DelayStart. If information cannot be acquired, `NONE` (not applicable) is returned.
`endDelayStatus`	string	Returns whether the end delay occurred for this unit, by using a character string constant specified for the `Delayend` constant. For details about the `DelayEnd` constant, see 7.4.1(4) DelayEnd. If information cannot be acquired, `NONE` (not applicable) is returned.
`nestEndDelayStatus`	string	Returns whether the end delay occurred under this unit, by using a character string constant specified for the `Delayend` constant. For details about the `DelayEnd` constant, see 7.4.1(4) DelayEnd. If information cannot be acquired, `NONE` (not applicable) is returned.
`startDelayTime`	string	Returns the time when start delayed. For the time when start delayed, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`endDelayTime`	string	Returns the time when end delayed. For the time when end delayed, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`changeType`	string	Returns whether the plan has been changed, by using a character string constant specified for the `ChangeType` constant. For details about the `ChangeType` constant, see 7.4.5(1) ChangeType. If information cannot be acquired, `NONE` (not applicable) is returned.
`holdAttr`	string	Returns the hold attribute, by using a character string constant specified for the `HoldAttr` constant. For details about the `HoldAttr` constant, see 7.4.5(2) HoldAttr. If information cannot be acquired, `NONE` (not applicable) is returned.
`registerTime`	string	Returns the time when the job registered. For the time when the job registered, the time (unit: second) passed from Jan 1, 1970, 00:00:00 is converted to the following ISO 8601 format: `YYYY-MM-DDThh:mm:ssTZD` For details about the ISO 8601 format, see 6.3 Data types usable for an API. If information cannot be acquired, a character string of 0 bytes is returned.
`jobNumber`	int	Returns the job number. If information cannot be acquired, or if the unit has no information, -1 is returned.
`retCode`	string	Returns the end code, by using a character string. If information cannot be acquired, or if the unit has no information, a character string of 0 bytes is returned.
`execHost`	string	Returns the execution host name, by using a character string in the range from 0 to 255 bytes. If information cannot be acquired, or if the unit has not started, a character string of 0 bytes is returned.
`simpleUnitName`	string	Returns the unit name, by using a character string in the range from 1 to 30 bytes. If information cannot be acquired, a character string of 0 bytes is returned.
`waiting`	string	Returns whether there are wait conditions that are have not been met, by using a character string constant that is supported by the `Waiting` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `Waiting` constant, see 7.4.5(4) Waiting.
`delayedStart`	string	Returns the method of monitoring start delays by using a character string defined in the `DelayMonitor` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `DelayMonitor` constant, see 7.4.5(5) DelayMonitor.
`delayedStartTime`	string	Returns the time to start monitoring start delays. The time is returned as follows, with the `DelayMonitor` constant acquired by the `delayedStart` member: If the `DelayMonitor` constant is `ABSOLUTE` This member returns the time to start monitoring of start delays in `hh:mm` format. `hh`: A value from 00 to 47 (hours) `mm`: A value from 00 to 59 (minutes) If the `DelayMonitor` constant is `ROOT`, `TOP`, or `OWN` This member returns the relative time (in minutes) to start monitoring of start delays in the range from `1` to `2879`. If the DelayMonitor constant is other than `ABSOLUTE`, `ROOT`, `TOP`, and `OWN`, a character string of 0 bytes is returned.
`delayedEnd`	string	Returns the method of monitoring end delays by using a character string defined in the `DelayMonitor` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `DelayMonitor` constant, see 7.4.5(5) DelayMonitor.
`delayedEndTime`	string	Returns the time to start monitoring of end delays. The time is returned as follows, with the `DelayMonitor` constant acquired by the `delayedEnd` member: If the `DelayMonitor` constant is `ABSOLUTE` This member returns the time to start monitoring of end delays in `hh:mm` format. `hh`: A value from 00 to 47 (hours) `mm`: A value from 00 to 59 (minutes) If the `DelayMonitor` constant is `ROOT`, `TOP`, or `OWN` This member returns the relative time (in minutes) to start monitoring of end delays in the range from `1` to `2879`. If the `DelayMonitor` constant is other than `ABSOLUTE`, `ROOT`, `TOP`, and `OWN`, a character string of 0 bytes is returned.
`monitoringJobnet`	string	Returns the method of monitoring end delays based on the time required for jobnet execution by using a character string defined in the `MonitoringJobnet` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `MonitoringJobnet` constant, see 7.4.5(6) MonitoringJobnet.
`timeRequiredForExecution`	string	Returns the time required for jobnet execution. The time is returned as follows, with the `MonitoringJobnet` constant acquired by the `monitoringJobnet` member: If the `MonitoringJobnet` constant is `TIME_REQUIRED_FOR_EXECUTION_YES`, this member returns the time required for jobnet execution (in minutes) in the range from `1` to `2879`. If the `MonitoringJobnet` constant is other than `TIME_REQUIRED_FOR_EXECUTION_YES`, a character string of 0 bytes is returned. When information cannot be acquired, a character string of 0 bytes is returned.
`destHostName`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the name of the connection-destination host by using a character string consisting of 1 to 255 bytes. For the following cases, a character string of 0 bytes is returned: If the type of the specified unit is not a jobnet connector If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter
`destServiceName`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the name of the connection-destination scheduler service by using a character string in the range from 1 to 30 bytes. For the following cases, a character string of 0 bytes is returned: If the type of the specified unit is not a jobnet connector If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter
`destUnitName`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the full name of the connection-destination unit by using a character string in the range from 0 to 930 bytes. For the following cases, a character string of 0 bytes is returned: If the type of the specified unit is not a jobnet connector If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter
`destExecID`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the execution ID of the connection destination by using a character string in the format of `@`[`mmmm`]{`A` to `Z`}`nnnn` (for example, `@10A200`). For the following cases, a character string of 0 bytes is returned: If the execution-ID of the Destination does not exist If the type of the specified unit is not a jobnet connector If the connection partner unit is in the following status: - The connection partner unit does not exist. - The type of the connection partner unit is incorrect. - The name of the unit to connect is blank. If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter If an error occurs during authentication of another scheduler service and the execution-ID cannot be obtained, the character string `-2` is returned. If an error occurs in processing to obtain connection information because of a reason other than those for `-2`, the character string `-1` is returned.
`srcHostName`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the name of the connection-source host by using a character string consisting of 1 to 255 bytes. For the following cases, a character string of 0 bytes is returned: If the type of the specified unit is not a root jobnet If the setting is specified so that the execution order is not controlled If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` paramete
`srcServiceName`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the name of the connection-source scheduler service by using a character string in the range from 1 to 30 bytes. For the following cases, a character string of 0 bytes is returned: If the type of the specified unit is not a root jobnet If the setting is specified so that the execution order is not controlled If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter
`srcUnitName`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the full name of the connection-source unit by using a character string in the range from 0 to 930 bytes. For the following cases, a character string of 0 bytes is returned: If the type of the specified unit is not a root jobnet If the setting is specified so that the execution order is not controlled If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter
`srcExecID`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the execution ID of the connection source by using a character string in the format of `@`[`mmmm`]{`A` to `Z`}`nnnn` (for example, `@10A200`). For the following cases, a character string of 0 bytes is returned: If the execution-ID of the Destination does not exist If the type of the specified unit is not a root jobnet If the connection partner unit is in the following status: - The connection partner unit does not exist. - The type of the connection partner unit is incorrect. - The name of the unit to connect is blank. If the setting is specified so that the execution order is not controlled If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter If an error occurs during authentication of another scheduler service and the execution-ID cannot be obtained, the character string `-2` is returned. If an error occurs in processing to obtain connection information because of a reason other than those for `-2`, the character string `-1` is returned.
`execOrderMethod`	string	If `YES` (obtain connection information) is specified for the `searchConnectInfo` parameter, returns the execution order control method by using a character string constant that is supported by the `ExecOrderMethod` constant. For the following cases, `NONE` (not applicable) is returned: If the type of the specified unit is not a root jobnet If the setting is specified so that the execution order is not controlled If `NO` (do not obtain connection information) is specified for the `searchConnectInfo` parameter For details about the `ExecOrderMethod` constant, see 7.4.5(7) ExecOrderMethod.

To Page Top