GET///
Retrieve a specific Commando Mode control set transition.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the Commando Mode control set transition. Allowable Values: Existing Commando Mode control set transition token |
Response body
| Fields | Description |
|---|---|
| commando_mode_token string Conditionally returned | Unique identifier of the Commando Mode control set. Allowable Values: Existing Commando Mode control set token |
| created_time datetime Returned | Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| name string Conditionally returned | Identifies the user who changed the Commando Mode control set’s state. Allowable Values: 255 char max |
| token string Conditionally returned | Unique identifier of the Command Mode control set transition object. Allowable Values: Existing Commando Mode control set transition object token |
| transition object Conditionally returned | Describes the Commando Mode control set’s current_state object.Allowable Values: Existing current_state object |
| transition.channel string Returned | Mechanism that changed the Commando Mode control set’s state. Allowable Values: API, SYSTEM |
| transition.commando_enabled boolean Returned | Indicates whether Commando Mode is enabled. - If commando_enabled is true and COMMANDO_MANUAL is configured, all transactions are processed via Commando Mode.- If commando_enabled is true and COMMANDO_AUTO is configured, Commando Mode is ready to intervene only when a transaction times out or encounters an error.Allowable Values: true, false |
| transition.reason string Conditionally returned | Describes the reason why the current state of the Commando Mode control set was last changed. Allowable Values: 255 char max |
| transition.username string Conditionally returned | Identifies the user who last changed the Commando Mode control set’s state. Allowable Values: 255 char max |
| type string Conditionally returned | Specifies the type of event that triggered the Commando Mode transition, such as a connection_error or response_timeout.Allowable Values: 255 char max |
Sample response body
JSON
{
"token": "commando_mode_1_transition",
"commando_mode_token": "commando_mode_1",
"transition": {
"commando_enabled": true,
"reason": "Lost connection",
"channel": "API",
"user_name": "rhowse"
},
"created_time": "2023-02-14T18:48:10Z"
}