Bureaucrats, editor
1,487
edits
Changes
Jump to navigation
Jump to search
TVOpen Message Manager API Common Parameters (view source)
Revision as of 12:26, 30 April 2020
, 12:26, 30 April 2020Created page with "== COMMANDS COMMON PARAMETERS == {| class="wikitable" |- ! Name !! Description !! Parameter !! Mandatory !! Type !! Format |- | instance_id || Identifier of MIB instance || C..."
== COMMANDS COMMON PARAMETERS ==
{| class="wikitable"
|-
! Name !! Description !! Parameter !! Mandatory !! Type !! Format
|-
| instance_id || Identifier of MIB instance || Common || true || integer || int64
|-
| source_id || Unique identifier origin of commands<br>(GVP DataHuB, MiB, GAL BSS) || Common || true || integer || int64:<br>- 0 (youbora)<br>- 1 (mib)<br>- 2 (gal_bss)<br>- 3 (vrm proxy)
|-
| command_id || Unique identifier of commands (pattern: ^[A-Za-z0-9\\-_]+$) || Common || true || string || string (24 characters)
|-
| start_time || Start date command execution (in UTC) || Common || true || string || date (ISO-8601)
|-
| end_time || End date command execution (in UTC) || Common || true || string || date (ISO-8601)
|-
| device_type || Device type to send command || Common || true || string || values:<br>- 802 (iptv)<br>- 803 (ej: dth)<br>- 802,803
|-
| force_datahub_report || This parameter allows to receive report, in real time,<br>about the command execution || Common || false || boolean || boolean (True/False)
|-
| target_type || Type of segmentation applied || Common || true || string || enum:<br>- stb_id (sprayer)<br>- stb_list_file (sprayer)<br>- list_id (infopush)<br>- stb_model (infopush)<br>- subscription_id (infopush)<br>- region_id (infopush)<br>- all (infopush)
|-
| stb_id || Identifier of STB || Common || false || string || string (uuid)
|-
| stb_list_file || List of STB receivers || Common || false || file|| File in csv format with the list of<br>STB uuid's separated by comma
|-
| list_id || ID of a dynamic list of STB associated to a specific package name || Common || false || string || string
|-
| stb_model || Model of STB || Common || false || string || string
|-
| subscription_id || ID of MiB subscription || Common || false || string || string
|-
| region_id || Applied filter to all STBS of a region || Common || false || string || string
|}
{| class="wikitable"
|-
! Name !! Description !! Parameter !! Mandatory !! Type !! Format
|-
| instance_id || Identifier of MIB instance || Common || true || integer || int64
|-
| source_id || Unique identifier origin of commands<br>(GVP DataHuB, MiB, GAL BSS) || Common || true || integer || int64:<br>- 0 (youbora)<br>- 1 (mib)<br>- 2 (gal_bss)<br>- 3 (vrm proxy)
|-
| command_id || Unique identifier of commands (pattern: ^[A-Za-z0-9\\-_]+$) || Common || true || string || string (24 characters)
|-
| start_time || Start date command execution (in UTC) || Common || true || string || date (ISO-8601)
|-
| end_time || End date command execution (in UTC) || Common || true || string || date (ISO-8601)
|-
| device_type || Device type to send command || Common || true || string || values:<br>- 802 (iptv)<br>- 803 (ej: dth)<br>- 802,803
|-
| force_datahub_report || This parameter allows to receive report, in real time,<br>about the command execution || Common || false || boolean || boolean (True/False)
|-
| target_type || Type of segmentation applied || Common || true || string || enum:<br>- stb_id (sprayer)<br>- stb_list_file (sprayer)<br>- list_id (infopush)<br>- stb_model (infopush)<br>- subscription_id (infopush)<br>- region_id (infopush)<br>- all (infopush)
|-
| stb_id || Identifier of STB || Common || false || string || string (uuid)
|-
| stb_list_file || List of STB receivers || Common || false || file|| File in csv format with the list of<br>STB uuid's separated by comma
|-
| list_id || ID of a dynamic list of STB associated to a specific package name || Common || false || string || string
|-
| stb_model || Model of STB || Common || false || string || string
|-
| subscription_id || ID of MiB subscription || Common || false || string || string
|-
| region_id || Applied filter to all STBS of a region || Common || false || string || string
|}
