Data
- Default Namespace
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
- CallbackData
- fileDiscoverySearchCriteria
- nameValuePairs
- OperationProfile
- PgpFileOperationRepositoryPathsInfo
- SimpleFileOperationRepositoryPathsInfo
- ZipFileOperationRepositoryPathsInfo
The following types are members of this namespace:
- archiverFormatEnum
- callbackData
- compressorFormatEnum
- contentFile
- contentFileMetadata
- extensionMapping
- fileDiscoverySearchCriteria
- FileInfoWrapper
- FileOperationPaths
- hotfolder
- ImageTransformationResult
- operationProfile
- operationStatus
- pgpFileOperationRepositoryPathsInfo
- pgpKey
- processorAction
- processorConfiguration
- repositoryManagerCollisionBehaviorTypeEnum
- repositoryManagerFilePathEnum
- simpleFileOperationRepositoryPathsInfo
- zipFileOperationRepositoryPathsInfo
Element CallbackData
- Type: callbackData
POJO class for callbackdata.
Example XML
<?xml version="1.0" encoding="UTF-8"?><CallbackData> <processId>...</processId> <callbackClassName>...</callbackClassName> <initData> <ns2:nameValuePair xmlns:ns2="http://opencase.extend.com/common"> <name>...</name> <value>...</value> </ns2:nameValuePair> <ns2:nameValuePair xmlns:ns2="http://opencase.extend.com/common"> <!--...--> </ns2:nameValuePair> <!--...more "nameValuePair" elements...--> </initData> <instanceId>...</instanceId> <tokenId>...</tokenId></CallbackData>
Element fileDiscoverySearchCriteria
Example XML
<?xml version="1.0" encoding="UTF-8"?><fileDiscoverySearchCriteria> <searchPattern>...</searchPattern> <recursive>...</recursive> <repositoryPath>...</repositoryPath></fileDiscoverySearchCriteria>
Element nameValuePairs
- Type: NameValuePairs
Example XML
<?xml version="1.0" encoding="UTF-8"?><nameValuePairs> <ns2:nameValuePair xmlns:ns2="http://opencase.extend.com/common"> <name>...</name> <value>...</value> </ns2:nameValuePair> <ns2:nameValuePair xmlns:ns2="http://opencase.extend.com/common"> <!--...--> </ns2:nameValuePair> <!--...more "nameValuePair" elements...--></nameValuePairs>
Element OperationProfile
- Type: operationProfile
OperationProfile class is POJO class , which is used to hold the callback data, retryCount and priority.
Example XML
<?xml version="1.0" encoding="UTF-8"?><OperationProfile> <callbackData> <processId>...</processId> <callbackClassName>...</callbackClassName> <initData> <ns2:nameValuePair xmlns:ns2="http://opencase.extend.com/common"> <name>...</name> <value>...</value> </ns2:nameValuePair> <ns2:nameValuePair xmlns:ns2="http://opencase.extend.com/common"> <!--...--> </ns2:nameValuePair> <!--...more "nameValuePair" elements...--> </initData> <instanceId>...</instanceId> <tokenId>...</tokenId> </callbackData> <retryCount>...</retryCount> <priority>...</priority> <checkMD5checksum>...</checkMD5checksum></OperationProfile>
Element PgpFileOperationRepositoryPathsInfo
The Class PgpFileOperationRepositoryPathsInfo.
Example XML
<?xml version="1.0" encoding="UTF-8"?><PgpFileOperationRepositoryPathsInfo> <cryptoKey /> <sourceFile>...</sourceFile> <fileName>...</fileName> <destFolder>...</destFolder> <uniqueSubdir>...</uniqueSubdir> <createContentFiles>...</createContentFiles> <outputFiles>...</outputFiles> <outputFiles>...</outputFiles> <!--...more "outputFiles" elements...--> <collisionBehaviorType>...</collisionBehaviorType> <doMove>...</doMove></PgpFileOperationRepositoryPathsInfo>
Element SimpleFileOperationRepositoryPathsInfo
POJO class for SimpleFileOperationRepositoryPathsInfo.
Example XML
<?xml version="1.0" encoding="UTF-8"?><SimpleFileOperationRepositoryPathsInfo> <sourceFile>...</sourceFile> <fileName>...</fileName> <destFolder>...</destFolder> <uniqueSubdir>...</uniqueSubdir> <createContentFiles>...</createContentFiles> <outputFiles>...</outputFiles> <outputFiles>...</outputFiles> <!--...more "outputFiles" elements...--> <collisionBehaviorType>...</collisionBehaviorType> <doMove>...</doMove></SimpleFileOperationRepositoryPathsInfo>
Element ZipFileOperationRepositoryPathsInfo
The Class ZipFileOperationRepositoryPathsInfo.
Example XML
<?xml version="1.0" encoding="UTF-8"?><ZipFileOperationRepositoryPathsInfo> <sourceFileList>...</sourceFileList> <sourceFileList>...</sourceFileList> <!--...more "sourceFileList" elements...--> <archiverFormat>...</archiverFormat> <compressorFormat>...</compressorFormat> <sourceFile>...</sourceFile> <fileName>...</fileName> <destFolder>...</destFolder> <uniqueSubdir>...</uniqueSubdir> <createContentFiles>...</createContentFiles> <outputFiles>...</outputFiles> <outputFiles>...</outputFiles> <!--...more "outputFiles" elements...--> <collisionBehaviorType>...</collisionBehaviorType> <doMove>...</doMove></ZipFileOperationRepositoryPathsInfo>
Type archiverFormatEnum
Possible Values
value | description |
---|---|
repository.action.archiver.format.zip | |
repository.action.archiver.format.tar | |
repository.action.archiver.format.ar | |
repository.action.archiver.format.7z |
Type callbackData
POJO class for callbackdata.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processId (string) | 0/1 | Gets the process id. |
callbackClassName (string) | 0/1 | Gets the callback class name. |
initData (NameValuePairs) | 0/1 | Gets the inits the data. |
instanceId (string) | 0/1 | Gets the instance id. |
tokenId (string) | 0/1 | (no documentation provided) |
Type compressorFormatEnum
Possible Values
value | description |
---|---|
repository.action.compressor.format.gzip | |
repository.action.compressor.format.bzip2 | |
repository.action.compressor.format.xz |
Type contentFile
An entity class that represents a ContentFile.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
checkSum (string) | 0/1 | Represents checksum of the file. |
contentFileMetadatas (contentFileMetadata) | 0/unbounded | Represents collection of metadata for this file. |
contentFilePk (int) | 0/1 | Represents Pk of the entity. |
createdDate (dateTime) | 0/1 | Represents creation date of the ContentFile. |
fileLastModificationDate (dateTime) | 0/1 | Represents date of last modification of the ContentFile. |
description (string) | 0/1 | Represents description for ContentFile. |
diskName (string) | 0/1 | Represents the name of the disk where file is stored. |
fileSize (long) | 0/1 | Represents file size value in bytes. |
mimeType (string) | 0/1 | Represents mime-type of the content file. |
name (string) | 0/1 | Represents name of the content file. |
nodePath (string) | 0/1 | Represents path to the content file's node. |
repositoryNode (RepositoryNode) | 0/1 | Represents repository node of content file. |
repositoryPath (string) | 0/1 | Returns path to the content file's repository. |
uuid (string) | 0/1 | Represents UUID of the ContentFile entity. |
sourceFile (boolean) | 1/1 | Represents whether content file is a source file or not. |
bound (boolean) | 1/1 | Represents file bound property value. |
originalSourcePath (string) | 0/1 | Represents path to the file's original source. |
uniqueFolderName (string) | 0/1 | Represents unique name of the file's folder. |
collateId (string) | 0/1 | Represents the ID of the collation. |
abrType (AbrType) | 0/1 | Represents type of the file. |
Type contentFileMetadata
Used to store name/value pairs of format metadata that is generated by file processing.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
contentFileMetadataPk (int) | 0/1 | Represents PK of the entity. |
name (string) | 0/1 | Represents the name of the metadata. |
data (string) | 0/1 | Represents data value of the metadata entity. |
Type extensionMapping
The OCP Extension Mapping.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
extension (string) | 1/1 | Gets the ExtensionMapping's extension. |
physical_asset_type (string) | 1/1 | Gets the ExtensionMapping's physicalAssetType. |
mime_type (string) | 1/1 | Gets the ExtensionMapping's mimeType. |
uuid (string) | 0/1 | Returns the UUID generated by VMS when the entity is created. |
Type fileDiscoverySearchCriteria
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
searchPattern (string) | 0/1 | (no documentation provided) |
recursive (boolean) | 1/1 | (no documentation provided) |
repositoryPath (string) | 0/1 | (no documentation provided) |
Type FileInfoWrapper
Wrapper for FileInfo class (used in WS)
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
exist (boolean) | 1/1 | (no documentation provided) |
writable (boolean) | 1/1 | (no documentation provided) |
folder (boolean) | 1/1 | (no documentation provided) |
fileName (string) | 0/1 | (no documentation provided) |
url (string) | 0/1 | (no documentation provided) |
baseName (string) | 0/1 | (no documentation provided) |
Type FileOperationPaths
This class was designed to encapsulate source files and its destination folders in one object.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
destinationPaths (string) | 0/unbounded | (no documentation provided) |
sourcePaths (string) | 0/unbounded | (no documentation provided) |
destinationFileNames (string) | 0/unbounded | (no documentation provided) |
Type hotfolder
An entity class that represents the Hotfolder.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
hotfolderPk (int) | 0/1 | (no documentation provided) |
repositoryNode (RepositoryNode) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
rootPath (string) | 0/1 | (no documentation provided) |
processSubfolders (boolean) | 1/1 | (no documentation provided) |
isActive (boolean) | 0/1 | (no documentation provided) |
lastScanDate (dateTime) | 0/1 | Getter for lastScanDate parameter. |
lastModifiedDate () | 0/1 | Getter for lastModifiedDate parameter. |
rightsHolderFk (int) | 0/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
excludeFilename (string) | 0/1 | Regex of filename, Files that match it won't trigger the workflow instances |
scannerFilterFilename (string) | 0/1 | Regex of filename, Files that match it won't be processed by hotfolder scanner |
uuid () | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
priority (int) | 0/1 | Getter for priority parameter. |
Type ImageTransformationResult
Used during physical asset image creation in imageTransformationWebService.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
profileUUID (string) | 0/1 | returns UUID of applied profile |
outputFileName (string) | 1/1 | returns resulting name of file |
outputFilePath (string) | 1/1 | Gets the output file path. |
outputImageAppliedProfileType (string) | 0/1 | returns type of allied ImageProfile |
repositoryUrl (string) | 1/1 | Gets URL of repository |
height (int) | 0/1 | Gets the height. |
width (int) | 0/1 | Gets the width. |
encodingType (string) | 1/1 | Gets the encoding type. |
componentUUID (string) | 1/1 | Gets UUID of created component |
thumbnailRelated (boolean) | 1/1 | Gets true when image was created as "thumbnail". |
targetDevicesUUIDs (string) | 1/unbounded | Gets set of TargetDevices |
Type operationProfile
OperationProfile class is POJO class , which is used to hold the callback data, retryCount and priority.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
callbackData (callbackData) | 0/1 | Gets callbackData. |
retryCount (int) | 0/1 | Gets retryCount. |
priority (int) | 0/1 | Gets priority. |
checkMD5checksum (boolean) | 0/1 | (no documentation provided) |
Type operationStatus
Enumeration class of all operation task status.
Possible Values
value | description |
---|---|
NEW | |
PROCESSING | |
PAUSE | |
RESUME | |
CANCELLING | |
CANCELLED | |
RETRY | |
STOP | |
FAILED | |
NOTIFYING | |
PROCESSED |
Type pgpFileOperationRepositoryPathsInfo
The Class PgpFileOperationRepositoryPathsInfo.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
cryptoKey (pgpKey) | 0/1 | (no documentation provided) |
Type pgpKey
Pgp key class
Type processorAction
Entity that represents a specific configuration of a ProcessorConfiguration. This entity is also known as an Action Profile.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processorActionPk (int) | 0/1 | Gets the primary key of this Action Profile. |
processorConfiguration (processorConfiguration) | 0/1 | Gets the ProcessorConfiguration of this Action Profile. This is also known as an Action Template. |
name (string) | 0/1 | Gets the name of this Action Profile. |
description (string) | 0/1 | Gets the description of this Action Profile. |
settingsXml (string) | 0/1 | Gets the specific settings (in XML) for this Action Profile. |
isActive (boolean) | 0/1 | Gets whether this Action Profile is active or not. |
uuid (string) | 0/1 | Gets the UUID (unique identifier) from this Action Profile. |
lastModifiedDate () | 0/1 | Gets the last modified date. |
modifiedBy (string) | 0/1 | Get modified by (user name of the user who did last modification) of this Action Profile. |
Type processorConfiguration
An entity class that represents the Processor Configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processorConfigurationPk (int) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
esbCategory (string) | 0/1 | (no documentation provided) |
esbService (string) | 0/1 | (no documentation provided) |
configurationXml (string) | 0/1 | (no documentation provided) |
isActive (boolean) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
lastModifiedDate () | 0/1 | Getter for lastModifiedDate parameter. |
Type repositoryManagerCollisionBehaviorTypeEnum
Possible Values
value | description |
---|---|
repository.manager.action.collisionType.overwrite | |
repository.manager.action.collisionType.fail | |
repository.manager.action.collisionType.uniqueFilename | |
repository.manager.action.collisionType.uniqueSubdir |
Type repositoryManagerFilePathEnum
Possible Values
value | description |
---|---|
repository.manager.action.filePath.reproduceOriginal | |
repository.manager.action.filePath.fileOnly | |
repository.manager.action.filePath.reproduceStructure |
Type simpleFileOperationRepositoryPathsInfo
POJO class for SimpleFileOperationRepositoryPathsInfo.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
sourceFile (string) | 0/1 | (no documentation provided) |
fileName (string) | 0/1 | (no documentation provided) |
destFolder (string) | 0/1 | (no documentation provided) |
uniqueSubdir (string) | 0/1 | (no documentation provided) |
createContentFiles (boolean) | 1/1 | (no documentation provided) |
outputFiles (string) | 0/unbounded | (no documentation provided) |
collisionBehaviorType (repositoryManagerCollisionBehaviorTypeEnum) | 0/1 | (no documentation provided) |
doMove (boolean) | 1/1 | (no documentation provided) |
Type zipFileOperationRepositoryPathsInfo
The Class ZipFileOperationRepositoryPathsInfo.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
sourceFileList (string) | 0/unbounded | (no documentation provided) |
archiverFormat (archiverFormatEnum) | 0/1 | (no documentation provided) |
compressorFormat (compressorFormatEnum) | 0/1 | (no documentation provided) |