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

Contents

Overview

A workflow represents an instance of a Workflow Schema. It is created when an actor requests the Workflow Service to start a Workflow using a Workflow Schema and/or a Workflow Template. It stores the values supplied by the initiating actor for various attributes of the workflow.

Members

Name Type Required Description

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

attributes

attributeApplication[]

Returns the attribute values used to start this workflow. The attributes are defined in the Workflow Schema / Workflow Template used to initiate this workflow.

audit

workflowAudit

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.

description

string

Returns a rich text description of this workflow.

initiator

actor

Returns the actor that initiated this Workflow.

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.

payload

workflowOperationPayload

Returns the request specific workflow payload if a conversion handler is registered on the server side.

properties

collabProperties

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

snapshotId

string

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

status

workflowStatus

Returns the status of this workflow.

A Workflow is marked as failed if either an error occurs in the execution of the workflow in workflow engine or if any post completion activities(call backs) waiting for this workflow fail to execute successfully.

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

workflowAudit

workflowAudit

Returns the Workflow audit trail.

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:workflow xsi:type="obh:workflow" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <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:attributes>your_attributeApplication_0</obh:attributes>
        <obh:attributes>your_attributeApplication_1</obh:attributes>
        <obh:attributes>your_attributeApplication_2</obh:attributes>
        <obh:audit>your_workflowAudit_0</obh:audit>
        <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:description>your_string_0</obh:description>
        <obh:initiator>your_actor_0</obh:initiator>
        <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:payload>your_workflowOperationPayload_0</obh:payload>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:status>your_workflowStatus_0</obh:status>
        <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:workflowAudit>your_workflowAudit_0</obh:workflowAudit>
</obh:workflow>

JSON Example

(show inherited members)

{
    "beeType":"workflow",
        "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 }
        ],
        "attributes":[
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication0 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication1 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication2 }
        ],
        "audit":{ your_{http://www.oracle.com/beehive}audit_as_workflowAudit0 },
        "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,
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "initiator":{ your_{http://www.oracle.com/beehive}initiator_as_actor0 },
        "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 },
        "payload":{ your_{http://www.oracle.com/beehive}payload_as_workflowOperationPayload0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "status":{ your_{http://www.oracle.com/beehive}status_as_workflowStatus0 },
        "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 },
        "workflowAudit":{ your_{http://www.oracle.com/beehive}workflowAudit_as_workflowAudit0 }
}

XML Schema


<xs:complexType name="workflow">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="attributes" nillable="true" type="tns:attributeApplication"/>
                <xs:element minOccurs="0" name="audit" type="tns:workflowAudit"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="initiator" type="tns:actor"/>
                <xs:element minOccurs="0" name="payload" type="tns:workflowOperationPayload"/>
                <xs:element minOccurs="0" name="status" type="tns:workflowStatus"/>
                <xs:element minOccurs="0" name="workflowAudit" type="tns:workflowAudit"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to workflow

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations