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

Contents

Overview

Represent a Task.

Tasks are located in a TaskList container.

Members

Name Type Required Description

assignee

participant

Assignee that owns this copy of the task.

assigneeCompleted

dateTime

Time at which the Task was completed.

assigneeCompletedDateOnly

boolean

True if the "AssigneeCompleted" attribute refers to a date only value (time of day can be ignored).

assigneeDue

dateTime

Due time of the task.

assigneeDueDateOnly

boolean

True if the "AssigneeDue" attribute refers to a date only value (time of day can be ignored).

assigneeParticipantStatus

todoParticipantStatus

Participation status if the Assignee. When a new task is assigned to an assignee, this attribute is initialy set to NEEDS_ACTION. The assignee must update this attribute to inform the organizer if his assignment status.

assigneePercentComplete

int

AssigneePercentComplete attribute.

assigneePrimaryClientReminderTrigger

timedTrigger

Trigger of the primary client side reminder. The primary client reminder is the reminder managed, by calendar clients such as OBEO, Zimbra and the caldav based clients.

assigneePriority

priority

Priority of the task as defined by the assignee.

assigneeProperties

collabProperties

Properties private to this copy of the task.

assigneeStart

dateTime

Time at which the task must be started.

assigneeStartDateOnly

boolean

True if the "AssigneeStart" attribute refers to a date only value (time of day can be ignored).

assignmentOnly

boolean

True if the task is not the organizer's copy. When a task is created by the organizer, copies of the tasks are delivered to the participants' default tasklists.

The organizer's copy of the tasks has the element AssignmentOnly set to false, the other participant's have AssignmentOnly set to true.

If AssignmentOnly is set to true, then only the following elements may be updated:

  1. AssigneeCompleted
  2. AssigneeDue
  3. AssigneeParticipantStatis
  4. AssigneePercentComplete
  5. AssigneePrimaryClientReminder
  6. AssigneePriority
  7. AssigneeStart
  8. Sensitivity
The task's elements that are global to all the participants can only be updated in the organizer's copy of the task.

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

attachments

anyType[]

Attachments of the task.

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

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.

locationName

string

Name of the location associated with the task.

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

organizer

participant

Organizer/Initiator of the task.

parent

entity

The parent for this entity.

properties

collabProperties

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

sensitivity

sensitivity

Sensitivity of the task.

snapshotId

string

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

status

todoStatus

Status of the task.

textDescription

string

Description of the task in plain text format.

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

xhtmlFragmentDescription

string

Description of the meeting in xhtml fragment format.

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:task xsi:type="obh:task" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:assignee>your_participant_0</obh:assignee>
        <obh:assigneeCompleted>your_dateTime_0</obh:assigneeCompleted>
        <obh:assigneeCompletedDateOnly>your_boolean_0</obh:assigneeCompletedDateOnly>
        <obh:assigneeDue>your_dateTime_0</obh:assigneeDue>
        <obh:assigneeDueDateOnly>your_boolean_0</obh:assigneeDueDateOnly>
        <obh:assigneeParticipantStatus>your_todoParticipantStatus_0</obh:assigneeParticipantStatus>
        <obh:assigneePercentComplete>your_int_0</obh:assigneePercentComplete>
        <obh:assigneePrimaryClientReminderTrigger>your_timedTrigger_0</obh:assigneePrimaryClientReminderTrigger>
        <obh:assigneePriority>your_priority_0</obh:assigneePriority>
        <obh:assigneeProperties>your_collabProperties_0</obh:assigneeProperties>
        <obh:assigneeStart>your_dateTime_0</obh:assigneeStart>
        <obh:assigneeStartDateOnly>your_boolean_0</obh:assigneeStartDateOnly>
        <obh:assignmentOnly>your_boolean_0</obh:assignmentOnly>
        <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:attachments>your_anyType_0</obh:attachments>
        <obh:attachments>your_anyType_1</obh:attachments>
        <obh:attachments>your_anyType_2</obh:attachments>
        <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: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:locationName>your_string_0</obh:locationName>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:organizer>your_participant_0</obh:organizer>
        <obh:parent>your_entity_0</obh:parent>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:sensitivity>your_sensitivity_0</obh:sensitivity>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:status>your_todoStatus_0</obh:status>
        <obh:textDescription>your_string_0</obh:textDescription>
        <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:xhtmlFragmentDescription>your_string_0</obh:xhtmlFragmentDescription>
</obh:task>

JSON Example

(show inherited members)

{
    "beeType":"task",
        "assignee":{ your_{http://www.oracle.com/beehive}assignee_as_participant0 },
        "assigneeCompleted":"your_{http://www.oracle.com/beehive}assigneeCompleted_as_dateTime0",
        "assigneeCompletedDateOnly":your_{http://www.oracle.com/beehive}assigneeCompletedDateOnly_as_boolean0,
        "assigneeDue":"your_{http://www.oracle.com/beehive}assigneeDue_as_dateTime0",
        "assigneeDueDateOnly":your_{http://www.oracle.com/beehive}assigneeDueDateOnly_as_boolean0,
        "assigneeParticipantStatus":{ your_{http://www.oracle.com/beehive}assigneeParticipantStatus_as_todoParticipantStatus0 },
        "assigneePercentComplete":your_{http://www.oracle.com/beehive}assigneePercentComplete_as_int0,
        "assigneePrimaryClientReminderTrigger":{ your_{http://www.oracle.com/beehive}assigneePrimaryClientReminderTrigger_as_timedTrigger0 },
        "assigneePriority":{ your_{http://www.oracle.com/beehive}assigneePriority_as_priority0 },
        "assigneeProperties":{ your_{http://www.oracle.com/beehive}assigneeProperties_as_collabProperties0 },
        "assigneeStart":"your_{http://www.oracle.com/beehive}assigneeStart_as_dateTime0",
        "assigneeStartDateOnly":your_{http://www.oracle.com/beehive}assigneeStartDateOnly_as_boolean0,
        "assignmentOnly":your_{http://www.oracle.com/beehive}assignmentOnly_as_boolean0,
        "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 }
        ],
        "attachments":[
            "your_{http://www.oracle.com/beehive}attachments_as_anyType0",
            "your_{http://www.oracle.com/beehive}attachments_as_anyType1",
            "your_{http://www.oracle.com/beehive}attachments_as_anyType2"
        ],
        "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 },
        "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,
        "locationName":"your_{http://www.oracle.com/beehive}locationName_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",
        "organizer":{ your_{http://www.oracle.com/beehive}organizer_as_participant0 },
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "sensitivity":{ your_{http://www.oracle.com/beehive}sensitivity_as_sensitivity0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "status":{ your_{http://www.oracle.com/beehive}status_as_todoStatus0 },
        "textDescription":"your_{http://www.oracle.com/beehive}textDescription_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 },
        "xhtmlFragmentDescription":"your_{http://www.oracle.com/beehive}xhtmlFragmentDescription_as_string0"
}

XML Schema


<xs:complexType name="task">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element minOccurs="0" name="assignee" type="tns:participant"/>
                <xs:element minOccurs="0" name="assigneeCompleted" type="xs:dateTime"/>
                <xs:element name="assigneeCompletedDateOnly" type="xs:boolean"/>
                <xs:element minOccurs="0" name="assigneeDue" type="xs:dateTime"/>
                <xs:element name="assigneeDueDateOnly" type="xs:boolean"/>
                <xs:element minOccurs="0"
                    name="assigneeParticipantStatus" type="tns:todoParticipantStatus"/>
                <xs:element name="assigneePercentComplete" type="xs:int"/>
                <xs:element minOccurs="0"
                    name="assigneePrimaryClientReminderTrigger" type="tns:timedTrigger"/>
                <xs:element minOccurs="0" name="assigneePriority" type="tns:priority"/>
                <xs:element minOccurs="0" name="assigneeProperties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="assigneeStart" type="xs:dateTime"/>
                <xs:element name="assigneeStartDateOnly" type="xs:boolean"/>
                <xs:element name="assignmentOnly" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="attachments" type="xs:anyType"/>
                <xs:element minOccurs="0" name="locationName" type="xs:string"/>
                <xs:element minOccurs="0" name="organizer" type="tns:participant"/>
                <xs:element minOccurs="0" ref="tns:sensitivity"/>
                <xs:element minOccurs="0" name="status" type="tns:todoStatus"/>
                <xs:element minOccurs="0" name="textDescription" type="xs:string"/>
                <xs:element minOccurs="0"
                    name="xhtmlFragmentDescription" type="xs:string"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to task

Referenced By Resources

Usage Resource Method
Response Task Create
Request Task Delete Batch
Response Task List Tasks In Range
Response Task Read
Response Task Read Batch
Request Task Read Batch
Response Task Update

Referenced By Representaions

Not Referenced Directly by Representations