Control Message Interface

Get all control ids matched by the query

GET/api/v6.1.0.3/hubs/{hub}/channels/{channel}/controls

Query parameters	Prototype: `'task_name' ?: 'cap' \| 'integ' 'loc_name' ?: ( + ) 'ctrl_name' ?: 'ctrl_id' ?: ( + )`
Request headers	None
Request body	None
Response headers	Prototype: `X-Hvr-Hidden-Files :`
Response body (JSON)	Prototype: `ctrl_id*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: not found hub or channel
Required permissions	ReadOnly access level on hub

GET/api/v6.1.0.3/hubs/{hub}/channels/{channel}/controls/{ctrl_id}

Query parameters	None
Request headers	None
Request body	None
Response headers	Prototype: `X-Hvr-Hidden-Files :`
Response body (JSON)	Prototype: `'task_name' : 'cap' \| 'integ' 'loc_name' : 'ctrl_name' : 'filters' ?: ( { 'tables' ?: ( + ) 'where' ?: ( { 'col' : 'op' : '=' \| '!=' \| '<>' \| '>' \| '<' \| '>=' \| '<=' \| '>>' \| '<<' \| '%=' 'val_str' ?: ( + ) 'val_int' ?: ( + ) 'val_date' ?: ( + ) 'val_len' ?: ( + ) }* ) 'force_failed_rows' ?: 'resilient' ?: 'skip_rows' ?: 'set_missing_cols' ?: ( col* ) }* ) 'eval' ?: 'expiry_date' ?: 'recv_expiry' ?:`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: not found hub or channel or control
Required permissions	ReadOnly access level on hub

POST/api/v6.1.0.3/hubs/{hub}/channels/{channel}/controls_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'ctrl_ids' : ( + )`
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The control does not exist.
Required permissions	ReadExec access level on hub
Events	Creates the following event Control_Delete `'chn_name' : 'ctrl_ids' : ( + )`

POST/api/v6.1.0.3/hubs/{hub}/channels/{channel}/locs/{loc}/tasks/{task}/controls

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'ctrl_name' ?: 'filters' ?: ( { 'tables' ?: ( + ) 'where' ?: ( { 'col' : 'op' : '=' \| '!=' \| '<>' \| '>' \| '<' \| '>=' \| '<=' \| '>>' \| '<<' \| '%=' 'val_str' ?: ( + ) 'val_int' ?: ( + ) 'val_date' ?: ( + ) 'val_len' ?: ( + ) }* ) 'force_failed_rows' ?: 'resilient' ?: 'skip_rows' ?: 'set_missing_cols' ?: ( col+ ) }* ) 'set_env' ?: ( { 'name' : 'value' : }* ) 'journaling' ?: 'finish_after_cycle' ?: 'expiry_date' ?: 'recv_expiry' ?:`
Response headers	None
Response body (JSON)	Prototype: `'ctrl_id' :`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	ReadWrite access level on hub
Events	Creates the following event Control_Send `'chn_name' : 'task_name' : 'cap' \| 'integ' 'loc_name' : 'ctrl_name' : 'filters' ?: ( { 'tables' ?: ( + ) 'where' ?: ( { 'col' : 'op' : '=' \| '!=' \| '<>' \| '>' \| '<' \| '>=' \| '<=' \| '>>' \| '<<' \| '%=' 'val_str' ?: ( + ) 'val_int' ?: ( + ) 'val_date' ?: ( + ) 'val_len' ?: ( + ) }* ) 'force_failed_rows' ?: 'resilient' ?: 'skip_rows' ?: 'set_missing_cols' ?: ( col+ ) }* ) 'set_env' ?: ( { 'name' : 'value' : }* ) 'journaling' ?: 'finish_after_cycle' ?: 'expiry_date' ?: 'recv_expiry' ?: 'ctrl_id' :`