Global

Members

ECMListColumnTypestring

Enum for ECMListColumnTypevalues. * @readonly
Properties:
Name Type Default Description
Doc_Name_Clickable string cmis:name
Version_Label string cmis:versionLabel
Last_Modified_By string cmis:lastModifiedBy
Last_Modified_Date string cmis:lastModificationDate
Created_By string cmis:createdBy
Created_Date string cmis:creationDate
MIME_Type string cmis:contentStreamMimeType
Size_Length string cmis:contentStreamLength

ExplorerTypestring

Enum for ExplorerTypevalues. * @readonly
Properties:
Name Type Default Description
Doc_Name_Clickable string name
Last_Modified_By string modifiedBy
Last_Modified_Date string modificationDate
MIME_Type string mimeType

readonlyViewerControlsPlacementstring

Enum for ViewerControlsPlacementvalues. Available placements for the File Viewer control
Properties:
Name Type Default Description
None string N
Top string T
Bottom string B

Type Definitions

CaseActionDataObject

Properties:
Name Type Description
canAddObjectToFolder Boolean -
canCancelCheckOut Boolean -
canCheckIn Boolean -
canCheckOut Boolean -
canDeleteObject Boolean -
canRenameReference Boolean -
canUpdateProperties Boolean -
canSetContentStream Boolean -

CaseContentDataObject

Properties:
Name Type Description
CheckedOutBy String -
IBM_BPM_Document_FileNameURL String -
IBM_BPM_Document_FileType String -
allowableActions CaseActionData -
baseTypeId String -
checkedOutId String -
contentURL String -
cssVisibility String -
displayModificationDate String -
id String -
isCheckedOut Boolean -
isLocal Boolean -
isReference Boolean -
mimeType String -
modificationDate String -
modifiedBy String -
name String -
objectTypeId String -
server String -

CaseDocumentQueryObject

Properties:
Name Type Description
id String -
depth Integer -
serverName String -
isFolder Boolean -

CaseFolderCreationObject

Properties:
Name Type Description
objectTypeId String -
parentFolderId String -
folderName String -
serverName String -

CaseSearchQueryObject

Properties:
Name Type Description
parentFolderId String -
maxItems Integer -
searchAllVersions Boolean -
serverName String -
pageSize Integer -

CaseSearchResultObject

Properties:
Type Description

ECMDocObject

Properties:
Name Type Description
objectId String -
objectTypeId String -
name String -
contentURL String -
properties ECMDocProperty -

ECMDocDeletionObject

Facilitates ECM document deletions
Properties:
Name Type Description
id String Document ID to be deleted
allVersions Boolean When true all versions of the document are deleted
serverName String -

ECMDocExplorerDataObject

Properties:
Name Type Description
bpmFolderList FileData -
bpmFolderReference FileData -
ecmFolder FileData -
bpmFileList FileData -
bpmFileReference FileData -
ecmFileList FileData -

ECMDocPropertiesQueryObject

Properties:
Name Type Description
documentObjectId String -
serverName String -

ECMDocPropertyObject

Properties:
Name Type Description
name String -
value ANY -

ECMDocQueryObject

Document query paramters used with ECM
Properties:
Name Type Description
maxItems Integer maximum items to return
skipCount Integer number of documents to skip in the returned query before returning maxItems
searchAllVersions Boolean return all versions when multiple versions exist
cmisQuery String CMIS query string to be used
versionIdentifier String For US 921
serverName String -

ECMDocTypesQueryObject

Properties:
Name Type Description
fromDocTypeId String -
depth Integer -
includePropDefs Boolean -
localName String -
serverName String -

ECMDocumentPropertiesUpdateObject

Properties:
Name Type Description
name String -
serverName String -
parentFolderId String -
parentFolderServer String -
referenceName String -

ECMFileListColumnObject

Properties:
Name Type Description
label String -
field ECMListColumnType -
sortable Boolean -
width String -
options String -
css String -

ECMFolderCreationObject

Facilitates ECM document deletions
Properties:
Name Type Description
objectTypeId String Document ID to be deleted
parentFolderPath String -
name String -
serverName String -

ECMFolderDeletionObject

Facilitates ECM document deletions
Properties:
Name Type Description
id String Document ID to be deleted
serverName String -

ECMFolderQueryObject

Properties:
Name Type Description
folder String -
depth Integer -
serverName String -

ECMGetAllVersionsObject

Properties:
Name Type Description
serverName String -

ECMPropertiesUpdateObject

Properties:
Name Type Description
name String -
serverName String -

ECMReferenceCreationObject

Properties:
Name Type Description
referenceServerName String -
referenceName String -
serverName String -
type String -

ECMReferenceRenameObject

Properties:
Name Type Description
referenceName String -
serverName String -
folderServerName String -
isFile Boolean -

ECMRemoveFromFolderObject

Properties:
Name Type Description
referenceServerName String -
serverName String -
type String -

ExplorerColumnObject

Properties:
Name Type Description
label String -
field ExplorerType -
sortable Boolean -
width String -
options String -
css String -

FileCheckoutQueryObject

Properties:
Name Type Description
serverName String -

FileDataObject

Properties:
Name Type Description
name String -