Read

1 min

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.

Read (metadata)

Retrieve a file metadata by using s3 unique Id.

POST

https://localhost:82/scrud/read

Body Parameters

cmsNamestringrequired
Description
Name of the s3 system configured in Link Enterprise .
idstringrequired
Description
Unique id of s3 file or folder.
selectedCMSstringrequired
Description
Value should always be set to "s3" to let Link Enterprise know which configured content system to search.
locationstring
Description
If no repository value is present middleware considers the location as bucket Name configured in ini File.
getContentstring
Description
If true, Returns binary content of the Document. If false, returns metadata properties.

json

{
   "cmsName":"insertProductionSystemName (located in Link Enterprise gui)",
   "id":"unique s3 id specfic to folder/id",
	"selectedCMS":"s3",
	   "location":"S3 Bucket Name"
	
}

200

	{
		"compid": "data24",
		"content-length": "3000",
		"contrep": "K2456",
		"docid": "1234",
		"scanperformed": "true"
	}

500

Read (content)

Retrieve a file metadata by using s3 unique Id.

POST

https://localhost:82/scrud/read

Body Parameters

cmsNamestringrequired
Description
Name of the s3 system configured in Link Enterprise .
idstringrequired
Description
Unique id of s3 file or folder.
selectedCMSstringrequired
Description
Value should always be set to "s3" to let Link Enterprise know which configured content system to search.
locationstring
Description
S3 Bucket name where you want to read the document. If no location value is present middleware considers the location as bucket Name configured in ini File.
getContentstringrequired
Description
If true, Returns binary content of the Document. If false, returns metadata properties.

json

{
   "cmsName":"insertProductionSystemName (located in Link Enterprise gui)",
   "id":"unique s3 id specfic to folder/id",
	"selectedCMS":"s3",
	   "location":"S3 Bucket Name",
	   "getContent":true
	
}

200

	{
		"compid": "data24",
		"content-length": "3000",
		"contrep": "K2456",
		"docid": "1234",
		"scanperformed": "true"
	}

500