6.1.0.4

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.4/hubs/{hub}/activate

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Check replication activation status of channel

GET /api/v6.1.0.4/hubs/{hub}/channels/{channel}/activate

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Post an Hvr activate event

POST /api/v6.1.0.4/hubs/{hub}/channels/{channel}/activate

No 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 Created
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/channels/{channel}/compare

No 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> '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 Created
STATUS 400 Bad Request
STATUS 403 Forbidden: User does not have Exec access

Required 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>
'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.4/hubs/{hub}/channels/{channel}/compare/tables_results_ids

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Show contexts and context variables

GET /api/v6.1.0.4/hubs/{hub}/channels/{channel}/contexts

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required Permissions

ReadOnly access level on hub

Post an Hvr deactivate event

POST /api/v6.1.0.4/hubs/{hub}/channels/{channel}/deactivate

No 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 Created
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/channels/{channel}/locs/{loc}/capture_open_tx

No 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 OK
STATUS 400 Bad Request: No capture tables defined or finding oldest transaction start time not possible
STATUS 404 Not Found: Channel or channel member not found

Required Permissions

ReadOnly access level on hub

Show integrate point

GET /api/v6.1.0.4/hubs/{hub}/channels/{channel}/locs/{loc}/integrate_point

Query 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or Location does not exist

Required Permissions

ReadOnly access level on hub

Suggest slicing, based on old table results and Oracle DBMS stats

POST /api/v6.1.0.4/hubs/{hub}/channels/{channel}/locs/{loc}/slicing_suggest

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Channel, location or table does not exist

Required Permissions

ReadOnly access level on hub

Events

Creates no events.

Suggest slicing boundaries based on Oracle DBMS stats. Can return empty

POST /api/v6.1.0.4/hubs/{hub}/channels/{channel}/locs/{loc}/tables/{table}/slicing_boundaries

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Channel, location, table or column does not exist

Required Permissions

ReadOnly access level on hub

Events

Creates no events.

Post Refresh event and schedule a job for it

POST /api/v6.1.0.4/hubs/{hub}/channels/{channel}/refresh

No 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'* )
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 Created
STATUS 400 Bad Request
STATUS 403 Forbidden: User does not have Write or Refresh access

Required 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'* )

Get event ids for tables results of recent Refresh

GET /api/v6.1.0.4/hubs/{hub}/channels/{channel}/refresh/tables_results_ids

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Get event ids for tables results of recent Compare for all channels

GET /api/v6.1.0.4/hubs/{hub}/compare/tables_results_ids

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Check replication activation status of loc

GET /api/v6.1.0.4/hubs/{hub}/locs/{loc}/activate

No 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Get event ids for tables results of recent Refresh for all channels

GET /api/v6.1.0.4/hubs/{hub}/refresh/tables_results_ids

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Agent Configuration Interface

Click here to see all end points in this interface.

Detect whether hub may (re)configure agent of existing location

GET /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: The requested hub or location does not exist

Required Permissions

ReadOnly access level on hub

Delete agent properties of existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/props_delete

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

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 existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/props_get

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required Permissions

ReadWrite access level on hub

Events

Creates no events.

Update agent properties of existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/props_patch

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

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 existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/props_put

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

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 existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/test

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required Permissions

ReadOnly access level on hub

Events

Creates no events.

Create user on agent for existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/users

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

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 existing location

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/users_delete

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

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 existing agent

POST /api/v6.1.0.4/hubs/{hub}/locs/{loc}/agent/users_get

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/hubs/{hub}/locs/{loc}/agent/users_password

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/hubs/{hub}/new_loc/agent/props_delete

No 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 Content
STATUS 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.4/hubs/{hub}/new_loc/agent/props_get

No 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 OK
STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'

Required Permissions

ReadWrite access level on hub

Events

Creates no events.

Update agent properties of new location

POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/props_patch

No 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 Content
STATUS 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.4/hubs/{hub}/new_loc/agent/props_put

No 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 Content
STATUS 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.4/hubs/{hub}/new_loc/agent/test

No 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 OK
STATUS 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.4/hubs/{hub}/new_loc/agent/users

No 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 Content
STATUS 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.4/hubs/{hub}/new_loc/agent/users_delete

No 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 Content
STATUS 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.4/hubs/{hub}/new_loc/agent/users_get

No 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 OK
STATUS 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.4/hubs/{hub}/new_loc/agent/users_password

No 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 Content
STATUS 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>

Detect whether hub may (re)configure agent of new location

POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent_get

No 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 OK
STATUS 400 Bad Request
STATUS 404 Not Found: The requested hub does not exist

Required Permissions

ReadOnly access level on hub

Events

Creates no events.

Alert Interface

Click here to see all end points in this interface.

List configured alerts

GET /api/v6.1.0.4/hubs/{hub}/alerts

No query parameters
No extra request headers
No request body
No extra response headers
Response body is JSON. Prototype:	`alert<ident>*`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Hub not found

Required Permissions

ReadOnly access level on hub

### Create alert configuration

POST /api/v6.1.0.4/hubs/{hub}/alerts

No 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 Created
STATUS 400 Bad Request: Alert already exists
STATUS 404 Not Found: Hub not found

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Hub or Alert not found

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Alert_Delete


'alert' : <ident>

Clear alert state

POST /api/v6.1.0.4/hubs/{hub}/alerts/{alert}/clear

No query parameters
No extra request headers
No request body
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request
STATUS 404 Not Found: Hub or Alert not found

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Alert_Clear


'alert' : <ident>

Disable an alert configuration

POST /api/v6.1.0.4/hubs/{hub}/alerts/{alert}/disable

No query parameters
No extra request headers
No request body
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request
STATUS 404 Not Found: Hub or Alert not found

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Alert_Disable


'alert' : <ident>

Execute alert configuration now

POST /api/v6.1.0.4/hubs/{hub}/alerts/{alert}/execute

No query parameters
No extra request headers
No request body
No extra response headers
Response body is plain text

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Hub not found

Required 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.4/hubs/{hub}/alerts/{alert}/props

Query 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 OK
STATUS 400 Bad Request: Specified property does not exist
STATUS 404 Not Found: Hub or Alert not found

Required Permissions

ReadOnly access level on hub

### Modify alert configuration properties

PATCH /api/v6.1.0.4/hubs/{hub}/alerts/{alert}/props

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Hub or Alert not found

Required 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.4/hubs/{hub}/alerts/{alert}/props

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Hub or Alert not found

Required 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.4/hubs/{hub}/alerts/{alert}/props_delete

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'props' : ( prop<str>+ )`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request
STATUS 404 Not Found: Hub or Alert not found

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Alert_Property_Delete


'alert' : <ident>
'props' : ( prop<str>+ )

Send test alert notifications

POST /api/v6.1.0.4/hubs/{hub}/alerts/{alert}/test

No query parameters
No extra request headers
No request body
No extra response headers
Response body is plain text

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request
STATUS 404 Not Found: Hub not found

Required Permissions

ReadExec access level on hub

Events

Creates no events.

Control Message Interface

Click here to see all end points in this interface.

Get all control ids matched by the query

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

Query parameter prototype:	`'task_name' ?: 'cap' \| 'integ' 'loc_name' ?: ( <ident>+ ) 'ctrl_name' ?: <ident> 'ctrl_id' ?: ( <str>+ )`
No extra request headers
No request body
Response headers prototype:	`X-Hvr-Hidden-Files : <bool>`
Response body is JSON. Prototype:	`ctrl_id<str>*`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request
STATUS 404 Not Found: not found hub or channel

Required Permissions

ReadOnly access level on hub

Get the control associated with the id

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

No query parameters
No extra request headers
No request body
Response headers prototype:	`X-Hvr-Hidden-Files : <bool>`
Response body is JSON. Prototype:	'task_name' : 'cap' \| 'integ' 'loc_name' : <ident> 'ctrl_name' : <ident> 'filters' ?: ( { 'tables' ?: ( <ident>+ ) 'where' ?: ( { 'col' : <str> 'op' : '=' \| '!=' \| '<>' \| '>' \| '<' \| '>=' \| '<=' \| '>>' \| '<<' \| '%=' 'val_str' ?: ( <str>+ ) 'val_int' ?: ( <str>+ ) 'val_date' ?: ( <date_str_z>+ ) 'val_len' ?: ( <str>+ ) }* ) 'force_failed_rows' ?: <true> 'resilient' ?: <true> 'skip_rows' ?: <true> 'set_missing_cols' ?: ( col<str>* ) }* ) 'eval' ?: <list> 'expiry_date' ?: <date_str_z> 'recv_expiry' ?: <date_str_z>

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request
STATUS 404 Not Found: not found hub or channel or control

Required Permissions

ReadOnly access level on hub

Delete all the controls matched.

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

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'ctrl_ids' : ( <str>+ )`
No extra response headers
No response body

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request
STATUS 404 Not Found: The control does not exist.

Required Permissions

ReadExec access level on hub

Events

Creates the following event

Control_Delete


'chn_name' : <ident>
'ctrl_ids' : ( <str>+ )

Send a new control file

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

No query parameters
No extra request headers
Request body is JSON. Prototype:	'ctrl_name' ?: <ident> 'filters' ?: ( { 'tables' ?: ( <ident>+ ) 'where' ?: ( { 'col' : <str> 'op' : '=' \| '!=' \| '<>' \| '>' \| '<' \| '>=' \| '<=' \| '>>' \| '<<' \| '%=' 'val_str' ?: ( <str>+ ) 'val_int' ?: ( <str>+ ) 'val_date' ?: ( <date_str_z>+ ) 'val_len' ?: ( <str>+ ) }* ) 'force_failed_rows' ?: <bool> 'resilient' ?: <bool> 'skip_rows' ?: <bool> 'set_missing_cols' ?: ( col<str>+ ) }* ) 'set_env' ?: ( { 'name' : <str> 'value' : <str> }* ) 'journaling' ?: <bool> 'finish_after_cycle' ?: <bool> 'expiry_date' ?: <date_str_z> 'recv_expiry' ?: <date_str_z>
No extra response headers
Response body is JSON. Prototype:	`'ctrl_id' : <str>`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Control_Send


'chn_name' : <ident>
'task_name' : 'cap' | 'integ'
'loc_name' : <ident>
'ctrl_name' : <ident>
'filters' ?: (
    {
        'tables' ?: ( <ident>+ )
        'where' ?: (
            {
                'col' : <str>
                'op' : '='
                     | '!='
                     | '<>'
                     | '>'
                     | '<'
                     | '>='
                     | '<='
                     | '>>'
                     | '<<'
                     | '%='
                'val_str' ?: ( <str>+ )
                'val_int' ?: ( <str>+ )
                'val_date' ?: ( <date_str_z>+ )
                'val_len' ?: ( <str>+ )
            }*
        )
        'force_failed_rows' ?: <true>
        'resilient' ?: <true>
        'skip_rows' ?: <true>
        'set_missing_cols' ?: ( col<str>+ )
    }*
)
'set_env' ?: (
    {
        'name' : <str>
        'value' : <str>
    }*
)
'journaling' ?: <bool>
'finish_after_cycle' ?: <true>
'expiry_date' ?: <date_str_z>
'recv_expiry' ?: <date_str_z>
'ctrl_id' : <str>

Definition Interface

Click here to see all end points in this interface.

Fetch hub definition

GET /api/v6.1.0.4/hubs/{hub}/definition

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Modify scope or parameters of action

POST /api/v6.1.0.4/hubs/{hub}/definition/action_modify

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Action does not exist

Required 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.4/hubs/{hub}/definition/action_replace

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Action does not exist

Required 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.4/hubs/{hub}/definition/change/events

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Fetch channels from hub definition

GET /api/v6.1.0.4/hubs/{hub}/definition/channels

Query 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 fetched
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

### Add channel

POST /api/v6.1.0.4/hubs/{hub}/definition/channels

No 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 Created
STATUS 400 Bad Request: Channel already exists

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Definition_Change


'delete_channel' : {
    'channel' : <ident>
}

### Fetch channel from hub definition

GET /api/v6.1.0.4/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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required Permissions

ReadOnly access level on hub

### Modify channel

PATCH /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'description' : <str>`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request

Required 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.4/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 Content
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/definition/channels/{channel}/actions

Query 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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required Permissions

ReadOnly access level on hub

### Add channel actions

PATCH /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}/actions

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/actions

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/actions_delete

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/loc_groups

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:	`groupname<str> : { 'members' ?: ( loc<str> ) }`

HTTP Status Codes

STATUS 200 OK: Location groups fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required Permissions

ReadOnly access level on hub

### Add location group

POST /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}/loc_groups

No 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 Created
STATUS 400 Bad Request: Location group already exists
STATUS 404 Not Found: Channel does not exist

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required 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.4/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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required Permissions

ReadOnly access level on hub

### Add or replace location group

PUT /api/v6.1.0.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members

No 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:	`loc<str>*`

HTTP Status Codes

STATUS 200 OK: Location group members fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required Permissions

ReadOnly access level on hub

### Add location group members or move members from other location groups in channel

PATCH /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members

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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members

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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members_delete

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or location group does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/rename

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'new_name' : <ident>`
No extra response headers
No response body

HTTP Status Codes

STATUS 201 Created
STATUS 400 Bad Request: New location group already exists
STATUS 404 Not Found: Channel or old location group does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/rename

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'new_name' : <ident>`
No extra response headers
No response body

HTTP Status Codes

STATUS 201 Created
STATUS 400 Bad Request: New channel already exists
STATUS 404 Not Found: Old channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables

Query 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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required Permissions

ReadOnly access level on hub

### Add and replace tables

PATCH /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}/tables

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables

No 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 Created
STATUS 400 Bad Request: Table already exists
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or table does not exist

Required 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.4/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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or table does not exist

Required Permissions

ReadOnly access level on hub

### Modify table

PATCH /api/v6.1.0.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols

No 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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or table does not exist

Required Permissions

ReadOnly access level on hub

### Add and replace columns

PATCH /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or table does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or table does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols_delete

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'cols' : ( col<str>* )`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel or table does not exist

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Definition_Change


'delete_cols' : {
    'channel' : <ident>
    'table' : <ident>
    'cols' : ( <str>+ )
}

Rename table

POST /api/v6.1.0.4/hubs/{hub}/definition/channels/{channel}/tables/{table}/rename

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'new_name' : <ident>`
No extra response headers
No response body

HTTP Status Codes

STATUS 201 Created
STATUS 400 Bad Request: New table already exists
STATUS 404 Not Found: Channel or old table does not exist

Required 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.4/hubs/{hub}/definition/channels/{channel}/tables_delete

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Channel does not exist

Required 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.4/hubs/{hub}/definition/hub_actions

Query 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 fetched
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

### Add hub actions

PATCH /api/v6.1.0.4/hubs/{hub}/definition/hub_actions

No 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 Content
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/definition/hub_actions

No 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 Content
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/definition/hub_actions_delete

No 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 Content
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/definition/import

No 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' '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 OK
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/definition/import/analyze

No 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Events

Creates no events.

Fetch locations from hub definition

GET /api/v6.1.0.4/hubs/{hub}/definition/locs

Query 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 fetched
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

### Add location

POST /api/v6.1.0.4/hubs/{hub}/definition/locs

No 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 Created
STATUS 400 Bad Request: Location already exists

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required Permissions

ReadOnly access level on hub

### Add or replace location

PUT /api/v6.1.0.4/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 Content
STATUS 400 Bad Request

Required 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.4/hubs/{hub}/definition/locs/{loc}/actions

Query 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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required Permissions

ReadOnly access level on hub

### Add location actions

PATCH /api/v6.1.0.4/hubs/{hub}/definition/locs/{loc}/actions

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/hubs/{hub}/definition/locs/{loc}/actions

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/hubs/{hub}/definition/locs/{loc}/actions_delete

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/hubs/{hub}/definition/locs/{loc}/copy

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'new_name' : <ident>`
No extra response headers
No response body

HTTP Status Codes

STATUS 201 Created
STATUS 400 Bad Request: New location already exists
STATUS 404 Not Found: Old location does not exist

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Definition_Change


'add_loc' : {
    'loc' : <ident>
    'props' : ( <str>+ )
    'actions' ?: ( <ident>+ )
}

Fetch location properties from hub definition

GET /api/v6.1.0.4/hubs/{hub}/definition/locs/{loc}/props

No 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 fetched
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required Permissions

ReadOnly access level on hub

### Modify location properties

PATCH /api/v6.1.0.4/hubs/{hub}/definition/locs/{loc}/props

No 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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/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 Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required 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.4/hubs/{hub}/definition/locs/{loc}/props_delete

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'props' : ( <str>* )`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request
STATUS 404 Not Found: Location does not exist

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Definition_Change


'delete_loc_props' : {
    'loc' : <ident>
    'props' : ( <str>+ )
}

Rename location

POST /api/v6.1.0.4/hubs/{hub}/definition/locs/{loc}/rename

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'new_name' : <ident>`
No extra response headers
No response body

HTTP Status Codes

STATUS 201 Created
STATUS 400 Bad Request: New location already exists
STATUS 404 Not Found: Old location does not exist

Required Permissions

ReadWrite access level on hub

Events

Creates the following event

Definition_Change


'rename_loc' : {
    'loc' : <ident>
    'new_name' : <ident>
}

Encryption Interface

Click here to see all end points in this interface.

Create new encryption wallet

POST /api/v6.1.0.4/wallet

No query parameters
Request headers prototype:	`X-Hvr-Classified-Transport-Key : <str>`
Request body is JSON. Prototype:	`'props' : { prop<str> *: value<typeof_wallet_prop> } 'password' ?: <str>`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates one or more of the following events

Reencrypt_Secrets	`'new_encryption_key_sequence' ?: <int> 'force' ?: <bool>`
Wallet_Create	`'props' : { prop<str> *: value<typeof_wallet_prop> }`

Change reference to existing wallet

POST /api/v6.1.0.4/wallet/change

No query parameters
Request headers prototype:	`X-Hvr-Classified-Transport-Key : <str>`
Request body is JSON. Prototype:	`'props' ?: { prop<str> *: value<null> \| <typeof_wallet_prop> } 'password' ?: <str>`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request: No wallet configured

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates the following event

Wallet_Change


'props_after' ?: {
    prop<str> *: value<null> | <typeof_wallet_prop>
}
'props_before' ?: {
    prop<str> *: value<typeof_wallet_prop>
}
'password_changed' ?: <bool>

Disable encryption wallet

POST /api/v6.1.0.4/wallet/disable

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'force' ?: <bool>`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request: No wallet configured or already disabled

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates one or more of the following events

Reencrypt_Secrets	`'new_encryption_key_sequence' ?: <int> 'force' ?: <bool>`
Wallet_Disable	`'force' ?: <bool>`

Delete historical encryption keys

POST /api/v6.1.0.4/wallet/key_history_delete

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'before_key_sequence' ?: <int> 'before_rotation_tstamp' ?: <date_str_z>`
No extra response headers
Response body is JSON. Prototype:	`'key_history_deleted' : <int>`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request: No wallet configured

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates the following event

Wallet_Key_History_Delete


'before_key_sequence' ?: <int>
'before_rotation_tstamp' ?: <date_str_z>
'key_history_deleted' : <int>

Rotate encryption keys

POST /api/v6.1.0.4/wallet/key_rotate

No query parameters
No extra request headers
No request body
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request: No wallet configured

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates one or more of the following events

Reencrypt_Secrets	`'new_encryption_key_sequence' ?: <int> 'force' ?: <bool>`
Wallet_Key_Rotation	`'new_encryption_key_sequence' ?: <int>`

Migrate to a new wallet configuration gracefully

POST /api/v6.1.0.4/wallet/migrate

No query parameters
Request headers prototype:	`X-Hvr-Classified-Transport-Key : <str>`
Request body is JSON. Prototype:	`'props' : { prop<str> *: value<typeof_wallet_prop> } 'password' ?: <str> 'rotate_encryption_key' ?: <bool>`
No extra response headers
No response body

HTTP Status Codes

STATUS 204 No Content
STATUS 400 Bad Request: No wallet configured

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates one or more of the following events

Reencrypt_Secrets


'new_encryption_key_sequence' ?: <int>
'force' ?: <bool>

Wallet_Migrate


'props_after' : {
    prop<str> *: value<null> | <typeof_wallet_prop>
}
'props_before' ?: {
    prop<str> *: value<typeof_wallet_prop>
}
'new_encryption_key_sequence' ?: <int>

Get wallet properties

GET /api/v6.1.0.4/wallet/props

Query 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_wallet_prop>`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request: No wallet configured

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Continue previous re-encryption operation

POST /api/v6.1.0.4/wallet/reencrypt_continue

No query parameters
No extra request headers
Request body is JSON. Prototype:	`'force' ?: <bool>`
No extra response headers
No response body

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request

Required Permissions

SysAdmin access level
Available while Setup Mode is active.

Events

Creates the following event

Reencrypt_Secrets


'new_encryption_key_sequence' ?: <int>
'force' ?: <bool>

Event Interface

Click here to see all end points in this interface.

Get all unique channels from hvr_event

GET /api/v6.1.0.4/hubs/{hub}/event_channels

Query 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 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Get all unique locations from hvr_event

GET /api/v6.1.0.4/hubs/{hub}/event_locs

Query 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:	`loc<ident> *: num<int>`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Get all unique event types from hvr_event

GET /api/v6.1.0.4/hubs/{hub}/event_types

Query 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:	`type<str> *: num<int>`

HTTP Status Codes

STATUS 200 OK
STATUS 400 Bad Request

Required Permissions

ReadOnly access level on hub

Fetch event(s)

GET /api/v6.1.0.4/hubs/{hub}/events

Query 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>
'fetch_repos_events' ?: <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>