content_mgr_list_scoped

Note: Each WSDL has a version number that increments independently of BroadSign Core. The parameters and return values on this page are for the most recent version. For more information, see Schema - About WSDL Versioning.

Back to API references

Description

The content_mgr_list_scoped method narrows content list results.

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

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the content on your domain. bstypes:ResourceId R
name The name of your resource. string R
active Whether or not the resource is in an active state. boolean R
container_id The unique ID# of the folder in which the content is stored (used to scope your list results). bstypes:ResourceId R
domain_id The unique ID# of your domain. bstypes:ResourceId R
originalfilename The original file name of your content. string R
mime The mime type of your content. Corresponds to the ad copy type in Broadsign Administrator:

  • Standard ad copy: jpg; png; mp4; etc.
  • Creator ad copy: x-creator
  • External source ad copy: (mime type will be blank; size will read “-1”)
  • Ticker ad copy: x-ticker
  • Web redirect ad copy: html
  • HTML package: x-html-package
  • Application ad copy: zip
  • Video capture ad copy: x-video-capture
string R
parent_id The unique ID# of the content’s bundle. bstypes:ResourceId R
approval_status The approval status of the content:

  • 0 = New
  • 1 = Approved
bstypes:ContentApprovalStatus R
checksum2_type Indicates the type of checksum2 analysis:

  • 1 = crc32_full
bstypes:Checksum2Type R
checksum2 The value of the checksum analysis. string R
size The size of the content file. long R
archive_status The archive status of the conent:

  • 0 = Available
  • 1 = Archived
  • 2 = Archived from an inactive state
  • 3 = Archived from an active state
bstypes:ArchiveStatus R
archived_by The unique ID# of the user resource that archived the content. bstypes:ResourceId R
archived_on_utc The date and time, in UTC, on which the user archived the content. bstypes:SimpleDateTime R
approved_by_user_id The unique ID# of the user resource that approved the content. bstypes:ResourceId R
approved_on_utc The date and time, in UTC, on which the user archived the content. bstypes:SimpleDateTime R
external_id This field can be used to store external identifiers for this content in other systems, e.g., an external CMS or RCS selector. string R
archive_priority The priority status of the content for archiving:

  • 0 = Low
  • 1 = Normal
bstypes:ArchivePriority R
creation_user_id The unique ID# of the user that created the content. bstypes:ResourceId R
creation_tm The date and time of the content creation. bstypes:SimpleDateTime R
attributes Information on the file, which will vary according to mime type. See List of Possible Attributes at bottom of page.
Note: Use newline separators between items in the string.
string R
feeds The source of any external feeds, e.g., Twitter. string R
bmb_host_id The unique ID# of the player resource used to fetch Broadsign Creator ad copy, if applicable. bstypes:ResourceId R

List of Possible Attributes (by Mime Type)

Mime Type Possible Attributes
avi duration
audio_codec
video_codec
height
width
keep_aspect_ratio
bmp duration
keep_aspect_ratio
divx duration
audio_codec
video_codec
height
width
keep_aspect_ratio
exe duration
f4v duration
keep_aspect_ratio
fla duration
flv duration
audio_codec
video_codec
height
width
volume_modifier
keep_aspect_ratio
gif duration
height
width
htm duration
html direct_url
show_scrollbars
jpeg height
width
jpg height
width
m2t duration
height
width
audio_codec
video_codec
m2v duration
height
width
video_codec
m4a duration
audio_codec
volume_modifier
m4v duration
keep_aspect_ratio
mht duration
mkv duration
keep_aspect_ratio
video_codec
mov duration
height
width
audio_codec
video_codec
keep_aspect_ratio
mp3 duration
audio_codec
mp4 duration
height
width
audio_codec
video_codec
keep_aspect_ratio
mpeg duration
height
width
audio_codec
video_codec
mpg duration
height
width
audio_codec
video_codec
keep_aspect_ratio
pls duration
volume_modifier
png duration
height
width
keep_aspect_ratio
swf duration
version
volume_modifier
product_hint
tif duration
keep_aspect_ratio
vob duration
height
width
audio_codec
video_codec
keep_aspect_ratio
webm duration
height
width
audio_codec
video_codec
keep_aspect_ratio
wma duration
audio_codec
wmv duration
width
height
audio_codec
video_codec
xap duration
volume_modifier
x-creator duration
volume_modifier
x-digital-tv duration
x-html-package duration
main_html_file_path
xml duration
x-ticker duration
x-video-capture duration
volume_modifier
zip duration
command_line_parameters
environment_variables
executable_path
run_as_admin
run_only_once