Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7) E16658-04 |
Name | Type | Required | Description |
---|---|---|---|
checkedOut |
This member is true if the family member is true and the document is currently checked out for editing. | ||
checkedOutBy |
The actor who currently has a document checked out for editing. | ||
checkedOutOn |
The time at which a checked-out document was checked out for editing. | ||
checkoutComments |
If this item represents a document that is currently checked out for editing, then the checkoutComments member stores the comments that describe the edits made for the checkout. | ||
content |
The identifiable simple content object associated with this document. | ||
contentSnapshotId |
ID marking the state of the document at the time that the content was last updated. | ||
description |
The description of the document, stored with rich text markup. | ||
family |
This member is true if this item represents a document with versions. | ||
lastModifiedByName |
The name of the actor who last modified the document. | ||
locks |
lock[] |
All locks that are currently held on the document. | |
parentFamily |
(constrained to Versionable) |
If this item represents a specific version of a document, then this member can be loaded to get the overall document (the family) of which this item is a part. | |
parentVersion |
If this item represents a specific version of a document, then this member can be loaded to get the metadata for this particular version. | ||
path |
The fully-qualified path of the document. | ||
pendingWorkflowStatus |
The pending workflow status for this document if there is a pending workflow for this document. | ||
representativeVersion |
If this item represents a document with versions, then this member can be loaded to get the metadata for the latest version or the working copy, depending on whether the current actor has the document checked out for editing. | ||
representativeVersionable |
(constrained to Versionable) |
If this item represents a document with versions, then this member can be loaded to get the content of the latest version or the working copy, depending on whether the current actor has the document checked out for editing. | |
sealed |
Whether the document is sealed for editing by the information rights management feature. | ||
size |
The user-visible current size of the document. If the document has multiple versions, this member displays the size of the latest version. | ||
totalSize |
The total size of the document and all of its versions. This is the amount that the document as a whole contributes to the quota of its containing workspace. | ||
version |
This member is true if this item represents the content of a specific version of a document. | ||
versionControlled |
This member is true if the document is under version control and is either a family, version, or working copy. | ||
versionHistory |
version[] |
List of the metadata for each version of the document. These types can be loaded to retrieve the version numbers and comments associated with each version. | |
versionableHistory |
anyType[] |
List of all versions of the document. These types can be loaded to retrieve the actual document content associated with each version. | |
viewCount |
The number of times this document has been viewed | ||
workingCopy |
This member is true if this item represents the content of a checked-out document. |
Inherits From
Inherited By
Applied Markers
<xs:complexType name="document"> <xs:complexContent> <xs:extension base="tns:artifact"> <xs:sequence> <xs:element name="checkedOut" type="xs:boolean"/> <xs:element minOccurs="0" name="checkedOutBy" type="tns:actor"/> <xs:element minOccurs="0" name="checkedOutOn" type="xs:dateTime"/> <xs:element minOccurs="0" name="checkoutComments" type="xs:string"/> <xs:element minOccurs="0" name="content" type="tns:content"/> <xs:element minOccurs="0" name="contentSnapshotId" type="xs:string"/> <xs:element minOccurs="0" name="description" type="xs:string"/> <xs:element name="family" type="xs:boolean"/> <xs:element minOccurs="0" name="lastModifiedByName" type="xs:string"/> <xs:element maxOccurs="unbounded" minOccurs="0" name="locks" nillable="true" type="tns:lock"/> <xs:element minOccurs="0" name="parentFamily" type="xs:anyType"/> <xs:element minOccurs="0" name="parentVersion" type="tns:version"/> <xs:element minOccurs="0" name="path" type="xs:string"/> <xs:element minOccurs="0" ref="tns:pendingWorkflowStatus"/> <xs:element minOccurs="0" name="representativeVersion" type="tns:version"/> <xs:element minOccurs="0" name="representativeVersionable" type="xs:anyType"/> <xs:element name="sealed" type="xs:boolean"/> <xs:element name="size" type="xs:long"/> <xs:element name="totalSize" type="xs:long"/> <xs:element name="version" type="xs:boolean"/> <xs:element name="versionControlled" type="xs:boolean"/> <xs:element maxOccurs="unbounded" minOccurs="0" name="versionHistory" nillable="true" type="tns:version"/> <xs:element maxOccurs="unbounded" minOccurs="0" name="versionableHistory" nillable="true" type="xs:anyType"/> <xs:element name="viewCount" type="xs:int"/> <xs:element name="workingCopy" type="xs:boolean"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
Usage | Resource | Method |
---|---|---|
Response | Document | Copy |
Response | Document | Copy Batch |
Request | Document | Copy Batch |
Response | Document | Create |
Request | Document | Delete Batch |
Response | Document | List |
Request | Document | Move Batch |
Request | Document | Move Batch to Trash |
Response | Document | Read |
Response | Document | Read Batch |
Request | Document | Read Batch |
Response | Document | Undelete |
Request | Document | Undelete Batch |
Response | Document | Update |
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices