Availability

Breeze 5

Description

Returns information about all objects (SCOs) on a licensed Adobe Connect Server or in a Adobe Connect hosted account. The object types returned include archive, attachment, authorware, captivate, course, curriculum, external-event, flv, image, meeting, presentation, and swf.

Because the response is likely to be large, use filters to limit it. For example, to return a list of all meetings on the server, filter on the type field:

 http://example.com/api/xml?action=report-bulk-objects&filter-type=meeting

Request URL

 http://server_name/api/xml 
     ?action=report-bulk-objects 
     &filter-definition=value 
     &sort-definition=value 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

filter-definition

Filter definition

N

A filter to reduce the volume of the response.

sort-definition

Sort definition

N

A sort to return results in a certain sequence.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

You can filter or sort the response on any element or attribute it contains.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code=allowedValue />  
     <report-bulk-objects> 
         <row sco-id=integer type=allowedValue> 
             <url>string</url>  
             <name>string</name> 
             <date-created>datetime</date-created>  
             <date-end>datetime</date-end>  
             <date-modified>datetime</date-modified>  
             <description>datetime</description> 
         </row> 
         ... 
     </report-bulk-objects> 
 </results>

Response values

Element

Attribute

Type

Description

results

Container

All results the action returns.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

report-bulk-objects

Container

The entire list of SCOs on the server; or, if a filter is used, the entire list of SCOs that matches the filter.

row

Container

Details about one SCO.

sco-id

BIGINT

The unique ID of the SCO.

type

Allowed value

The type of SCO (see type).

url

String

The unique identifier of the training SCO, placed in the URL after the domain name.

name

String

The name assigned to the SCO.

date-created

Datetime

The date the SCO was created. For a meeting, the date and time the meeting starts.

date-end

Datetime

If the SCO is a meeting or event, the date it ended.

date-modified

Datetime

The date the SCO was last updated.

description

String

The description of the SCO.

Sample request

 http://example.com/api/xml?action=report-bulk-objects&filter-type=meeting 
     &filter-gt-date-created=2006-06-01

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-bulk-objects> 
         <row sco-id="2006778715" type="meeting"> 
             <url>/online/</url>  
             <name>Designing Online Courses</name>  
             <date-created>2006-06-28T14:15:00.000-07:00</date-created>  
             <date-end>2006-06-28T14:30:00.000-07:00</date-end>  
             <date-modified>2006-07-13T14:57:54.150-07:00</date-modified>  
         </row> 
         ... 
     </report-bulk-objects> 
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy