Search

1 min

Link Enterprise provides a web service endpoint that will allow you to retrieve a subset of documents based on a search criteria.

Search for all documents using a where clause. If successful will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned. If it's a known error returns 200 with error message in response.

POST

https://localhost:82/scrud/search

Body Parameters

cmsNameStringrequired
Description
Name of the s3 system configured in Link Enterprise .
whereClausestringrequired
Description
A where clause Used to query s3 to return a set of files/folders depending on criteria set.
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 search the document.

json

{
    "cmsName":"insertProductionSystemName (located in Link       Enterprise gui)",
   "selectedCMS":"s3",
	"whereClause":"contRep,K2456",
	   "location":"S3 Bucket Name"
}

200

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

500