DocumentInformation

Note:

This structure changed in 6.8

  • The creationTime field is new.
  • The BranchInformation structure has a new field: branchStatusType.

This structure changed in 7.0.

  • The locale field is new.
Field Type Description

documentIdentifier

String

Full path of the document in the repository

objectIdentifier

String

ID of the object

description

String
Description of the object
Note: Applies only to ditaval documents.

objectType

String

Specialized object DITA type, such as concept, task, or reference

genericObjectType

ObjectType

Generic type of the object

Note: The possible values are:
  • map
  • topic
  • image
  • ditaval
  • collaborative-review
  • approval

title

String

Title of the object, as provided by the "title" index in the system configuration
titleKeys String Keys used in the title separated by "|"
Note: Plain text written between "[" and "]" characters are represented here by the "@" character.

modifiedByIdentifier

String

ID for user who last modified the object

modifiedTime

DateTime

Coordinated universal time (UTC) when user last modified the object

Note:

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

creationTime

DateTime

UTC when user created the object

Note:

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

currentStatus

String

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

totalReviewAssignmentCount

int
Total number of review assignments for object
Note: Applies only to collaborative-review documents.

isLockedByMe

Boolean

Indicates current user locked the object

lockOwnerUserIdentifier

String

ID for user who locked the object

lockedTime

DateTime

UTC time when user locked the object

Note:

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

lockLocation

String

Location of the lock

Note: The application in use at the time of object lock is the lock location.
  • For CCMS Web users: web-client
  • For CCMS Desktop users: The name of the computer used during document lock

lockInWebPlatform

Boolean

Additional flag that denotes the user locked the object while in CCMS Web

locale

String

Language code of the object

branchesInformation

BranchInformation[...]

List of all the branches to which the document belongs

Note: Applies only to DRM mode.

featuresAvailable

Feature[...]

List of features available to the current user for the object

assignmentInformation

AssignmentInformation[…]

Information about the object's active assignment

label

String

Branch label for standard (legacy) branching