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[] |
|
List of artifact bonds |
changeStatus |
changeStatus |
|
The change status of the artifact |
checkedOut |
boolean |
|
This member is true if the family member is true and the document is currently checked out
for editing. |
checkedOutBy |
actor |
|
The actor who currently has a document checked out for editing. |
checkedOutOn |
dateTime |
|
The time at which a checked-out document was checked out for editing. |
checkoutComments |
string |
|
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. |
collabId |
beeId |
|
CollabId of the snapshot |
content |
content |
|
The identifiable simple content object associated with this document. |
contentSnapshotId |
string |
|
ID marking the state of the document at the time that the content was last updated. |
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 description of the document, stored with rich text markup. |
family |
boolean |
|
This member is true if this item represents a document with versions. |
lastModifiedByName |
string |
|
The name of the actor who last modified the document. |
locks |
lock[] |
|
All locks that are currently held on the document. |
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. |
parentFamily |
anyType |
|
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 |
version |
|
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 |
string |
|
The fully-qualified path of the document. |
pendingWorkflowStatus |
pendingWorkflowStatus |
|
The pending workflow status for this document if there is a
pending workflow for this document. |
properties |
collabProperties |
|
The properties of the artifact that are shared among all the actors |
remoteItemId |
anyType |
|
The id of the remote document in external repository. |
representativeVersion |
version |
|
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 |
anyType |
|
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 |
boolean |
|
Whether the document is sealed for editing by the information rights management feature. |
size |
long |
|
The user-visible current size of the document. If the document has multiple versions,
this member displays the size of the latest version. |
snapshotId |
string |
|
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server. |
totalSize |
long |
|
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. |
userCreatedOn |
dateTime |
|
The user creation date (if created offline) |
userModifiedOn |
dateTime |
|
The user last modified date (if modified offline) |
version |
boolean |
|
This member is true if this item represents the content of a specific version of a document. |
versionControlled |
boolean |
|
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 |
int |
|
The number of times this document has been viewed |
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 |
workingCopy |
boolean |
|
This member is true if this item represents the content of a checked-out document. |