Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Beehive Development Kit » All Representations » assignedRole
Contents

Overview

The AssignedRole Entity.

An AssignedRole assigns a RoleDefinition to a Scope and set of Accessors. AssignedRoles are always enabled if the RoleDefinition is marked as 'AlwaysEnabled'. If not AlwaysEnabled the AssignedRole can be enabled through methods on the UserContext.

The following specifies which attributes are loaded when each Projection type is used to load an AssignedRole snapshot:

Projection.EMPTY loads the following:

Projection.BASIC loads the Projection.EMPTY fields and the following: Projection.META loads Projection.Empty and Projection.BASIC fields and the following:

Projection.FULL does not load any additional fields.

The AssignedRole's LocalACL (LACL) is managed using an AccessControlFieldsUpdater.

The AssignedRole's Accessors are managed using an AssignedRoleUpdater.

The AssignedRole snapshot and the data it contains are immutable.

Members

Name Type Required Description

accessors

baseAccessor[]
Returns the Accessors for which the AssignedScope and RoleDefinition apply.

assignedScope

scope
Returns the Scope to which to assign the RoleDefinition for the set of Accessors.

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

collabId

beeId
CollabId of the snapshot

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

description

string
Returns the Description.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

roleDefinition

roleDefinition
Returns the RoleDefinition being assigned to a Scope and set of Accessors.

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

Hierarchy

Inherits From

Applied Markers

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:assignedRole xsi:type="obh:assignedRole" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:accessors>your_baseAccessor_0</obh:accessors>
        <obh:accessors>your_baseAccessor_1</obh:accessors>
        <obh:accessors>your_baseAccessor_2</obh:accessors>
         <obh:assignedScope>your_scope_0</obh:assignedScope>
         <obh:attachedMarkers>your_marker_0</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_1</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_2</obh:attachedMarkers>
         <obh:attachedReminders>your_reminder_0</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_1</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_2</obh:attachedReminders>
         <obh:attachedSubscriptions>your_subscription_0</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_1</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_2</obh:attachedSubscriptions>
         <obh:collabId>your_beeId_0</obh:collabId>
         <obh:createdOn>your_dateTime_0</obh:createdOn>
         <obh:creator>your_actor_0</obh:creator>
         <obh:deleted>your_boolean_0</obh:deleted>
         <obh:description>your_string_0</obh:description>
         <obh:modifiedBy>your_actor_0</obh:modifiedBy>
         <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
         <obh:name>your_string_0</obh:name>
         <obh:parent>your_entity_0</obh:parent>
         <obh:roleDefinition>your_roleDefinition_0</obh:roleDefinition>
         <obh:snapshotId>your_string_0</obh:snapshotId>
 </obh:assignedRole>

JSON Example

(show inherited members)

{
    "beeType":"assignedRole",
        "accessors":[
            { your_{http://www.oracle.com/beehive}accessors_as_baseAccessor0 },
            { your_{http://www.oracle.com/beehive}accessors_as_baseAccessor1 },
            { your_{http://www.oracle.com/beehive}accessors_as_baseAccessor2 }
        ],
         "assignedScope":{ your_{http://www.oracle.com/beehive}assignedScope_as_scope0 },
         "attachedMarkers":[
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2 }
        ],
         "attachedReminders":[
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2 }
        ],
         "attachedSubscriptions":[
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2 }
        ],
         "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
         "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
         "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
         "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
         "description":"your_{http://www.oracle.com/beehive}description_as_string0",
         "modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0 },
         "modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
         "name":"your_{http://www.oracle.com/beehive}name_as_string0",
         "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
         "roleDefinition":{ your_{http://www.oracle.com/beehive}roleDefinition_as_roleDefinition0 },
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
 }

XML Schema


<xs:complexType final="extension restriction" name="assignedRole">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="accessors" nillable="true" type="tns:baseAccessor"/>
                <xs:element minOccurs="0" name="assignedScope" type="tns:scope"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" ref="tns:roleDefinition"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to assignedRole

Referenced By Resources

Usage Resource Method
Response Assigned Role Create
Response Assigned Role List
Response Assigned Role Read
Response Assigned Role Read Batch
Request Assigned Role Read Batch
Response Assigned Role Update

Referenced By Representaions

Oracle Logo
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices