7.2.2 Wait resource

The following shows the details of the wait resource.

Format

{
  "unitName":"full-name-of-unit-with-wait-conditions",
  "unitComment":"comment-on-unit-with-wait-conditions",
  "status":"status-of-unit-with-wait-conditions",
  "execId":"execution-ID-of-unit-with-wait-conditions",
  "startDelayStatus":"whether-to-delay-start-of-unit-with-wait-conditions",
  "nestStartDelayStatus":"whether-to-delay-start-of-units-subordinate-to-unit-with-wait-conditions",
  "endDelayStatus":"whether-to-delay-end-of-unit-with-wait-conditions",
  "nestEndDelayStatus":"whether-to-delay-end-of-units-subordinate-to-unit-with-wait-conditions",
  "waitMethod":"waiting-method",
  "noGenerationAction":"[No_generations_to_wait_for]-setting",
  "unmonitoredEndedAction":"[When_Unmonitored_+_Ended]-setting",
  "abnomalEndedAction":"[Abnormal_end_for_an_execution_generation]-setting",
  "waitingTargetUnits":[
    {
      "unitName":"full-name-of-unit-being-waited-for",
      "unitComment":"comment-on-waiting-target-unit",
      "status":"status-of-waiting-target-unit",
      "execId":"execution-ID-of-waiting-target-unit",
      "startDelayStatus":"whether-to-delay-start-of-waiting-target-unit",
      "nestStartDelayStatus":"whether-to-delay-start-of-units-subordinate-to-waiting-target-unit",
      "endDelayStatus":"whether-to-delay-end-of-waiting-target-unit",
      "nestEndDelayStatus":"whether-to-delay-end-of-units-subordinate-to-waiting-target-unit",
      "waitStatus":"wait-status-of-waiting-target-unit",
    }, ...
  ]
}

Member

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

Table 7‒40: List of members of the wait resource
Member	Data type	Description
`unitName`	string	Returns the full name of a unit with wait conditions 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.
`unitComment`	string	Returns the comment on a unit with wait conditions by using a character string of no more than 80 bytes. If no information can be acquired or no comment is defined for the unit, a character string of 0 bytes is returned.
`status`	string	Returns the status of a unit with wait conditions by using a character string constant that is supported by the `Status` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `Status` constant, see 7.4.1(2) Status.
`execId`	string	Returns the execution ID of a unit with wait conditions by using a character string 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.
`startDelayStatus`	string	Returns whether to delay the start of a unit with wait conditions, by using a character string constant that is supported by the `DelayStart` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `DelayStart` constant, see 7.4.1(3) DelayStart.
`nestStartDelayStatus`	string	Returns whether to delay the start of the units subordinate to a unit with wait conditions, by using a character string constant that is supported by the `DelayStart` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `DelayStart` constant, see 7.4.1(3) DelayStart.
`endDelayStatus`	string	Returns whether to delay the end of a unit with wait conditions, by using a character string constant that is supported by the `DelayEnd` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `DelayEnd` constant, see 7.4.1(4) DelayEnd.
`nestEndDelayStatus`	string	Returns whether to delay the end of the units subordinate to a unit with wait conditions, by using a character string constant that is supported by the `DelayEnd` constant. If information cannot be acquired, `NONE` (not applicable) is returned. For details about the `DelayEnd` constant, see 7.4.1(4) DelayEnd.
`waitMethod`	string	Returns the wait method for the wait conditions set for a unit with wait conditions, by using a character string constant that is supported by the `WaitMethod` constant. For details about the `WaitMethod` constant, see 7.4.13(1) WaitMethod.
`noGenerationAction`	string	Returns the action selected for the No generations to wait for setting in the wait conditions set for a unit with wait conditions, by using a character string that is supported by the `WaitingAction` constant. For details about the `WaitingAction` constant, see 7.4.13(2) WaitingAction.
`unmonitoredEndedAction`	string	Returns the action selected for the When Unmonitored + Ended setting in the wait conditions set for a unit with wait conditions, by using a character string that is supported by the `WaitingAction` constant. For details about the `WaitingAction` constant, see 7.4.13(2) WaitingAction.
`abnomalEndedAction`	string	Returns the action selected for the Abnormal end for an execution generation setting in the wait conditions set for a unit with wait conditions, by using a character string that is supported by the `WaitingAction` constant. For details about the `WaitingAction` constant, see 7.4.13(2) WaitingAction.
`waitingTargetUnits`	object[]	Returns an object array of the waiting-target units that are set in the wait conditions set for a unit with wait conditions.
`unitName`	string	Returns the full name of a waiting-target unit set in the wait conditions of a unit with wait conditions, 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.
`unitComment`	string	Returns the comment on a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string of no more than 80 bytes. If no information can be acquired or no comment is defined for the unit, a character string of 0 bytes is returned.
`status`	string	Returns the status of a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string constant that is supported by the `Status` constant. For the following cases, `NONE` (not applicable) is returned: If information cannot be acquired If the unit whose end is being waited for is a planning group For details about the `Status` constant, see 7.4.1(2) Status.
`execId`	string	Returns the execution ID of a waiting-target unit set in the wait conditions of a unit with wait conditions, 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 information cannot be acquired If the unit whose end is being waited for is a planning group
`startDelayStatus`	string	Returns whether to delay the start of a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string constant that is supported by the `DelayStart` constant. For the following cases, `NONE` (not applicable) is returned: If information cannot be acquired If the unit whose end is being waited for is a planning group For details about the `DelayStart` constant, see 7.4.1(3) DelayStart.
`nestStartDelayStatus`	string	Returns whether to delay the start of the units subordinate to a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string constant that is supported by the `DelayStart` constant. For the following cases, `NONE` (not applicable) is returned: If information cannot be acquired If the unit whose end is being waited for is a planning group For details about the `DelayStart` constant, see 7.4.1(3) DelayStart.
`endDelayStatus`	string	Returns whether to delay the end of a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string constant that is supported by the `DelayEnd` constant. For the following cases, `NONE` (not applicable) is returned: If information cannot be acquired If the unit whose end is being waited for is a planning group For details about the `DelayEnd` constant, see 7.4.1(4) DelayEnd.
`nestEndDelayStatus`	string	Returns whether to delay the end of the units subordinate to a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string constant that is supported by the `DelayEnd` constant. For the following cases, `NONE` (not applicable) is returned: If information cannot be acquired If the unit whose end is being waited for is a planning group For details about the `DelayEnd` constant, see 7.4.1(4) DelayEnd.
`waitingStatus`	string	Returns the status of waiting with a waiting-target unit set in the wait conditions of a unit with wait conditions, by using a character string constant that is supported by the `WaitingStatus` constant. For details about the `WaitingStatus` constant, see 7.4.13(2) WaitingAction.

To Page Top