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

Contents

Overview

Members

Name Type Required Description

actor

beeId<actor>

Returns the handle to the actor.

actorName

string

Returns the actor name.

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

auditTime

dateTime

Returns the audit time as java.util.Date.

auxInfo

auditInfoMap

Returns the auxiliary information.

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

clientAddress

string

Returns the client address.

clientAuxInfo

auditInfoMap

clientInfo

string

Returns the client optional information.

clientName

string

Returns the client name.

clientOS

string

Returns the client OS.

clientType

string

Returns the client type (e.g. WEB, IMAP, etc).

collabId

beeId

CollabId of the snapshot

container

beeId<entity>

Returns the parent of the content.

containerName

string

Gets the name of the parent.

content

beeId<Identifiable>

Returns the audited content.

contentName

string

Gets the audited content name.

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.

effectiveActor

beeId<actor>

Returns the handle to the effective actor.

effectiveActorName

string

Returns the effective actor name.

eventName

string

eventStatus

string

Returns the status of the event.

locale

string

logonProtocol

string

Returns the client logon protocol.

logonSessionId

string

Returns the logon session identifier.

logonTime

dateTime

Returns the logon time as java.util.Date.

logonType

string

Returns the client logon type.

messageText

string

Returns the message text.

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.

policies

beeId[]

policyNames

string[]

Returns policy names.

principal

beeId<principal>

Returns the handle to the active principal.

principalName

string

Gets the active principal name.

principalType

string

Returns the active principal type.

properties

collabProperties

The properties of the artifact that are shared among all the actors

serviceName

string

Returns service name.

snapshotId

string

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

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

viewer

actor

The actor for which this artifact snapshot was loaded. All the artifact viewer properties in this snapshot are loaded for this actor.

viewerProperties

collabProperties

The viewer properties of the artifact that are private to loading actor

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:auditRecord xsi:type="obh:auditRecord" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:actor>your_beeId_0</obh:actor>
        <obh:actorName>your_string_0</obh:actorName>
        <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:auditTime>your_dateTime_0</obh:auditTime>
        <obh:auxInfo>your_auditInfoMap_0</obh:auxInfo>
        <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:clientAddress>your_string_0</obh:clientAddress>
        <obh:clientAuxInfo>your_auditInfoMap_0</obh:clientAuxInfo>
        <obh:clientInfo>your_string_0</obh:clientInfo>
        <obh:clientName>your_string_0</obh:clientName>
        <obh:clientOS>your_string_0</obh:clientOS>
        <obh:clientType>your_string_0</obh:clientType>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:container>your_beeId_0</obh:container>
        <obh:containerName>your_string_0</obh:containerName>
        <obh:content>your_beeId_0</obh:content>
        <obh:contentName>your_string_0</obh:contentName>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:effectiveActor>your_beeId_0</obh:effectiveActor>
        <obh:effectiveActorName>your_string_0</obh:effectiveActorName>
        <obh:eventName>your_string_0</obh:eventName>
        <obh:eventStatus>your_string_0</obh:eventStatus>
        <obh:locale>your_string_0</obh:locale>
        <obh:logonProtocol>your_string_0</obh:logonProtocol>
        <obh:logonSessionId>your_string_0</obh:logonSessionId>
        <obh:logonTime>your_dateTime_0</obh:logonTime>
        <obh:logonType>your_string_0</obh:logonType>
        <obh:messageText>your_string_0</obh:messageText>
        <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:policies>your_beeId_0</obh:policies>
        <obh:policies>your_beeId_1</obh:policies>
        <obh:policies>your_beeId_2</obh:policies>
        <obh:policyNames>your_string_0</obh:policyNames>
        <obh:policyNames>your_string_1</obh:policyNames>
        <obh:policyNames>your_string_2</obh:policyNames>
        <obh:principal>your_beeId_0</obh:principal>
        <obh:principalName>your_string_0</obh:principalName>
        <obh:principalType>your_string_0</obh:principalType>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:serviceName>your_string_0</obh:serviceName>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewer>your_actor_0</obh:viewer>
        <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
</obh:auditRecord>

JSON Example

(show inherited members)

