BranchDetails

Field Type Description

branchIdentifier

String

Full path of the branch document

branchName

String

Name of the branch

branchStatusName

String

Status of the branch

branchStatusType

BranchType

Type of the branch, as determined by its status

Note:

Possible values:

  • work
  • maintenance
  • delivery
  • end

containerIdentifier

String

Internal

isBranchEditable

Boolean

Indicates if this branch is open so users can modify its content

isBranchOpen

Boolean

Indicates if this branch is open so users can modify its content

isInstanceInHigherStatusThanSource

Boolean

Indicates the source status is lower than the branch

partIdentifier

String

Internal use only

possibleUpdateType

UpdateType

Type of operation that can be performed for the source document in this branch

Note:

Possible values:

  • AUTOMATIC_UPDATE
  • MANUAL_UPDATE
  • SHARE_WITH
  • NONE

productIdentifier

String

Full path of the product or library document

productName

String

Name of the product

readPermission

Boolean

Indicates if the current user has read permissions for this branch

releaseIdentifier

String

Full path of the release document

releaseName

String

Name of the release

topicDocumentIdentifier

String

Full path of the instance of the document in this branch

topicId

String

Identifier of the document

writePermission

Boolean

Indicates if the current user has write permissions for this branch