Agnostic Guides
...
Developers Guide
FileNet Endpoints

Read

1min

Link Enterprise provides a web service endpoint that will allow you to retrieve a file metadata.

Included below are example of reading a files metadata.

Retrieve a file metadata by using filenet unique Id.
POST
Request
Body Parameters
cmsName
required
String
Name of the filenet system configured in Link Enterprise .
selectedCMS
required
String
Value should always be set to "filenet" to let Link Enterprise know which configured content system to search.
location
required
String
filenet folder where the document need to be read.
repository
required
String
filenet repository Value
domain
required
String
Filenet Domain name
checkout
optional
String
If true, Does an Exclusive Checkout for filenet document.
id
required
String
Filenet unique Document Id
selectClause
optional
String
metadataField name which is required in response.
getContent
optional
String
If true, Returns binary content of the Document. If false, returns metadata properties.
dateTimeFormat
required
String
add datetime property in this provided format.
maxSize
optional
String
Maximum number of entries in response.

Retrieve a file metadata by using filenet unique Id.
POST
Request
Body Parameters
cmsName
required
String
Name of the filenet system configured in Link Enterprise .
selectedCMS
required
String
Value should always be set to "filenet" to let Link Enterprise know which configured content system to search.
location
required
String
filenet folder where the document need to be read.
repository
required
String
filenet repository Value
domain
required
String
Filenet Domain name
checkout
optional
String
If true, Does an Exclusive Checkout for filenet document.
id
required
String
Filenet unique Document Id
selectClause
optional
String
metadataField name. While retrieving content. add "ContentElements" as selectClause to get file information in response header.
getContent
optional
String
If true, Returns binary content of the Document. If false, returns metadata properties.
dateTimeFormat
required
String
add datetime property in this provided format.
maxSize
optional
String
Maximum number of entries in response.
tmpDirectory
optional
String
Temporary directory where the file content is stored in the local system. Required while getContent is set to true.