6.1.0.36 Activate, Refresh, and Compare Interface Click here to see all end points in this interface. Check replication activation status of channels GET /api/v6.1.0.36/hubs/{hub}/activateQuery parameter prototype:
'channels' ?: ( chn<ident> + )
'locs' ?: ( loc <ident> + )
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
chn<str> *: {
loc <ident> +: {
'enroll' ?: {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: oldest<date_str_z>
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'jobs' : {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: oldest<date_str_z>
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
'running' ?: <bool>
'active_refresh_target' ?: <true>
}
'router_files' : {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: scan_start<date_str_z>
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'state_tables' ?: {
'lossy_reactivate' : <true>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'change_tables' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'triggers' ?: {
'lossy_reactivate' : <true>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'db_procs' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'supplemental_logging' ?: {
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'state_files' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
}
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Check replication activation status of channel GET /api/v6.1.0.36/hubs/{hub}/channels/{channel}/activateQuery parameter prototype:
'locs' ?: ( loc <ident> + )
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
loc <ident> *: {
'enroll' ?: {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: oldest<date_str_z>
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'jobs' : {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: oldest<date_str_z>
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
'running' ?: <bool>
'active_refresh_target' ?: <true>
}
'router_files' : {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: scan_start<date_str_z>
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'state_tables' ?: {
'lossy_reactivate' : <true>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'change_tables' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'triggers' ?: {
'lossy_reactivate' : <true>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'db_procs' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'supplemental_logging' ?: {
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'state_files' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Post an Hvr activate event POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/activateNo query parameters No extra request headers Request body is JSON. Prototype:
'locs' ?: ( <ident> + )
'tables' ?: ( <ident> + )
'parallel_locs' ?: <int>
'components' ?: (
'state_tables'
| 'change_tables'
| 'triggers'
| 'db_procs'
| 'router_files'
| 'enroll'
| 'supplemental_logging'
| 'jobs'
| 'state_files' +
)
'start_immediate' ?: <bool>
'replace_enroll' ?: <bool>
'rewind_scan_start' ?: {
'tstamp' : <date_str_z>
}
| {
'oldest_tx' : <true>
}
'rewind_emit' ?: {
'tstamp' : <date_str_z>
}
| {
'hvr_tx_seq' : <str>
}
| {
'scn' : <int64_ascii>
}
| {
'integrate_point' : {
integloc<ident> +: {
'integ_hvr_tx_seq' : <str>
'integ_hvr_tx_countdown' ?: <int>
'burst_busy_table' ?: <ident>
'burst_busy_table_busy' ?: <true>
'burst_busy_tx_seq' ?: <str>
}
}
}
'start_next_jobs' ?: ( task<ident> + )
'start_next_ev_ids' ?: ( ev_id<date_str_usecs_z> + )
No extra response headers Response body is JSON. Prototype:
'posted_ev_id' : <date_str_usecs_z>
'job' : <str>
'canceled_ev_ids' ?: ( <date_str_usecs_z> * )
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Activate
'locs' ?: ( <ident> + )
'tables' ?: ( <ident> + )
'parallel_locs' ?: <int>
'components' ?: (
'state_tables'
| 'change_tables'
| 'triggers'
| 'db_procs'
| 'router_files'
| 'enroll'
| 'supplemental_logging'
| 'jobs'
| 'state_files' +
)
'start_immediate' ?: <bool>
'replace_enroll' ?: <bool>
'rewind_scan_start' ?: {
'tstamp' : <date_str_z>
}
| {
'oldest_tx' : <true>
}
'rewind_emit' ?: {
'tstamp' : <date_str_z>
}
| {
'hvr_tx_seq' : <str>
}
| {
'scn' : <int64_ascii>
}
| {
'integrate_point' : {
integloc<ident> +: {
'integ_hvr_tx_seq' : <str>
'integ_hvr_tx_countdown' ?: <int>
'burst_busy_table' ?: <ident>
'burst_busy_table_busy' ?: <true>
'burst_busy_tx_seq' ?: <str>
}
}
}
'start_next_jobs' ?: ( task<ident> + )
'start_next_ev_ids' ?: ( ev_id<date_str_usecs_z> + )
Post Compare event and schedule a job for it POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/compareNo query parameters No extra request headers Request body is JSON. Prototype:
'source_loc' : <ident>
'target_loc' : <ident>
'contexts' ?: ( <ident> + )
'granularity' ?: 'bulk' | 'rowwise'
'difference_filter' ?: {
'inserts' ?: <bool>
'updates' ?: <bool>
'deletes' ?: <bool>
}
'quota_run' ?: njobs<int :min =0 >
'parallel_sessions' ?: <int :min =0 >
'db_sequences' ?: <bool>
'repeatable' ?: <bool>
'slicing' ?: {
table<str> *: {
'type' : 'boundary'
| 'count'
| 'modulo'
| 'series'
'col' ?: <str>
'slices' ?: <int>
'str_boundaries' ?: ( vals<str> + )
'int_boundaries' ?: ( vals<int64_ascii> + )
'date_boundaries' ?: ( vals<date_str_z> + )
'series_values' ?: ( <str> + )
'selection' ?: ( <int> + )
}
}
'tables' ?: ( <str> + )
'task' ?: <ident>
'context_variables' ?: {
name<str> *: value<str>
}
'file_preread_subtasks' ?: <int>
'schedule_times' ?: crono<str>
'start_at' ?: <date_str_z>
'start_immediate' ?: <bool>
'row_count_only' ?: <true>
'online_compare' ?: 'diff_diff' | 'diff_cap'
'online_compare_sleep' ?: <int>
'select_moment' ?: <str>
'save_diff_file' ?: <bool>
'prereader_intermediate_files' ?: {
'keep' ?: <bool>
'reuse' ?: <bool>
}
No extra response headers Response body is JSON. Prototype:
'posted_ev_id' : <date_str_usecs_z>
'job' : <str>
'canceled_ev_ids' ?: ( <date_str_usecs_z> * )
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad RequestSTATUS 403 Forbidden: User does not have Exec accessRequired Permissions ReadExec access level on hub Events Creates the following event:
Compare
'channel' : <ident>
'view_tstamp' ?: <date_str_usecs_z>
'source_loc' : <ident>
'target_loc' : <ident>
'contexts' ?: ( <ident> + )
'granularity' ?: 'bulk' | 'rowwise'
'difference_filter' ?: {
'inserts' ?: <bool>
'updates' ?: <bool>
'deletes' ?: <bool>
}
'quota_run' ?: njobs<int :min =0 >
'parallel_sessions' ?: <int :min =0 >
'db_sequences' ?: <bool>
'repeatable' ?: <bool>
'slicing' ?: {
table<str> *: {
'type' : 'boundary'
| 'count'
| 'modulo'
| 'series'
'col' ?: <str>
'slices' ?: <int>
'str_boundaries' ?: ( vals<str> + )
'int_boundaries' ?: ( vals<int64_ascii> + )
'date_boundaries' ?: ( vals<date_str_z> + )
'series_values' ?: ( <str> + )
'selection' ?: ( <int> + )
}
}
'tables' ?: ( <str> + )
'task' ?: <ident>
'context_variables' ?: {
name<str> *: value<str>
}
'file_preread_subtasks' ?: <int>
'row_count_only' ?: <true>
'online_compare' ?: 'diff_diff' | 'diff_cap'
'online_compare_sleep' ?: <int>
'select_moment' ?: <str>
'save_diff_file' ?: <bool>
'prereader_intermediate_files' ?: {
'keep' ?: <bool>
'reuse' ?: <bool>
}
Get event ids for tables results of recent Compare GET /api/v6.1.0.36/hubs/{hub}/channels/{channel}/compare/tables_results_idsQuery parameter prototype:
'result_pattern' ?: <str>
'source_loc' ?: <ident>
'target_loc' ?: <ident>
'table' ?: ( <ident>+ )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
ev_id<date_str_usecs_z> *: ( table <ident> + )
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Show contexts and context variables GET /api/v6.1.0.36/hubs/{hub}/channels/{channel}/contextsNo query parameters No extra request headers No request body No extra response headers Response body is JSON. Prototype:
'contexts ' : ( <ident >* )
'context_variables ' : ( varname <str>* )
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadOnly access level on hub Post an Hvr deactivate event POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/deactivateNo query parameters No extra request headers Request body is JSON. Prototype:
'locs' ?: ( <ident> + )
'tables' ?: ( <ident> + )
'parallel_locs' ?: <int>
'components' ?: (
'state_tables'
| 'change_tables'
| 'triggers'
| 'db_procs'
| 'router_files'
| 'enroll'
| 'supplemental_logging'
| 'jobs'
| 'state_files' +
)
'start_immediate' ?: <bool>
No extra response headers Response body is JSON. Prototype:
'posted_ev_id' : <date_str_usecs_z>
'job' : <str>
'canceled_ev_ids' ?: ( <date_str_usecs_z> * )
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Deactivate
'locs' ?: ( <ident> + )
'tables' ?: ( <ident> + )
'parallel_locs' ?: <int>
'components' ?: (
'state_tables'
| 'change_tables'
| 'triggers'
| 'db_procs'
| 'router_files'
| 'enroll'
| 'supplemental_logging'
| 'jobs'
| 'state_files' +
)
'start_immediate' ?: <bool>
Show open transactions GET /api/v6.1.0.36/hubs/{hub}/channels/{channel}/locs/{loc}/capture_open_txNo query parameters No extra request headers No request body No extra response headers Response body is JSON. Prototype:
'request_time' : <date_str_z>
'request_tx_seq' ?: <str>
'request_scn' ?: <int64_ascii>
'num_open_tx' : <int>
'oldest_open_tx_begin_tstamp' ?: <date_str_z>
'oldest_open_tx_begin_scn' ?: <int64_ascii>
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad Request: No capture tables defined or finding oldest transaction start time not possibleSTATUS 404 Not Found: Channel or channel member not foundRequired Permissions ReadOnly access level on hub Show integrate point GET /api/v6.1.0.36/hubs/{hub}/channels/{channel}/locs/{loc}/integrate_pointQuery parameter prototype:
'orig_channel' ?: <ident>
'orig_integ_loc' ?: <ident>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
caploc<ident> *: {
'scan_start_tstamp' : <date_str_z>
'integ_tstamp' : <date_str_z>
'integ_hvr_tx_seq' : <str>
'integ_hvr_tx_countdown' ?: <int64_ascii>
'burst_busy_table' ?: <ident>
'burst_busy_table_busy' ?: <true>
'burst_busy_tx_seq' ?: <str>
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or Location does not existRequired Permissions ReadOnly access level on hub Suggest slicing, based on old table results and Oracle DBMS stats POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/locs/{loc}/slicing_suggestNo query parameters No extra request headers Request body is JSON. Prototype:
'rows_per_slice' ?: <int64_ascii :min= 1 >
'max_slices_per_table' ?: <int :min= 0 >
'repeat_last_refresh_slicing' ?: <bool>
'repeat_last_compare_slicing' ?: <bool>
'suggest_from_last_refresh_rows' ?: <bool>
'suggest_from_last_compare_rows' ?: <bool>
'suggest_from_db_stats' ?: <bool>
'tables' ?: ( <str>+ )
No extra response headers Response body is JSON. Prototype:
table<str> *: {
'based_on' : 'no_data'
| 'repeat_last_refresh_slicing'
| 'repeat_last_compare_slicing'
| 'suggest_from_last_refresh_rows'
| 'suggest_from_last_compare_rows'
| 'suggest_from_db_stats'
'ev_id' ?: <date_str_usecs_z>
'row_estimate' ?: <int64_ascii>
'no_slicing' ?: <true>
'slicing' ?: {
'type' : 'boundary'
| 'count'
| 'modulo'
| 'series'
'col' ?: <str>
'slices' ?: <int>
'str_boundaries' ?: ( vals<str> + )
'int_boundaries' ?: ( vals<int64_ascii> + )
'date_boundaries' ?: ( vals<date_str_z> + )
'series_values' ?: ( <str> + )
}
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel, location or table does not existRequired Permissions ReadOnly access level on hub Events Creates no events.
Convert compressed diff file into smaller JSON files for viewing POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/locs/{loc}/tables/{table}/diffs/{ev_id}/getNo query parameters No extra request headers Request body is JSON. Prototype:
'bytes_per_file' ?: <int :min= 1 >
No extra response headers Response body is JSON. Prototype:
'transport_key' ?: <str>
'refs' : (
{
'slice' ?: <int>
'ref' : <str>
'row_num_begin' : <int64_ascii>
'row_num_end' : <int64_ascii>
}*
)
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadExecRefresh access level on hub Events Creates no events.
Suggest slicing boundaries based on Oracle DBMS stats. Can return empty POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/locs/{loc}/tables/{table}/slicing_boundariesNo query parameters No extra request headers Request body is JSON. Prototype:
'col' : <str >
'slices' : <int :min =1 >
No extra response headers Response body is JSON. Prototype:
'str_boundaries' ?: ( vals<str>+ )
'int_boundaries' ?: ( vals<int64_ascii>+ )
'date_boundaries' ?: ( vals<date_str_z>+ )
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel, location, table or column does not existRequired Permissions ReadOnly access level on hub Events Creates no events.
Post Refresh event and schedule a job for it POST /api/v6.1.0.36/hubs/{hub}/channels/{channel}/refreshNo query parameters No extra request headers Request body is JSON. Prototype:
'source_loc' : <ident>
'target_loc' : <ident>
'contexts' ?: ( <ident> + )
'granularity' ?: 'bulk' | 'rowwise'
'difference_filter' ?: {
'inserts' ?: <bool>
'updates' ?: <bool>
'deletes' ?: <bool>
}
'quota_run' ?: njobs<int :min =0 >
'parallel_sessions' ?: <int :min =0 >
'db_sequences' ?: <bool>
'repeatable' ?: <bool>
'slicing' ?: {
table<str> *: {
'type' : 'boundary'
| 'count'
| 'modulo'
| 'series'
'col' ?: <str>
'slices' ?: <int>
'str_boundaries' ?: ( vals<str> + )
'int_boundaries' ?: ( vals<int64_ascii> + )
'date_boundaries' ?: ( vals<date_str_z> + )
'series_values' ?: ( <str> + )
'selection' ?: ( <int> + )
}
}
'tables' ?: ( <str> + )
'task' ?: <ident>
'context_variables' ?: {
name<str> *: value<str>
}
'file_preread_subtasks' ?: <int>
'schedule_times' ?: crono<str>
'start_at' ?: <date_str_z>
'start_immediate' ?: <bool>
'create_tables' ?: {
'keep_structure' ?: <bool>
'force_recreate' ?: <bool>
'index' ?: <bool>
'keep_existing_data' ?: <bool>
'recreate_if_mismatch' ?: <bool>
}
'data_refresh' ?: <bool>
'fire_db_triggers' ?: <bool>
'foreign_keys' ?: 'ignore' | 'disable'
'select_moment' ?: <str>
'online_refresh' ?: 'read_write' | 'write_only' | 'no_skip'
'start_next_jobs' ?: ( 'cap' | 'integ' * )
'save_diff_file' ?: <bool>
No extra response headers Response body is JSON. Prototype:
'posted_ev_id' : <date_str_usecs_z>
'job' : <str>
'canceled_ev_ids' ?: ( <date_str_usecs_z> * )
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad RequestSTATUS 403 Forbidden: User does not have Write or Refresh accessRequired Permissions ReadExecRefresh access level on hub Events Creates the following event:
Refresh
'channel' : <ident>
'view_tstamp' ?: <date_str_usecs_z>
'source_loc' : <ident>
'target_loc' : <ident>
'contexts' ?: ( <ident> + )
'granularity' ?: 'bulk' | 'rowwise'
'difference_filter' ?: {
'inserts' ?: <bool>
'updates' ?: <bool>
'deletes' ?: <bool>
}
'quota_run' ?: njobs<int :min =0 >
'parallel_sessions' ?: <int :min =0 >
'db_sequences' ?: <bool>
'repeatable' ?: <bool>
'slicing' ?: {
table<str> *: {
'type' : 'boundary'
| 'count'
| 'modulo'
| 'series'
'col' ?: <str>
'slices' ?: <int>
'str_boundaries' ?: ( vals<str> + )
'int_boundaries' ?: ( vals<int64_ascii> + )
'date_boundaries' ?: ( vals<date_str_z> + )
'series_values' ?: ( <str> + )
'selection' ?: ( <int> + )
}
}
'tables' ?: ( <str> + )
'task' ?: <ident>
'context_variables' ?: {
name<str> *: value<str>
}
'file_preread_subtasks' ?: <int>
'create_tables' ?: {
'keep_structure' ?: <bool>
'force_recreate' ?: <bool>
'index' ?: <bool>
'keep_existing_data' ?: <bool>
'recreate_if_mismatch' ?: <bool>
}
'data_refresh' ?: <bool>
'fire_db_triggers' ?: <bool>
'foreign_keys' ?: 'ignore' | 'disable'
'select_moment' ?: <str>
'online_refresh' ?: 'read_write' | 'write_only' | 'no_skip'
'start_next_jobs' ?: ( 'cap' | 'integ' * )
'save_diff_file' ?: <bool>
Get event ids for tables results of recent Refresh GET /api/v6.1.0.36/hubs/{hub}/channels/{channel}/refresh/tables_results_idsQuery parameter prototype:
'result_pattern' ?: <str>
'source_loc' ?: <ident>
'target_loc' ?: <ident>
'table' ?: ( <ident>+ )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
ev_id<date_str_usecs_z> *: ( table <ident> + )
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Get event ids for tables results of recent Compare for all channels GET /api/v6.1.0.36/hubs/{hub}/compare/tables_results_idsQuery parameter prototype:
'channel' ?: ( <ident>+ )
'result_pattern' ?: <str>
'source_loc' ?: <ident>
'target_loc' ?: <ident>
'table' ?: ( <ident>+ )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
channel<ident> *: {
ev_id<date_str_usecs_z> *: ( table <ident> + )
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Check replication activation status of loc GET /api/v6.1.0.36/hubs/{hub}/locs/{loc}/activateNo query parameters No extra request headers No request body No extra response headers Response body is JSON. Prototype:
chn<str> *: {
'enroll' ?: {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: oldest<date_str_z>
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'jobs' : {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: oldest<date_str_z>
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
'running' ?: <bool>
'active_refresh_target' ?: <true>
}
'router_files' : {
'found' : <bool>
'missing' : <bool>
'tstamp' ?: scan_start<date_str_z>
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'state_tables' ?: {
'lossy_reactivate' : <true>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'change_tables' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'triggers' ?: {
'lossy_reactivate' : <true>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'db_procs' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'supplemental_logging' ?: {
'lossy_reactivate' : <false>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
'state_files' ?: {
'lossy_reactivate' : <bool>
'activating' ?: jobstate<ident>
'deactivating' ?: jobstate<ident>
}
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Get event ids for tables results of recent Refresh for all channels GET /api/v6.1.0.36/hubs/{hub}/refresh/tables_results_idsQuery parameter prototype:
'channel' ?: ( <ident>+ )
'result_pattern' ?: <str>
'source_loc' ?: <ident>
'target_loc' ?: <ident>
'table' ?: ( <ident>+ )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
channel<ident> *: {
ev_id<date_str_usecs_z> *: ( table <ident> + )
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Agent Configuration Interface Click here to see all end points in this interface. GET /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agentNo query parameters No extra request headers No request body No extra response headers Response body is JSON. Prototype:
'setup_token' ?: name<str>
'setup_timed' ?: active<bool>
'auth_anon' ?: <true >
'auth_user_password' ?: <true >
'auth_kerberos' ?: <true >
'hvr_version' : <str>
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: The requested hub or location does not existRequired Permissions ReadOnly access level on hub Delete agent properties of existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/props_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
'agent_props' : ( <str >+ )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Delete
'agent ' : host_port <str>
'props ' : ( [<str >]... )
Get agent properties of existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/props_getNo query parameters Request headers prototype:
X-Hvr-Classified-Access : <str >
Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
'fetch' ?: ( <str >+ )
Response headers prototype:
X-Hvr-Classified-Transport-Key : <str >
X-Hvr-Redacted-Storage : <str >
Response body is JSON. Prototype:
prop<str > *: value<typeof_agent_prop >
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates no events.
Modify agent properties of existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/props_modifyNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_prop_args' : (
{
'key' : ( prop<ident> <null> | <int> | <str> * )
'value' : <any>
}+
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Change
'agent' : host_port<str>
'props_after' : {
prop<str> *: value<null> | <typeof_agent_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_agent_prop>
}
Update agent properties of existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/props_patchNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_props' : {
prop<str> *: value<null> | <typeof_agent_prop>
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Change
'agent' : host_port<str>
'props_after' : {
prop<str> *: value<null> | <typeof_agent_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_agent_prop>
}
Set/reset agent properties of existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/props_putNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_props' : {
prop<str> *: value<typeof_agent_prop>
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Set
'agent' : host_port<str>
'props_after' : {
prop<str> *: value<typeof_agent_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_agent_prop>
}
Discover agent loc props of existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/testNo query parameters No extra request headers Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
No extra response headers Response body is JSON. Prototype:
'discovered_props' : {
prop<str> *: value<typeof_loc_prop>
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadOnly access level on hub Events Creates no events.
Create user on agent for existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/usersNo query parameters No extra request headers Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
'user' : <str >
'authentication' : 'kerberos'
| 'local'
| 'pam'
| 'plugin'
| 'windows'
'password' ?: <str >
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_User_Create
'agent ' : host_port <str>
'user ' : <str >
Delete user on agent for existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/users_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
'user' : <str >
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_User_Delete
'agent ' : host_port <str>
'user ' : <str >
Get list of users on existing agent POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/users_getNo query parameters No extra request headers Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
'user' ?: <str >
No extra response headers Response body is JSON. Prototype:
user<str > *: {
'authentication' : 'kerberos'
| 'local'
| 'pam'
| 'plugin'
| 'windows'
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates no events.
Change password of local user on agent for existing location POST /api/v6.1.0.36/hubs/{hub}/locs/{loc}/agent/users_passwordNo query parameters No extra request headers Request body is JSON. Prototype:
'setup_token' ?: value<str >
'setup_timed' ?: <true >
'auth_user_password' ?: ( user<str > password<str > )
'user' : <str >
'new_password' : <str >
'current_password' ?: <str >
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Agent_User_Password_Change
'agent ' : host_port <str>
'user ' : <str >
Delete agent properties of new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/props_deleteNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_props' : ( <str> + )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Delete
'agent ' : host_port <str>
'props ' : ( [<str >]... )
Get agent properties of new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/props_getNo query parameters Request headers prototype:
X-Hvr-Classified-Access : <str >
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'fetch' ?: ( <str> + )
Response headers prototype:
X-Hvr-Classified-Transport-Key : <str >
X-Hvr-Redacted-Storage : <str >
Response body is JSON. Prototype:
prop<str > *: value<typeof_agent_prop >
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates no events.
Modify agent properties of new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/props_modifyNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_prop_args' : (
{
'key' : ( prop<ident> <null> | <int> | <str> * )
'value' : <any>
}+
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Change
'agent' : host_port<str>
'props_after' : {
prop<str> *: value<null> | <typeof_agent_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_agent_prop>
}
Update agent properties of new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/props_patchNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_props' : {
prop<str> *: value<null> | <typeof_agent_prop>
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Change
'agent' : host_port<str>
'props_after' : {
prop<str> *: value<null> | <typeof_agent_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_agent_prop>
}
Set/reset agent properties of new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/props_putNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'agent_props' : {
prop<str> *: value<typeof_agent_prop>
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_Properties_Set
'agent' : host_port<str>
'props_after' : {
prop<str> *: value<typeof_agent_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_agent_prop>
}
Discover agent loc props of new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/testNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
No extra response headers Response body is JSON. Prototype:
'discovered_props' : {
prop<str> *: value<typeof_loc_prop>
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadOnly access level on hub Events Creates no events.
Create user on agent for new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/usersNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'user' : <str>
'authentication' : 'kerberos'
| 'local'
| 'pam'
| 'plugin'
| 'windows'
'password' ?: <str>
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_User_Create
'agent ' : host_port <str>
'user ' : <str >
Delete user on agent for new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/users_deleteNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'user' : <str>
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_User_Delete
'agent ' : host_port <str>
'user ' : <str >
Get list of users on new agent POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/users_getNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'user' ?: <str>
No extra response headers Response body is JSON. Prototype:
user<str > *: {
'authentication' : 'kerberos'
| 'local'
| 'pam'
| 'plugin'
| 'windows'
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates no events.
Change password of local user on agent for new location POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent/users_passwordNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
'setup_token' ?: value<str>
'setup_timed' ?: <true>
'auth_user_password' ?: ( user<str> password<str> )
'user' : <str>
'new_password' : <str>
'current_password' ?: <str>
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Error connecting to location specified by 'loc_props'Required Permissions ReadWrite access level on hub Events Creates the following event:
Agent_User_Password_Change
'agent ' : host_port <str>
'user ' : <str >
POST /api/v6.1.0.36/hubs/{hub}/new_loc/agent_getNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_props_from' ?: loc <ident>
'loc_props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
No extra response headers Response body is JSON. Prototype:
'setup_token' ?: name<str>
'setup_timed' ?: active<bool>
'auth_anon' ?: <true >
'auth_user_password' ?: <true >
'auth_kerberos' ?: <true >
'hvr_version' : <str>
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: The requested hub does not existRequired Permissions ReadOnly access level on hub Events Creates no events.
Alert Interface Click here to see all end points in this interface. GET /api/v6.1.0.36/hubs/{hub}/alertsNo query parameters No extra request headers No request body No extra response headers Response body is JSON. Prototype:
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub not foundRequired Permissions ReadOnly access level on hub Create alert configuration POST /api/v6.1.0.36/hubs/{hub}/alertsNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'alert' : <ident>
'props' : {
prop<str> *: value<typeof_alert_prop>
}
No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: Alert already existsSTATUS 404 Not Found: Hub not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Alert_Create
'alert' : <ident>
'props' : {
prop<str> *: value<typeof_alert_prop>
}
Delete alert configuration DELETE /api/v6.1.0.36/hubs/{hub}/alerts/{alert}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Clear alert state POST /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/clearNo query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Disable an alert configuration POST /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/disableNo query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Execute alert configuration now POST /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/executeNo query parameters No extra request headers No request body No extra response headers Response body is plain text
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub not foundRequired Permissions ReadExec access level on hub Events Creates the following event:
Alert_Notification
'alert' : <ident>
'latency_sla' ?: {
'over' : {
job<str> *: {
'latency' : <secs_int>
'sla' : <secs_int>
}
}
'under' : <int>
}
'error_summary' | 'warning_summary' ?: {
err_id<ident> *: {
'count' : <int>
'first' : <date_str_z>
'last' ?: <date_str_z>
}
}
'scheduler_alive' : <bool>
'alert_errors' ?: ( <str> + )
Get alert configuration properties GET /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/propsQuery parameter prototype:
'fetch' ?: ( prop<str >+ )
Request headers prototype:
X-Hvr-Classified-Access : <str >
No request body Response headers prototype:
X-Hvr-Classified-Transport-Key : <str >
X-Hvr-Redacted-Storage : <str >
Response body is JSON. Prototype:
prop<str > *: value<typeof_alert_prop >
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad Request: Specified property does not existSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadOnly access level on hub Set/reset alert configuration properties PATCH /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/propsNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
prop<str > *: value<null > | <typeof_alert_prop >
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Alert_Property_Change
'alert' : <ident>
'props_after' : {
prop<str> *: value<null> | <typeof_alert_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_alert_prop>
}
Replace all alert configuration properties PUT /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/propsNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
prop<str > *: value<null > | <typeof_alert_prop >
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Alert_Property_Set
'alert' : <ident>
'props_after' : {
prop<str> *: value<typeof_alert_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_alert_prop>
}
Delete alert configuration properties POST /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/props_deleteNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Alert_Property_Delete
'alert ' : <ident >
'props ' : ( prop <str>+ )
Modify alert configuration properties POST /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/props_modifyNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'alert_prop_args' : (
{
'key' : ( prop<ident> <null> | <int> | <str> * )
'value' : <any>
}+
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub or Alert not foundRequired Permissions ReadWrite access level on hub Events Creates the following event:
Alert_Property_Change
'alert' : <ident>
'props_after' : {
prop<str> *: value<null> | <typeof_alert_prop>
}
'props_before' ?: {
prop<str> *: value<typeof_alert_prop>
}
Send test alert notifications POST /api/v6.1.0.36/hubs/{hub}/alerts/{alert}/testNo query parameters No extra request headers No request body No extra response headers Response body is plain text
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: Hub not foundRequired Permissions ReadExec access level on hub Events Creates no events.
Definition Interface Click here to see all end points in this interface. Fetch hub definition GET /api/v6.1.0.36/hubs/{hub}/definitionQuery parameter prototype:
'fetch' ?: (
'locs'
| 'loc_props'
| 'loc_actions'
| 'channels'
| 'tables'
| 'cols'
| 'loc_groups'
| 'members'
| 'channel_actions'
| 'hub_actions' +
)
'channel' ?: ( <ident> + )
'loc' ?: ( <ident> + )
'table' ?: ( <str> + )
'action_type' ?: ( <str> + )
'cache_view_tstamp' ?: <date_str_usecs_z>
Request headers prototype:
X-Hvr-Classified-Access : <str >
No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
X-Hvr-Classified-Transport-Key : <str >
Response body is JSON. Prototype:
'locs' ?: {
locname<str> *: {
'props' ?: {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
'channels' ?: {
channel<ident> *: {
'description' ?: <str>
'loc_groups' ?: {
groupname<str> *: {
'members' ?: ( loc <str> * )
}
}
'tables' ?: {
tablename<str> *: {
'base_name' ?: <str>
'table_group' ?: <str>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
'hub_actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Modify scope or parameters of action POST /api/v6.1.0.36/hubs/{hub}/definition/action_modifyNo query parameters No extra request headers Request body is JSON. Prototype:
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<null> | <scal>
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Action does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'modify_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<null> | <scal>
}
}
}
Replace action POST /api/v6.1.0.36/hubs/{hub}/definition/action_replaceNo query parameters No extra request headers Request body is JSON. Prototype:
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Action does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
}
Fetch definition changes from events GET /api/v6.1.0.36/hubs/{hub}/definition/change/eventsQuery parameter prototype:
'direction' ?: 'redo' | 'undo'
'channel' ?: ( <ident> + )
'loc' ?: ( <ident> + )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
'ev_id' ?: ( <date_str_usecs_z> + )
Request headers prototype:
X-Hvr-Classified-Access : <str >
No request body Response headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Response body is JSON. Prototype:
'changes' : (
{
'add_loc' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_loc' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_loc' : {
'loc' : <ident>
}
}
| {
'rename_loc' : {
'loc' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_props' : {
'loc' ?: <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
}
}
| {
'replace_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
}
}
| {
'modify_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
}
}
| {
'delete_loc_props' : {
'loc' : <ident>
'props' : ( <str> + )
}
}
| {
'add_loc_actions' : {
'loc' ?: <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_loc_action_list' : {
'loc' : <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_loc_actions' : {
'loc' : <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'add_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'modify_channel' : {
'channel' : <ident>
'description' : <str>
}
}
| {
'delete_channel' : {
'channel' : <ident>
}
}
| {
'rename_channel' : {
'channel' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_group' : {
'channel' ?: <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
}
}
| {
'replace_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
}
}
| {
'delete_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
}
}
| {
'rename_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_group_members' : {
'channel' ?: <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'replace_loc_group_member_list' : {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'delete_loc_group_members' : {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'add_tables' : {
'channel' ?: <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'modify_table_list' : {
'channel' ?: <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'replace_table_list' : {
'channel' : <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'add_table' : {
'channel' ?: <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'replace_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'modify_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
}
}
| {
'rename_table' : {
'channel' : <ident>
'table' : <ident>
'new_name' : <ident>
}
}
| {
'delete_tables' : {
'channel' : <ident>
'tables' : ( <ident> + )
}
}
| {
'add_cols' : {
'channel' ?: <ident>
'table' ?: <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'modify_col_list' : {
'channel' ?: <ident>
'table' ?: <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'replace_col_list' : {
'channel' : <ident>
'table' : <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'delete_cols' : {
'channel' : <ident>
'table' : <ident>
'cols' : ( <str> + )
}
}
| {
'add_channel_actions' : {
'channel' ?: <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_channel_action_list' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_channel_actions' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'add_hub_actions' : {
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_hub_action_list' : {
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_hub_actions' : {
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'modify_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<null> | <scal>
}
}
}
}
| {
'replace_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
}
}*
)
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Fetch channels from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channelsQuery parameter prototype:
'fetch' ?: (
'tables'
| 'cols'
| 'loc_groups'
| 'members'
| 'channel_actions' +
)
'channel' ?: ( <ident> + )
'table' ?: ( <str> + )
'action_type' ?: ( <str> + )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
channel<ident> *: {
'description' ?: <str>
'loc_groups' ?: {
groupname<str> *: {
'members' ?: ( loc <str> * )
}
}
'tables' ?: {
tablename<str> *: {
'base_name' ?: <str>
'table_group' ?: <str>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
HTTP Status Codes STATUS 200 OK: Channels fetchedSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Add channel POST /api/v6.1.0.36/hubs/{hub}/definition/channelsNo query parameters No extra request headers Request body is JSON. Prototype:
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: Channel already existsRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: ( <ident> + )
'tables' ?: ( <ident> + )
'actions' ?: ( <ident> + )
}
Delete channel DELETE /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Notes Before deleting an activated channel, it is crucial to deactivate it first. This ensures the proper removal of replication components associated with the channel. When replication is activated in a channel, the channel name is used in various places in the Local Processing Hub System, for example, it is mentioned in job names or the directory structure in the $HVR_CONFIG catalog. Deactivation of replication is needed to clean up channel-related files and objects in a hub before deleting a channel. Events Creates the following event:
Definition_Change
'delete_channel ' : {
'channel ' : <ident >
}
Fetch channel from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}Query parameter prototype:
'fetch' ?: (
'tables'
| 'cols'
| 'loc_groups'
| 'members'
| 'channel_actions' +
)
'table' ?: ( <str> + )
'action_type' ?: ( <str> + )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
'description' ?: <str>
'loc_groups' ?: {
groupname<str> *: {
'members' ?: ( loc <str> * )
}
}
'tables' ?: {
tablename<str> *: {
'base_name' ?: <str>
'table_group' ?: <str>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
HTTP Status Codes STATUS 200 OK: Channel fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadOnly access level on hub Modify channel PATCH /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}No query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'modify_channel ' : {
'channel ' : <ident >
'description ' : <str >
}
Add or replace channel PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}No query parameters No extra request headers Request body is JSON. Prototype:
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_channel' | 'replace_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: ( <ident> + )
'tables' ?: ( <ident> + )
'actions' ?: ( <ident> + )
}
Fetch channel actions from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/actionsQuery parameter prototype:
'action_type' ?: ( <str>+ )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
HTTP Status Codes STATUS 200 OK: Definition info fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadOnly access level on hub Add channel actions PATCH /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/actionsNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_channel_actions' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
Replace channel actions list PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/actionsNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_channel_action_list' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
Delete channel actions POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/actions_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_channel_actions' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
Fetch location groups from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groupsQuery parameter prototype:
'fetch' ?: ( 'members' + )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
groupname<str> *: {
'members' ?: ( loc <str> * )
}
HTTP Status Codes STATUS 200 OK: Location groups fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadOnly access level on hub Add location group POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groupsNo query parameters No extra request headers Request body is JSON. Prototype:
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: Location group already existsSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> + )
}
Delete location group DELETE /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc_group ' : {
'channel ' : <ident >
'loc_group ' : <ident >
}
Fetch location group from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}Query parameter prototype:
'fetch' ?: ( 'members' + )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
'members' ?: ( loc <str> * )
HTTP Status Codes STATUS 200 OK: Location group fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadOnly access level on hub Add or replace location group PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}No query parameters No extra request headers Request body is JSON. Prototype:
'members' ?: ( loc <ident> * )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc_group' | 'replace_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> + )
}
Fetch location group members from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/membersNo query parameters No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
HTTP Status Codes STATUS 200 OK: Location group members fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadOnly access level on hub Add location group members or move members from other location groups in channel PATCH /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/membersNo query parameters No extra request headers Request body is JSON. Prototype:
'members' : ( loc <ident> * )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc_group_members ' : {
'channel ' : <ident >
'loc_group ' : <ident >
'members ' : ( loc <ident>+ )
}
Replace location group members list PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/membersNo query parameters No extra request headers Request body is JSON. Prototype:
'members' : ( loc <ident> * )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_loc_group_member_list ' : {
'channel ' : <ident >
'loc_group ' : <ident >
'members ' : ( loc <ident>* )
}
Delete location group member DELETE /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members/{member}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc_group_members ' : {
'channel ' : <ident >
'loc_group ' : <ident >
'members ' : ( loc <ident>* )
}
Delete location group members POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'members' : ( loc <str> * )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or location group does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc_group_members ' : {
'channel ' : <ident >
'loc_group ' : <ident >
'members ' : ( loc <ident>* )
}
Rename location group POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/renameNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: New location group already existsSTATUS 404 Not Found: Channel or old location group does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'rename_loc_group ' : {
'channel ' : <ident >
'loc_group ' : <ident >
'new_name ' : <ident >
}
Rename channel POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/renameNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: New channel already existsSTATUS 404 Not Found: Old channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'rename_channel ' : {
'channel ' : <ident >
'new_name ' : <ident >
}
Fetch tables from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tablesQuery parameter prototype:
'fetch' ?: ( 'cols' + )
'table' ?: ( <str>+ )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
tablename<str> *: {
'base_name' ?: <str>
'table_group' ?: <str>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
HTTP Status Codes STATUS 200 OK: Tables fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadOnly access level on hub Add and replace tables PATCH /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tablesNo query parameters No extra request headers Request body is JSON. Prototype:
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_tables ' | 'modify_table_list ' : {
'channel ' : <ident >
'tables ' : ( <ident >+ )
}
Add table POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tablesNo query parameters No extra request headers Request body is JSON. Prototype:
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: Table already existsSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: ( <str> + )
}
Replace tables list PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tablesNo query parameters No extra request headers Request body is JSON. Prototype:
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_table_list ' : {
'channel ' : <ident >
'tables ' : ( <ident >* )
}
Delete table DELETE /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or table does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_tables ' : {
'channel ' : <ident >
'tables ' : ( <ident >+ )
}
Fetch table from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}Query parameter prototype:
'fetch' ?: ( 'cols' + )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
'base_name' ?: <str>
'table_group' ?: <str>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
HTTP Status Codes STATUS 200 OK: Table fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or table does not existRequired Permissions ReadOnly access level on hub Modify table PATCH /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}No query parameters No extra request headers Request body is JSON. Prototype:
'base_name' ?: <str>
'table_group' ?: <ident>
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'modify_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
}
Add or replace table PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}No query parameters No extra request headers Request body is JSON. Prototype:
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_table' | 'replace_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: ( <str> + )
}
Fetch columns from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}/colsNo query parameters No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
HTTP Status Codes STATUS 200 OK: Columns fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or table does not existRequired Permissions ReadOnly access level on hub Add and replace columns PATCH /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}/colsNo query parameters No extra request headers Request body is JSON. Prototype:
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or table does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_cols ' | 'modify_col_list ' : {
'channel ' : <ident >
'table ' : <ident >
'cols ' : ( <str >+ )
}
Replace columns list PUT /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}/colsNo query parameters No extra request headers Request body is JSON. Prototype:
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or table does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_col_list ' : {
'channel ' : <ident >
'table ' : <ident >
'cols ' : ( <str >+ )
}
Delete columns POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols_deleteNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel or table does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_cols ' : {
'channel ' : <ident >
'table ' : <ident >
'cols ' : ( <str >+ )
}
POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables/{table}/renameNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: New table already existsSTATUS 404 Not Found: Channel or old table does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'rename_table ' : {
'channel ' : <ident >
'table ' : <ident >
'new_name ' : <ident >
}
Delete tables POST /api/v6.1.0.36/hubs/{hub}/definition/channels/{channel}/tables_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'tables ' : ( table <str>* )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Channel does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_tables ' : {
'channel ' : <ident >
'tables ' : ( <ident >+ )
}
Fetch hub actions from definition GET /api/v6.1.0.36/hubs/{hub}/definition/hub_actionsQuery parameter prototype:
'action_type' ?: ( <str>+ )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
HTTP Status Codes STATUS 200 OK: Hub actions fetchedSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Add hub actions PATCH /api/v6.1.0.36/hubs/{hub}/definition/hub_actionsNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_hub_actions ' : {
'actions ' : (
{
'type ' : <ident >
'params ' ?: {
param<str> *: val<scal>
}
}*
)
}
Replace hub actions list PUT /api/v6.1.0.36/hubs/{hub}/definition/hub_actionsNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_hub_action_list ' : {
'actions ' : (
{
'type ' : <ident >
'params ' ?: {
param<str> *: val<scal>
}
}*
)
}
Delete hub actions POST /api/v6.1.0.36/hubs/{hub}/definition/hub_actions_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_hub_actions ' : {
'actions ' : (
{
'type ' : <ident >
'params ' ?: {
param<str> *: val<scal>
}
}*
)
}
Import set of definition changes POST /api/v6.1.0.36/hubs/{hub}/definition/importNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'export_header' ?: {
'creator' : user<str>
'tstamp' : <date_str_z>
'hvr_version' : <str>
'description' : <str>
'api_version' : <str>
'original_hub' : <str>
'type' : 'definition_changes'
}
'allowed_changes' ?: (
'add_loc'
| 'replace_loc'
| 'delete_loc'
| 'rename_loc'
| 'add_loc_props'
| 'replace_loc_props'
| 'modify_loc_props'
| 'delete_loc_props'
| 'add_loc_actions'
| 'replace_loc_action_list'
| 'delete_loc_actions'
| 'add_channel'
| 'replace_channel'
| 'modify_channel'
| 'delete_channel'
| 'rename_channel'
| 'add_loc_group'
| 'replace_loc_group'
| 'delete_loc_group'
| 'rename_loc_group'
| 'add_loc_group_members'
| 'replace_loc_group_member_list'
| 'delete_loc_group_members'
| 'add_tables'
| 'modify_table_list'
| 'replace_table_list'
| 'add_table'
| 'replace_table'
| 'modify_table'
| 'rename_table'
| 'delete_tables'
| 'add_cols'
| 'modify_col_list'
| 'replace_col_list'
| 'delete_cols'
| 'add_channel_actions'
| 'replace_channel_action_list'
| 'delete_channel_actions'
| 'add_hub_actions'
| 'replace_hub_action_list'
| 'delete_hub_actions'
| 'modify_action'
| 'replace_action' +
)
'loc_context' ?: <ident>
'channel_context' ?: <ident>
'table_context' ?: <ident>
'on_add_exists' ?: 'replace' | 'rename' | 'abort'
'on_action_absent_loc' ?: 'loc_group' | 'discard' | 'abort'
'on_old_group_members' ?: 'keep' | 'remove'
'on_member_absent_loc' ?: 'remove' | 'abort'
'on_absent' ?: 'resilient' | 'abort'
'on_channel_or_loc_replace_actions' ?: 'merge' | 'replace'
'changes' : (
{
'add_loc' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_loc' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_loc' : {
'loc' : <ident>
}
}
| {
'rename_loc' : {
'loc' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_props' : {
'loc' ?: <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
}
}
| {
'replace_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
}
}
| {
'modify_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
}
}
| {
'delete_loc_props' : {
'loc' : <ident>
'props' : ( <str> + )
}
}
| {
'add_loc_actions' : {
'loc' ?: <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_loc_action_list' : {
'loc' : <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_loc_actions' : {
'loc' : <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'add_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'modify_channel' : {
'channel' : <ident>
'description' : <str>
}
}
| {
'delete_channel' : {
'channel' : <ident>
}
}
| {
'rename_channel' : {
'channel' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_group' : {
'channel' ?: <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
}
}
| {
'replace_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
}
}
| {
'delete_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
}
}
| {
'rename_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_group_members' : {
'channel' ?: <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'replace_loc_group_member_list' : {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'delete_loc_group_members' : {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'add_tables' : {
'channel' ?: <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'modify_table_list' : {
'channel' ?: <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'replace_table_list' : {
'channel' : <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'add_table' : {
'channel' ?: <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'replace_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'modify_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
}
}
| {
'rename_table' : {
'channel' : <ident>
'table' : <ident>
'new_name' : <ident>
}
}
| {
'delete_tables' : {
'channel' : <ident>
'tables' : ( <ident> + )
}
}
| {
'add_cols' : {
'channel' ?: <ident>
'table' ?: <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'modify_col_list' : {
'channel' ?: <ident>
'table' ?: <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'replace_col_list' : {
'channel' : <ident>
'table' : <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'delete_cols' : {
'channel' : <ident>
'table' : <ident>
'cols' : ( <str> + )
}
}
| {
'add_channel_actions' : {
'channel' ?: <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_channel_action_list' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_channel_actions' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'add_hub_actions' : {
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_hub_action_list' : {
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_hub_actions' : {
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'modify_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<null> | <scal>
}
}
}
}
| {
'replace_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
}
}*
)
No extra response headers Response body is JSON. Prototype:
'change_counts' : {
'add_loc' ?: <int>
'replace_loc' ?: <int>
'delete_loc' ?: <int>
'rename_loc' ?: <int>
'add_loc_props' ?: <int>
'replace_loc_props' ?: <int>
'modify_loc_props' ?: <int>
'delete_loc_props' ?: <int>
'add_loc_actions' ?: <int>
'replace_loc_action_list' ?: <int>
'delete_loc_actions' ?: <int>
'add_channel' ?: <int>
'replace_channel' ?: <int>
'modify_channel' ?: <int>
'delete_channel' ?: <int>
'rename_channel' ?: <int>
'add_loc_group' ?: <int>
'replace_loc_group' ?: <int>
'delete_loc_group' ?: <int>
'rename_loc_group' ?: <int>
'add_loc_group_members' ?: <int>
'replace_loc_group_member_list' ?: <int>
'delete_loc_group_members' ?: <int>
'add_tables' ?: <int>
'modify_table_list' ?: <int>
'replace_table_list' ?: <int>
'add_table' ?: <int>
'replace_table' ?: <int>
'modify_table' ?: <int>
'rename_table' ?: <int>
'delete_tables' ?: <int>
'add_cols' ?: <int>
'modify_col_list' ?: <int>
'replace_col_list' ?: <int>
'delete_cols' ?: <int>
'add_channel_actions' ?: <int>
'replace_channel_action_list' ?: <int>
'delete_channel_actions' ?: <int>
'add_hub_actions' ?: <int>
'replace_hub_action_list' ?: <int>
'delete_hub_actions' ?: <int>
'modify_action' ?: <int>
'replace_action' ?: <int>
}
'change_replay' ?: <bool>
'add_exists' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'loc_group_member' ?: <int>
'table' ?: <int>
'col' ?: <int>
}
'rename_exists' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
}
'replace_absent' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
'action' ?: <int>
}
'modify_absent' ?: {
'channel' ?: <int>
'table' ?: <int>
'action' ?: <int>
}
'delete_absent' ?: {
'loc' ?: <int>
'loc_prop' ?: <int>
'loc_action' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'loc_group_member' ?: <int>
'table' ?: <int>
'col' ?: <int>
'channel_action' ?: <int>
'hub_action' ?: <int>
}
'rename_absent' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
}
'action_absent_loc' ?: ( loc<ident>+ )
'old_group_members' ?: ( loc<ident>+ )
'member_absent_loc' ?: ( loc<ident>+ )
'rename_locs' ?: (
{
'name_before' : <ident>
'names_after' : ( <ident>+ )
}*
)
'rename_channels' ?: (
{
'name_before' : <ident>
'names_after' : ( <ident>+ )
}*
)
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change_Import
'change_counts' : {
'add_loc' ?: <int>
'replace_loc' ?: <int>
'delete_loc' ?: <int>
'rename_loc' ?: <int>
'add_loc_props' ?: <int>
'replace_loc_props' ?: <int>
'modify_loc_props' ?: <int>
'delete_loc_props' ?: <int>
'add_loc_actions' ?: <int>
'replace_loc_action_list' ?: <int>
'delete_loc_actions' ?: <int>
'add_channel' ?: <int>
'replace_channel' ?: <int>
'modify_channel' ?: <int>
'delete_channel' ?: <int>
'rename_channel' ?: <int>
'add_loc_group' ?: <int>
'replace_loc_group' ?: <int>
'delete_loc_group' ?: <int>
'rename_loc_group' ?: <int>
'add_loc_group_members' ?: <int>
'replace_loc_group_member_list' ?: <int>
'delete_loc_group_members' ?: <int>
'add_tables' ?: <int>
'modify_table_list' ?: <int>
'replace_table_list' ?: <int>
'add_table' ?: <int>
'replace_table' ?: <int>
'modify_table' ?: <int>
'rename_table' ?: <int>
'delete_tables' ?: <int>
'add_cols' ?: <int>
'modify_col_list' ?: <int>
'replace_col_list' ?: <int>
'delete_cols' ?: <int>
'add_channel_actions' ?: <int>
'replace_channel_action_list' ?: <int>
'delete_channel_actions' ?: <int>
'add_hub_actions' ?: <int>
'replace_hub_action_list' ?: <int>
'delete_hub_actions' ?: <int>
'modify_action' ?: <int>
'replace_action' ?: <int>
}
'change_replay' ?: <bool>
'add_exists' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'loc_group_member' ?: <int>
'table' ?: <int>
'col' ?: <int>
}
'rename_exists' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
}
'replace_absent' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
'action' ?: <int>
}
'modify_absent' ?: {
'channel' ?: <int>
'table' ?: <int>
'action' ?: <int>
}
'delete_absent' ?: {
'loc' ?: <int>
'loc_prop' ?: <int>
'loc_action' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'loc_group_member' ?: <int>
'table' ?: <int>
'col' ?: <int>
'channel_action' ?: <int>
'hub_action' ?: <int>
}
'rename_absent' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
}
'action_absent_loc' ?: ( loc<ident>+ )
'old_group_members' ?: ( loc<ident>+ )
'member_absent_loc' ?: ( loc<ident>+ )
'rename_locs' ?: (
{
'name_before' : <ident>
'names_after' : ( <ident>+ )
}*
)
'rename_channels' ?: (
{
'name_before' : <ident>
'names_after' : ( <ident>+ )
}*
)
Analyze set of definition changes for import POST /api/v6.1.0.36/hubs/{hub}/definition/import/analyzeNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'export_header' ?: {
'creator' : user<str>
'tstamp' : <date_str_z>
'hvr_version' : <str>
'description' : <str>
'api_version' : <str>
'original_hub' : <str>
'type' : 'definition_changes'
}
'allowed_changes' ?: (
'add_loc'
| 'replace_loc'
| 'delete_loc'
| 'rename_loc'
| 'add_loc_props'
| 'replace_loc_props'
| 'modify_loc_props'
| 'delete_loc_props'
| 'add_loc_actions'
| 'replace_loc_action_list'
| 'delete_loc_actions'
| 'add_channel'
| 'replace_channel'
| 'modify_channel'
| 'delete_channel'
| 'rename_channel'
| 'add_loc_group'
| 'replace_loc_group'
| 'delete_loc_group'
| 'rename_loc_group'
| 'add_loc_group_members'
| 'replace_loc_group_member_list'
| 'delete_loc_group_members'
| 'add_tables'
| 'modify_table_list'
| 'replace_table_list'
| 'add_table'
| 'replace_table'
| 'modify_table'
| 'rename_table'
| 'delete_tables'
| 'add_cols'
| 'modify_col_list'
| 'replace_col_list'
| 'delete_cols'
| 'add_channel_actions'
| 'replace_channel_action_list'
| 'delete_channel_actions'
| 'add_hub_actions'
| 'replace_hub_action_list'
| 'delete_hub_actions'
| 'modify_action'
| 'replace_action' +
)
'loc_context' ?: <ident>
'channel_context' ?: <ident>
'table_context' ?: <ident>
'changes' : (
{
'add_loc' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_loc' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_loc' : {
'loc' : <ident>
}
}
| {
'rename_loc' : {
'loc' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_props' : {
'loc' ?: <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
}
}
| {
'replace_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
}
}
| {
'modify_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
}
}
| {
'delete_loc_props' : {
'loc' : <ident>
'props' : ( <str> + )
}
}
| {
'add_loc_actions' : {
'loc' ?: <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_loc_action_list' : {
'loc' : <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_loc_actions' : {
'loc' : <ident>
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'add_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_channel' : {
'channel' : <ident>
'description' ?: <str>
'loc_groups' ?: {
groupname<ident> *: {
'members' ?: ( loc <ident> * )
}
}
'tables' ?: {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
'actions' ?: (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'modify_channel' : {
'channel' : <ident>
'description' : <str>
}
}
| {
'delete_channel' : {
'channel' : <ident>
}
}
| {
'rename_channel' : {
'channel' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_group' : {
'channel' ?: <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
}
}
| {
'replace_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'members' ?: ( loc <ident> * )
}
}
| {
'delete_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
}
}
| {
'rename_loc_group' : {
'channel' : <ident>
'loc_group' : <ident>
'new_name' : <ident>
}
}
| {
'add_loc_group_members' : {
'channel' ?: <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'replace_loc_group_member_list' : {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'delete_loc_group_members' : {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> * )
}
}
| {
'add_tables' : {
'channel' ?: <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'modify_table_list' : {
'channel' ?: <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'replace_table_list' : {
'channel' : <ident>
'tables' : {
tablename<ident> *: {
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
}
}
| {
'add_table' : {
'channel' ?: <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'replace_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
'cols' ?: {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'modify_table' : {
'channel' : <ident>
'table' : <ident>
'base_name' ?: <str>
'table_group' ?: <ident>
}
}
| {
'rename_table' : {
'channel' : <ident>
'table' : <ident>
'new_name' : <ident>
}
}
| {
'delete_tables' : {
'channel' : <ident>
'tables' : ( <ident> + )
}
}
| {
'add_cols' : {
'channel' ?: <ident>
'table' ?: <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'modify_col_list' : {
'channel' ?: <ident>
'table' ?: <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'replace_col_list' : {
'channel' : <ident>
'table' : <ident>
'cols' : {
colname<str> *: {
'sequence' : <int>
'key' ?: <int>
'distrib_key' ?: <int>
'data_type' : <str>
'attributes' ?: {
'encoding' ?: <str>
'nullable' ?: <bool>
'charlen' ?: <int64_ascii>
'bytelen' ?: <int64_ascii>
'prec' ?: <int>
'scale' ?: <int>
'timeprec' ?: <int>
'dayprec' ?: <int>
'yearprec' ?: <int>
'bitlen' ?: <int>
}
}
}
}
}
| {
'delete_cols' : {
'channel' : <ident>
'table' : <ident>
'cols' : ( <str> + )
}
}
| {
'add_channel_actions' : {
'channel' ?: <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_channel_action_list' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_channel_actions' : {
'channel' : <ident>
'actions' : (
{
'loc_scope' ?: <str>
'table_scope' ?: <str>
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'add_hub_actions' : {
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'replace_hub_action_list' : {
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'delete_hub_actions' : {
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
}
| {
'modify_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<null> | <scal>
}
}
}
}
| {
'replace_action' : {
'type' : <ident>
'old' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
'new' : {
'channel' ?: <str>
'loc_scope' ?: <str>
'table_scope' ?: <str>
'params' ?: {
param<str> *: val<scal>
}
}
}
}*
)
No extra response headers Response body is JSON. Prototype:
'change_counts' : {
'add_loc' ?: <int>
'replace_loc' ?: <int>
'delete_loc' ?: <int>
'rename_loc' ?: <int>
'add_loc_props' ?: <int>
'replace_loc_props' ?: <int>
'modify_loc_props' ?: <int>
'delete_loc_props' ?: <int>
'add_loc_actions' ?: <int>
'replace_loc_action_list' ?: <int>
'delete_loc_actions' ?: <int>
'add_channel' ?: <int>
'replace_channel' ?: <int>
'modify_channel' ?: <int>
'delete_channel' ?: <int>
'rename_channel' ?: <int>
'add_loc_group' ?: <int>
'replace_loc_group' ?: <int>
'delete_loc_group' ?: <int>
'rename_loc_group' ?: <int>
'add_loc_group_members' ?: <int>
'replace_loc_group_member_list' ?: <int>
'delete_loc_group_members' ?: <int>
'add_tables' ?: <int>
'modify_table_list' ?: <int>
'replace_table_list' ?: <int>
'add_table' ?: <int>
'replace_table' ?: <int>
'modify_table' ?: <int>
'rename_table' ?: <int>
'delete_tables' ?: <int>
'add_cols' ?: <int>
'modify_col_list' ?: <int>
'replace_col_list' ?: <int>
'delete_cols' ?: <int>
'add_channel_actions' ?: <int>
'replace_channel_action_list' ?: <int>
'delete_channel_actions' ?: <int>
'add_hub_actions' ?: <int>
'replace_hub_action_list' ?: <int>
'delete_hub_actions' ?: <int>
'modify_action' ?: <int>
'replace_action' ?: <int>
}
'change_replay' ?: <bool>
'add_exists' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'loc_group_member' ?: <int>
'table' ?: <int>
'col' ?: <int>
}
'rename_exists' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
}
'replace_absent' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
'action' ?: <int>
}
'modify_absent' ?: {
'channel' ?: <int>
'table' ?: <int>
'action' ?: <int>
}
'delete_absent' ?: {
'loc' ?: <int>
'loc_prop' ?: <int>
'loc_action' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'loc_group_member' ?: <int>
'table' ?: <int>
'col' ?: <int>
'channel_action' ?: <int>
'hub_action' ?: <int>
}
'rename_absent' ?: {
'loc' ?: <int>
'channel' ?: <int>
'loc_group' ?: <int>
'table' ?: <int>
}
'action_absent_loc' ?: ( loc<ident>+ )
'old_group_members' ?: ( loc<ident>+ )
'member_absent_loc' ?: ( loc<ident>+ )
'rename_locs' ?: (
{
'name_before' : <ident>
'names_after' : ( <ident>+ )
}*
)
'rename_channels' ?: (
{
'name_before' : <ident>
'names_after' : ( <ident>+ )
}*
)
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Events Creates no events.
Fetch locations from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/locsQuery parameter prototype:
'fetch' ?: ( 'loc_props' | 'loc_actions' + )
'loc' ?: ( <ident> + )
'action_type' ?: ( <str> + )
'cache_view_tstamp' ?: <date_str_usecs_z>
Request headers prototype:
X-Hvr-Classified-Access : <str >
No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
X-Hvr-Classified-Transport-Key : <str >
Response body is JSON. Prototype:
locname<str> *: {
'props' ?: {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
}
HTTP Status Codes STATUS 200 OK: Locations fetchedSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Add location POST /api/v6.1.0.36/hubs/{hub}/definition/locsNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc' : <ident>
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: Location already existsRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc ' : {
'loc ' : <ident >
'props ' : ( <str >+ )
'actions ' ?: ( <ident>+ )
}
Delete location DELETE /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc ' : {
'loc ' : <ident >
}
Fetch location from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}Query parameter prototype:
'fetch' ?: ( 'loc_props' | 'loc_actions' + )
'action_type' ?: ( <str> + )
'cache_view_tstamp' ?: <date_str_usecs_z>
Request headers prototype:
X-Hvr-Classified-Access : <str >
No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
X-Hvr-Classified-Transport-Key : <str >
Response body is JSON. Prototype:
'props' ?: {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
HTTP Status Codes STATUS 200 OK: Location fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadOnly access level on hub Add or replace location PUT /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}No query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'props' : {
prop<str> *: value<typeof_loc_prop>
}
'actions' ?: (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc ' | 'replace_loc ' : {
'loc ' : <ident >
'props ' : ( <str >+ )
'actions ' ?: ( <ident>+ )
}
Fetch location actions from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/actionsQuery parameter prototype:
'action_type' ?: ( <str>+ )
'cache_view_tstamp' ?: <date_str_usecs_z>
No extra request headers No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
Response body is JSON. Prototype:
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
HTTP Status Codes STATUS 200 OK: Location actions fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadOnly access level on hub Add location actions PATCH /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/actionsNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc_actions ' : {
'loc ' : <ident >
'actions ' : (
{
'type ' : <ident >
'params ' ?: {
param<str> *: val<scal>
}
}*
)
}
Replace location actions list PUT /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/actionsNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'replace_loc_action_list ' : {
'loc ' : <ident >
'actions ' : (
{
'type ' : <ident >
'params ' ?: {
param<str> *: val<scal>
}
}*
)
}
Delete location actions POST /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/actions_deleteNo query parameters No extra request headers Request body is JSON. Prototype:
'actions' : (
{
'type' : <ident>
'params' ?: {
param<str> *: val<scal>
}
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc_actions ' : {
'loc ' : <ident >
'actions ' : (
{
'type ' : <ident >
'params ' ?: {
param<str> *: val<scal>
}
}*
)
}
Copy location POST /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/copyNo query parameters No extra request headers Request body is JSON. Prototype:
'new_name ' : <ident >
'membership ' ?: 'copy_existing '
| (
{
'channel ' : <ident >
'loc_group ' : <ident >
}*
)
No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: New location already existsSTATUS 404 Not Found: Old location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'add_loc' ?: {
'loc' : <ident>
'props' : ( <str> + )
'actions' ?: ( <ident> + )
}
'add_loc_group_members' ?: {
'channel' : <ident>
'loc_group' : <ident>
'members' : ( loc <ident> + )
}
Fetch location properties from hub definition GET /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/propsNo query parameters Request headers prototype:
X-Hvr-Classified-Access : <str >
No request body Response headers prototype:
X-Hvr-View-Tstamp : <date_str_usecs_z >
X-Hvr-Reload-Cache : <bool >
X-Hvr-Classified-Transport-Key : <str >
X-Hvr-Redacted-Storage : <str >
Response body is JSON. Prototype:
prop<str > *: value<typeof_loc_prop >
HTTP Status Codes STATUS 200 OK: Location properties fetchedSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadOnly access level on hub Set/reset location properties PATCH /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/propsNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
prop<str > *: value<null > | <typeof_loc_prop >
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'modify_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
}
Delete location property DELETE /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/props/{prop}No query parameters No extra request headers No request body No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc_props ' : {
'loc ' : <ident >
'props ' : ( <str >+ )
}
Delete location properties POST /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/props_deleteNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'delete_loc_props ' : {
'loc ' : <ident >
'props ' : ( <str >+ )
}
Modify location properties POST /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/props_modifyNo query parameters Request headers prototype:
X-Hvr-Classified-Transport-Key : <str >
Request body is JSON. Prototype:
'loc_prop_args' : (
{
'key' : ( prop<ident> <null> | <int> | <str> * )
'value' : <any>
}+
)
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad RequestSTATUS 404 Not Found: Location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'modify_loc_props' : {
'loc' : <ident>
'props' : {
prop<str> *: value<null> | <typeof_loc_prop>
}
}
Rename location POST /api/v6.1.0.36/hubs/{hub}/definition/locs/{loc}/renameNo query parameters No extra request headers Request body is JSON. Prototype: No extra response headers No response body
HTTP Status Codes STATUS 201 CreatedSTATUS 400 Bad Request: New location already existsSTATUS 404 Not Found: Old location does not existRequired Permissions ReadWrite access level on hub Events Creates the following event:
Definition_Change
'rename_loc ' : {
'loc ' : <ident >
'new_name ' : <ident >
}
Event Interface Click here to see all end points in this interface. Get all unique channels from hvr_event GET /api/v6.1.0.36/hubs/{hub}/event_channelsQuery parameter prototype:
'type' ?: ( <str>+ )
'state' ?: ( <str ACTIVE DONE FAILED CANCELED >+ )
'loc' ?: <ident>
'fetch_repos_events' ?: <bool>
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
channel<ident > *: num<int >
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Get all unique locations from hvr_event GET /api/v6.1.0.36/hubs/{hub}/event_locsQuery parameter prototype:
'channel' ?: ( <ident>+ )
'type' ?: ( <str>+ )
'state' ?: ( <str ACTIVE DONE FAILED CANCELED >+ )
'fetch_repos_events' ?: <bool>
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Get all unique event types from hvr_event GET /api/v6.1.0.36/hubs/{hub}/event_typesQuery parameter prototype:
'channel' ?: ( <ident>+ )
'state' ?: ( <str ACTIVE DONE FAILED CANCELED >+ )
'loc' ?: <ident>
'fetch_repos_events' ?: <bool>
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Fetch event(s) GET /api/v6.1.0.36/hubs/{hub}/eventsQuery parameter prototype:
'channel' ?: ( <ident>+ )
'ev_id' ?: ( <date_str_usecs_z>+ )
'type' ?: ( <str>+ )
'state' ?: ( <str ACTIVE DONE CANCELED FAILED >+ )
'current_only' ?: <bool>
'loc' ?: <ident>
'job' ?: ( <str>+ )
'body_pattern' ?: <str>
'fetch_results' ?: <bool>
'result_pattern' ?: <str>
'result_table' ?: ( <str>* )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
'updated_begin' ?: <date_str_usecs_z>
'updated_end' ?: <date_str_usecs_z>
'max_events' ?: <int>
'fetch_repos_events' ?: <bool>
'with_matching_results_only' ?: <bool>
No extra request headers No request body Response headers prototype:
X-Hvr-Last-Updated : <date_str_usecs_z >
Response body is JSON. Prototype:
ev_id<date_str_usecs_z> *: {
'type' : <str>
'user' ?: <str>
'description' ?: <str>
'channel' ?: <str>
'loc' ?: <str>
'loc2' ?: <str>
'job' ?: <str>
'state' : <str>
'num_retries' ?: <int>
'response' ?: <str>
'start_tstamp' ?: <date_str_usecs_z>
'finish_tstamp' ?: <date_str_usecs_z>
'repos_event' ?: <bool>
'body' ?: <json>
'results' ?: (
{
'table' ?: <str>
'result' : <str>
'value' ?: <str>
}*
)
}
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions ReadOnly access level on hub Get log file content during a specified event GET /api/v6.1.0.36/hubs/{hub}/events/{ev_id}/logQuery parameter prototype:
'max_lines' ?: <int>
'head_crc' ?: crc<str>
'offset_begin' ?: <uint64_ascii>
'archive' ?: <str>
No extra request headers No request body Response headers prototype:
X-Hvr-Offset-End : <int64_ascii >
X-Hvr-Head-Crc : <str >
X-Hvr-Archive-Next : <str >
X-Hvr-Event-End : <str >
Response body is plain text
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestSTATUS 404 Not Found: The specified event can not be foundRequired Permissions ReadOnly access level on hub Cancel events. Associated jobs will be suspended POST /api/v6.1.0.36/hubs/{hub}/events_cancelNo query parameters No extra request headers Request body is JSON. Prototype:
'ev_ids ' : ( <date_str_usecs_z >* )
No extra response headers No response body
HTTP Status Codes STATUS 204 No ContentSTATUS 400 Bad Request: Only events in 'ACTIVE' state can be canceledSTATUS 404 Not Found: Event does not existRequired Permissions ReadExec access level on hub Events Creates the following event:
Event_Cancel
'ev_ids ' : ( <date_str_usecs_z >+ )
Get all unique event types for repos GET /api/v6.1.0.36/repos/event_typesQuery parameter prototype:
'state ' ?: ( <str ACTIVE DONE FAILED CANCELED> + )
'ev_tstamp_begin' ?: <date_str_usecs_z>
'ev_tstamp_end' ?: <date_str_usecs_z>
No extra request headers No request body No extra response headers Response body is JSON. Prototype:
HTTP Status Codes STATUS 200 OKSTATUS 400 Bad RequestRequired Permissions No special permission required Fetch the repository events GET /api/v6.1.0.36/repos/eventsQuery parameter prototype:
'ev_id' ?: ( <date_str_usecs_z>+ )
'type' ?: ( <str>+ )
'state' ?: ( <str ACTIVE DONE CANCELED FAILED >+ )
'body_pattern' ?: <str>