{
    "beeType":"auditRecord",
        "actor":{ your_{http://www.oracle.com/beehive}actor_as_beeId0 },
        "actorName":"your_{http://www.oracle.com/beehive}actorName_as_string0",
        "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 }
        ],
        "auditTime":"your_{http://www.oracle.com/beehive}auditTime_as_dateTime0",
        "auxInfo":{ your_{http://www.oracle.com/beehive}auxInfo_as_auditInfoMap0 },
        "bonds":[
            { your_{http://www.oracle.com/beehive}bonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond2 }
        ],
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "clientAddress":"your_{http://www.oracle.com/beehive}clientAddress_as_string0",
        "clientAuxInfo":{ your_{http://www.oracle.com/beehive}clientAuxInfo_as_auditInfoMap0 },
        "clientInfo":"your_{http://www.oracle.com/beehive}clientInfo_as_string0",
        "clientName":"your_{http://www.oracle.com/beehive}clientName_as_string0",
        "clientOS":"your_{http://www.oracle.com/beehive}clientOS_as_string0",
        "clientType":"your_{http://www.oracle.com/beehive}clientType_as_string0",
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "container":{ your_{http://www.oracle.com/beehive}container_as_beeId0 },
        "containerName":"your_{http://www.oracle.com/beehive}containerName_as_string0",
        "content":{ your_{http://www.oracle.com/beehive}content_as_beeId0 },
        "contentName":"your_{http://www.oracle.com/beehive}contentName_as_string0",
        "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,
        "effectiveActor":{ your_{http://www.oracle.com/beehive}effectiveActor_as_beeId0 },
        "effectiveActorName":"your_{http://www.oracle.com/beehive}effectiveActorName_as_string0",
        "eventName":"your_{http://www.oracle.com/beehive}eventName_as_string0",
        "eventStatus":"your_{http://www.oracle.com/beehive}eventStatus_as_string0",
        "locale":"your_{http://www.oracle.com/beehive}locale_as_string0",
        "logonProtocol":"your_{http://www.oracle.com/beehive}logonProtocol_as_string0",
        "logonSessionId":"your_{http://www.oracle.com/beehive}logonSessionId_as_string0",
        "logonTime":"your_{http://www.oracle.com/beehive}logonTime_as_dateTime0",
        "logonType":"your_{http://www.oracle.com/beehive}logonType_as_string0",
        "messageText":"your_{http://www.oracle.com/beehive}messageText_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 },
        "policies":[
            { your_{http://www.oracle.com/beehive}policies_as_beeId0 },
            { your_{http://www.oracle.com/beehive}policies_as_beeId1 },
            { your_{http://www.oracle.com/beehive}policies_as_beeId2 }
        ],
        "policyNames":[
            "your_{http://www.oracle.com/beehive}policyNames_as_string0",
            "your_{http://www.oracle.com/beehive}policyNames_as_string1",
            "your_{http://www.oracle.com/beehive}policyNames_as_string2"
        ],
        "principal":{ your_{http://www.oracle.com/beehive}principal_as_beeId0 },
        "principalName":"your_{http://www.oracle.com/beehive}principalName_as_string0",
        "principalType":"your_{http://www.oracle.com/beehive}principalType_as_string0",
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "serviceName":"your_{http://www.oracle.com/beehive}serviceName_as_string0",
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "viewer":{ your_{http://www.oracle.com/beehive}viewer_as_actor0 },
        "viewerProperties":{ your_{http://www.oracle.com/beehive}viewerProperties_as_collabProperties0 }
}

XML Schema


<xs:complexType name="auditRecord">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element minOccurs="0" name="actor" type="tns:beeId"/>
                <xs:element minOccurs="0" name="actorName" type="xs:string"/>
                <xs:element minOccurs="0" name="auditTime" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="auxInfo" type="tns:auditInfoMap"/>
                <xs:element minOccurs="0" name="clientAddress" type="xs:string"/>
                <xs:element minOccurs="0" name="clientAuxInfo" type="tns:auditInfoMap"/>
                <xs:element minOccurs="0" name="clientInfo" type="xs:string"/>
                <xs:element minOccurs="0" name="clientName" type="xs:string"/>
                <xs:element minOccurs="0" name="clientOS" type="xs:string"/>
                <xs:element minOccurs="0" name="clientType" type="xs:string"/>
                <xs:element minOccurs="0" name="container" type="tns:beeId"/>
                <xs:element minOccurs="0" name="containerName" type="xs:string"/>
                <xs:element minOccurs="0" name="content" type="tns:beeId"/>
                <xs:element minOccurs="0" name="contentName" type="xs:string"/>
                <xs:element minOccurs="0" name="effectiveActor" type="tns:beeId"/>
                <xs:element minOccurs="0" name="effectiveActorName" type="xs:string"/>
                <xs:element minOccurs="0" name="eventName" type="xs:string"/>
                <xs:element minOccurs="0" name="eventStatus" type="xs:string"/>
                <xs:element minOccurs="0" name="locale" type="xs:string"/>
                <xs:element minOccurs="0" name="logonProtocol" type="xs:string"/>
                <xs:element minOccurs="0" name="logonSessionId" type="xs:string"/>
                <xs:element minOccurs="0" name="logonTime" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="logonType" type="xs:string"/>
                <xs:element minOccurs="0" name="messageText" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="policies" nillable="true" type="tns:beeId"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="policyNames" nillable="true" type="xs:string"/>
                <xs:element minOccurs="0" name="principal" type="tns:beeId"/>
                <xs:element minOccurs="0" name="principalName" type="xs:string"/>
                <xs:element minOccurs="0" name="principalType" type="xs:string"/>
                <xs:element minOccurs="0" name="serviceName" type="xs:string"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to auditRecord

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations