relationship_mgr_list

Back to SOAP Architecture Method Reference

Description

The relationship_mgr_list method lists all relationships. A relationship is an association between an upgrade channel and a Players (Resource) or an Edge Servers (Resource). It could also be an association between a Media Packages and a Display Units.

Parameters

Parameter Description Type Required (R) or Optional (O)
domain_id The unique ID# of your domain. bstypes:ResourceId O

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of your relationship. bstypes:ResourceId R
active Indicates whether the resource is in an active or inactive state. boolean R
domain_id The unique ID# of your relationship. bstypes:ResourceId R
parent_id The unique ID# of either an upgrade channel or a media package. bstypes:ResourceId R
right_resource_id The unique ID# of either a player, an edge server or a display unit. bstypes:ResourceId R