...
Examples | XML | JSON | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Example |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Example |
|
|
...
Property | UI Field Name | Description | Specifications | Required | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
hold | Hold on Start | Indication of whether or not to launch the task in Held status. The task runs when the user releases it. | Boolean; Valid values: Yes, Y, true. | N | ||||||||
holdReason | Hold Reason | Information about why the task instances will be put on hold when the tasks start. | N | |||||||||
launchReason | Launch Reason | Reason for the task launch | N (Y if | |||||||||
name | Name | Name of the trigger to trigger the task. | Y | |||||||||
overrideDate | Date | Date of the override execution. | YYY-MM-DD | N (Y if overrrideTriggerDateTime is true.) | ||||||||
overrideTime | Time | Time of the override execution. | HH:MM | N (Y if overrrideTriggerDateTime is true.) | ||||||||
overrideTimeZone | Time Zone | Time zone of the override execution. | N (Y if overrrideTriggerDateTime is true.) | |||||||||
overrideTriggerDateTime | Override Trigger Date/Time | Specification for whether to enable or disable override functionality. | Boolean; Valid values: true/false. Default is false. | N | ||||||||
timeZone | Time Zone | Time zone in which task is triggered. | N | |||||||||
variables | n/a |
| N | |||||||||
virtualResourcePriority | Virtual Resource Priority | Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. | Integer; Valid values: 1-20 (1 is high priority, 20 is low priority). Default is 10. | N | ||||||||
virtual-resources | n/a |
| The virtual resource dependencies specified in
| N |
...