DocumentInformation

Note:

This structure has changed in 6.4

  • The field label has been added.
  • The BranchInformation data structure has changed: it contains a new field branchStatusType.
FieldTypeDescription

documentIdentifier

String

Full path of the document in the repository.

objectIdentifier

String

ID of the document.

description

String

Description of the document. Applies only to ditaval documents.

objectType

String

Specialized type of the document, such as "concept", "task", etc.

genericObjectType

ObjectType

Generic type of the document. The possible values are:

  • map
  • topic
  • image
  • ditaval
  • collaborative-review
  • approval

title

String

Title of the document, as provided by the "title" index in system configuration.

modifiedByIdentifier

String

User identifier for the user who last modified the document.

modifiedTime

DateTime

UTC time at which the document was last modified.

The date-time format is yyyy-MM-dd HH:mm:ss.

currentStatus

String

Status of the document, in complete form such as "Authoring:work".

totalReviewAssignmentCount

Int

Total number of review assignments for this document. Applies only to collaborative-review documents.

isLockedByMe

Boolean

Indicates if the document is locked by the current user.

lockOwnerUserIdentifier

String

User identifier for the user who has locked the document.

lockedTime

DateTime

UTC time at which the document was locked.

The date-time format is yyyy-MM-dd HH:mm:ss.

lockLocation

String

Location of the lock. This is defined by the application from which the lock was acquired. It is "web-client" if the document was locked from CCMS Web, or the name of the computer from which the document was locked using the Desktop client.

lockInWebPlatform

Boolean

Indicates if the document was locked from CCMS Web.

locale

String

Language code of the document.

branchesInformation

BranchInformation[]

List of all the branches to which the document belongs.

Note: Applies only for DRM.

featuresAvailable

Feature[]

List of features that are available for the current user on the document.

assignmentInformation

AssignmentInformation

Information about the active assignment on the document.

label

String

Branch label for standard (legacy) branching.