Ticket Stop
- Last UpdatedNov 02, 2023
- 1 minute read
When the Ticket Stop action is used, the active batch becomes completed, and a new maintenance batch is started.
|
Action |
Type |
Optional |
Output |
Description |
|---|---|---|---|---|
|
batchTransferName |
String |
False |
False |
This input parameter specifies the name of the Batch Transfer record. |
|
Action |
String |
False |
False |
This input parameter specifies the action, it should be: “TICKET STOP”. |
|
arguments |
String |
False |
False |
This input parameter is ignored, it should be: “” |
|
Success |
Boolean |
False |
False |
This output parameter will indicate whether the action was successful, when successful “success == True”. |
|
returnMessage |
String |
False |
True |
When “success == False”, this output parameter will provide a insightful message for the unsuccessful action. |
|
User |
String |
False |
True |
This optional input parameter specifies the name of the user to use when generating events for this action. If not specified, then the default is: ”unknown_user”. |
|
Location |
String |
True |
False |
This optional input parameter specifies the name of the location to use when generating events for this action. If not specified, then the default is: “unknown_location”. |