About principals, SCOs, and IDs
17
<cfhttpparam type="Cookie" name="BREEZESESSION" value="#loginCookie#">
</cfhttp>
In some other APIs, you can provide multiple sets of parameters. For example, the
group-
membership-update
API takes parameters named
group-id
,
principal-id,
and
is-member
.
To make multiple updates in a single call, you specify each of those parameters for principal and
group, and then specify them (using the same parameter names again) for another, and so on.
About principals, SCOs, and IDs
There are two basic kinds of entities in Breeze: principals and Shareable Content Objects (SCOs).
A
principal
is any entity that can have permissions that control how it interacts with SCOs. The
most common types of principals are user (a specific user) and group (a
group of users).
There are other types of principals, known as
Built-in groups
: Administrators, Authors, Training
Managers, Event Managers, Meeting Hosts, and Seminar Hosts.
You can create users and groups and modify their permissions. You can add users and groups to
Built-in groups, but you can’t modify the permissions of a Built-in group. For more information
about Built-in groups, see
Breeze Manager User Guide
.
A SCO is a Breeze document, such as a meeting or an event; folders are also SCOs. Breeze
includes the following SCO types:
Each principal and SCO has a unique ID number. When you call an API that uses an entity’s ID
as a parameter, the parameter name indicates what kind of entity the ID belongs to, but the ID
remains the same, regardless of the parameter name. Parameter names for IDs include
acl-id
,
folder-id
,
group-id
,
parent-acl-id
,
principal-id
,
sco-id
, and
user-id
.
For example, to update a user’s password, call the
user-update-pwd
API, and give the user’s ID
as the
user-id
parameter. To determine a user’s name, call the
principal-info
API, and give
the user’s ID as the
principal-id
parameter.
SCO
Description
content
A viewable file or collection of files uploaded to the Breeze server (for example,
an FLV file, a SWF file, or an image, pod, or HTML file).
curriculum
A Breeze curriculum.
event
A Breeze event.
folder
A folder on the server’s hard disk that contains Breeze content.
link
A reference to another SCO. These are used by curriculums to link to other
SCOs. When content is added to a curriculum, a link is created from the
curriculum to the content.
meeting
A Breeze meeting.
tree
The root of a folder hierarchy. A tree’s root is treated as an independent
hierarchy; you can’t determine the parent folder of a tree from inside the tree.
Содержание BREEZE 5
Страница 1: ...Breeze Integration Guide ...
Страница 40: ...40 Chapter 3 Common Tasks ...