container_mgr_list_scoped

Back to SOAP Architecture Method Reference

Description

The container_mgr_list_scoped method narrows folder list results.

Note: Avoid confusing "scoping" as we use the term in Broadsign Control, with "scoping" as we use the term in Broadsign Control API. In Broadsign Control, "scoping" describes the limiting of what users can see (see Scoping). In Broadsign Control API, "scoping" describes the narrowing of results of certain "list" operations.

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the folder. bstypes:ResourceId R
name The name of the folder. string R
active Indicates whether the resource is in an active or inactive state. Boolean R
container_id The unique ID# of the parent folder, if applicable. bstypes:ResourceId R
domain_id The unique ID# of your domain. bstypes:ResourceId R
group_id Indicates the resource type for folder scoping:
  • 0 = Content
  • 2 = Host (Player)
  • 3 = Reservation/Campaign
  • 4 = Criteria
  • 5 = Category
  • 6 = Location (Edge Server)
  • 8 = Display Unit
  • 15 = Configuration Profile
  • 16 = Media Package
  • 17 = Order
  • 19 = Event
  • 20 = Loop Policy
  • 22 = Group
  • 23 = User
  • 24 = Customer
  • 26 = Display Type
 bstypes:ContainerGroup R
parent_id The unique ID# of the parent resource. bstypes:ResourceId R
parent_resource_type The parent resource type. string R

Parameters

Parameter Description Type Required (R) or Optional (O)
domain_id The unique ID# of your domain. bstypes:ResourceId R
parent_container_ids The unique ID# or #s of folders on your domain, used to scope your results. bstypes:ResourceId R