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

Beehive Development Kit » All Representations » version
Contents

Overview

Version is an entity type used to store the metadata about a specific version of some other Versionable entity.

Versions cannot be created on their own, but rather are created during checkin and checkout operations defined for the specific versionable entity type.

A Version is first created during a checkout operation, but while the Version is checked out, the only members that can be loaded from it are the ParentArtifact and VersionArtifact.

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

bonds

bond[]
The bonds that are held on this version.

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
The comments associated with this particular version.

doNotAutoPurge

boolean
Whether or not this version may be automatically purged when the total number of versions exceeds that specified in the effective version configuration.

final

boolean
Whether or not this version's metadata is marked as final. When the metadata is marked as final, it cannot be updated any more.

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.

parentArtifact

anyType

(constrained to Versionable)
The family artifact that contains the set of versions of which this version is a part.

snapshotId

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

versionArtifact

anyType

(constrained to Versionable)
The content of this specific version of the artifact.

versionLabel

string
The label given to this version. This is the version number, formatted as specified in the effective version configuration.

versionNumber

int
The version number assigned to this version.

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:version xsi:type="obh:version" 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:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
         <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:doNotAutoPurge>your_boolean_0</obh:doNotAutoPurge>
         <obh:final>your_boolean_0</obh:final>
         <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:parentArtifact>your_anyType_0</obh:parentArtifact>
         <obh:snapshotId>your_string_0</obh:snapshotId>
         <obh:versionArtifact>your_anyType_0</obh:versionArtifact>
         <obh:versionLabel>your_string_0</obh:versionLabel>
         <obh:versionNumber>your_int_0</obh:versionNumber>
 </obh:version>

JSON Example

(show inherited members)

{
    "beeType":"version",
        "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 }
        ],
         "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 }
        ],
         "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",
         "doNotAutoPurge":your_{http://www.oracle.com/beehive}doNotAutoPurge_as_boolean0,
         "final":your_{http://www.oracle.com/beehive}final_as_boolean0,
         "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 },
         "parentArtifact":"your_{http://www.oracle.com/beehive}parentArtifact_as_anyType0",
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
         "versionArtifact":"your_{http://www.oracle.com/beehive}versionArtifact_as_anyType0",
         "versionLabel":"your_{http://www.oracle.com/beehive}versionLabel_as_string0",
         "versionNumber":your_{http://www.oracle.com/beehive}versionNumber_as_int0
 }

XML Schema


<xs:complexType name="version">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="bonds" nillable="true" type="tns:bond"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element name="doNotAutoPurge" type="xs:boolean"/>
                <xs:element name="final" type="xs:boolean"/>
                <xs:element minOccurs="0" name="parentArtifact" type="xs:anyType"/>
                <xs:element minOccurs="0" name="versionArtifact" type="xs:anyType"/>
                <xs:element minOccurs="0" name="versionLabel" type="xs:string"/>
                <xs:element name="versionNumber" type="xs:int"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to version

Referenced By Resources

Usage Resource Method
Response Version List
Response Version Read
Response Version Read Batch
Request Version Read Batch
Response Version Update

Referenced By Representaions

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