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

Contents

Overview

Represents a snapshot of a TodoParticipant object.

Members

Name Type Required Description

address

string

Return an alternative address of the internal participant or the address of the external participant.

assigneeRepliedOn

dateTime

Get the Assignee RepliedOn attribute.

Note that this attribute is set by the assignee, and is visible only for TodoParticipant in a Todo. For a TodoParticipant in an Assignment, this method will always return null.

assigneeWorkflowTaskId

string

Get the Assignee Workflow TaskId attribute of the TodoParticipant.

billingInfo

string

Get the Assignee BillingInfo attribute.

Note that this attribute is set by the assignee, and is visible only for TodoParticipant in a Todo. For a TodoParticipant in an Assignment, this method will always return null.

comment

string

Get the Comment attribute of the TodoParticipant.

Note that this attribute is set by the assignee, and is visible only for TodoParticipant in a Todo. For a TodoParticipant in an Assignment, this method will always return null.

completed

dateTime

Get the Completed attribute of the TodoParticipant object.

deliveryChannels

participantDeliveryChannel[]

Get the DeliveryChannels attribute of the TodoParticipant.

This represents how the participant is to be notified of their assignment. Note that this is seperate from the DeliveryChannels that User Subscription Service uses to send notifications, and is meant for participants that User Subscription does not service (i.e. external participants). Also note, that this attribute is always an empty set when the participant is returned in an assignment.

deliveryResults

participantDeliveryResult[]

Get the ParticipantDeliveryResults.

directlyInvited

boolean

Get the DirectlyInvited attribute of the TodoParticipant object.

mileage

string

Get the Assignee Mileage attribute.

Note that this attribute is set by the assignee, and is visible only for TodoParticipant in a Todo. For a TodoParticipant in an Assignment, this method will always return null.

name

string

Return the name of the Participant

participant

anyType

(constrained to Addressable)

Return the Addressable of the participant.

participantStatus

todoParticipantStatus

percentComplete

int

Get the PercentComplete attribute of the TodoParticipant object.

properties

collabProperties

Get the Properties attribute of the TodoParticipant object.

role

participantRole

Get the Role attribute of the TodoParticipant object.

rsvp

boolean

Get the RSVP attribute of the TodoParticipant object.

status

todoParticipantStatus

timeAllocated

long

Get the Assignee TimeAllocated attribute.

Note that this attribute is set by the assignee, and is visible only for TodoParticipant in a Todo. For a TodoParticipant in an Assignment, this method will always return null.

timeSpent

long

Get the Assignee TimeSpent attribute.

Note that this attribute is set by the assignee, and is visible only for TodoParticipant in a Todo. For a TodoParticipant in an Assignment, this method will always return null.

Hierarchy

Inherits From

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:todoParticipant xsi:type="obh:todoParticipant" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:address>your_string_0</obh:address>
        <obh:assigneeRepliedOn>your_dateTime_0</obh:assigneeRepliedOn>
        <obh:assigneeWorkflowTaskId>your_string_0</obh:assigneeWorkflowTaskId>
        <obh:billingInfo>your_string_0</obh:billingInfo>
        <obh:comment>your_string_0</obh:comment>
        <obh:completed>your_dateTime_0</obh:completed>
        <obh:deliveryChannels>your_participantDeliveryChannel_0</obh:deliveryChannels>
        <obh:deliveryChannels>your_participantDeliveryChannel_1</obh:deliveryChannels>
        <obh:deliveryChannels>your_participantDeliveryChannel_2</obh:deliveryChannels>
        <obh:deliveryResults>your_participantDeliveryResult_0</obh:deliveryResults>
        <obh:deliveryResults>your_participantDeliveryResult_1</obh:deliveryResults>
        <obh:deliveryResults>your_participantDeliveryResult_2</obh:deliveryResults>
        <obh:directlyInvited>your_boolean_0</obh:directlyInvited>
        <obh:mileage>your_string_0</obh:mileage>
        <obh:name>your_string_0</obh:name>
        <obh:participant>your_anyType_0</obh:participant>
        <obh:participantStatus>your_todoParticipantStatus_0</obh:participantStatus>
        <obh:percentComplete>your_int_0</obh:percentComplete>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:role>your_participantRole_0</obh:role>
        <obh:rsvp>your_boolean_0</obh:rsvp>
        <obh:status>your_todoParticipantStatus_0</obh:status>
        <obh:timeAllocated>your_long_0</obh:timeAllocated>
        <obh:timeSpent>your_long_0</obh:timeSpent>
</obh:todoParticipant>

JSON Example

(show inherited members)

{
    "beeType":"todoParticipant",
        "address":"your_{http://www.oracle.com/beehive}address_as_string0",
        "assigneeRepliedOn":"your_{http://www.oracle.com/beehive}assigneeRepliedOn_as_dateTime0",
        "assigneeWorkflowTaskId":"your_{http://www.oracle.com/beehive}assigneeWorkflowTaskId_as_string0",
        "billingInfo":"your_{http://www.oracle.com/beehive}billingInfo_as_string0",
        "comment":"your_{http://www.oracle.com/beehive}comment_as_string0",
        "completed":{ your_{http://www.oracle.com/beehive}completed_as_dateTime0 },
        "deliveryChannels":[
            { your_{http://www.oracle.com/beehive}deliveryChannels_as_participantDeliveryChannel0 },
            { your_{http://www.oracle.com/beehive}deliveryChannels_as_participantDeliveryChannel1 },
            { your_{http://www.oracle.com/beehive}deliveryChannels_as_participantDeliveryChannel2 }
        ],
        "deliveryResults":[
            { your_{http://www.oracle.com/beehive}deliveryResults_as_participantDeliveryResult0 },
            { your_{http://www.oracle.com/beehive}deliveryResults_as_participantDeliveryResult1 },
            { your_{http://www.oracle.com/beehive}deliveryResults_as_participantDeliveryResult2 }
        ],
        "directlyInvited":your_{http://www.oracle.com/beehive}directlyInvited_as_boolean0,
        "mileage":"your_{http://www.oracle.com/beehive}mileage_as_string0",
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "participant":"your_{http://www.oracle.com/beehive}participant_as_anyType0",
        "participantStatus":{ your_{http://www.oracle.com/beehive}participantStatus_as_todoParticipantStatus0 },
        "percentComplete":your_{http://www.oracle.com/beehive}percentComplete_as_int0,
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "role":{ your_{http://www.oracle.com/beehive}role_as_participantRole0 },
        "rsvp":your_{http://www.oracle.com/beehive}rsvp_as_boolean0,
        "status":{ your_{http://www.oracle.com/beehive}status_as_todoParticipantStatus0 },
        "timeAllocated":your_{http://www.oracle.com/beehive}timeAllocated_as_long0,
        "timeSpent":your_{http://www.oracle.com/beehive}timeSpent_as_long0
}

XML Schema


<xs:complexType name="todoParticipant">
    <xs:complexContent>
        <xs:extension base="tns:baseParticipant">
            <xs:sequence>
                <xs:element minOccurs="0" name="assigneeRepliedOn" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="assigneeWorkflowTaskId" type="xs:string"/>
                <xs:element minOccurs="0" name="billingInfo" type="xs:string"/>
                <xs:element minOccurs="0" name="comment" type="xs:string"/>
                <xs:element minOccurs="0" name="completed" type="tns:dateTime"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="deliveryChannels" nillable="true" type="tns:participantDeliveryChannel"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="deliveryResults" nillable="true" type="tns:participantDeliveryResult"/>
                <xs:element name="directlyInvited" type="xs:boolean"/>
                <xs:element minOccurs="0" name="mileage" type="xs:string"/>
                <xs:element minOccurs="0" name="participantStatus" type="tns:todoParticipantStatus"/>
                <xs:element name="percentComplete" type="xs:int"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="role" type="tns:participantRole"/>
                <xs:element name="rsvp" type="xs:boolean"/>
                <xs:element minOccurs="0" name="status" type="tns:todoParticipantStatus"/>
                <xs:element minOccurs="0" name="timeAllocated" type="xs:long"/>
                <xs:element minOccurs="0" name="timeSpent" type="xs:long"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to todoParticipant

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations