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