Agnostic Guides
...
S3 Endpoints
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 { "tab" "examples", "url" "https //localhost 82/scrud/search", "name" "search ", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the s3 system configured in link enterprise " }, { "kind" "required", "name" "whereclause", "type" "string", "description" "a where clause used to query s3 to return a set of files/folders depending on criteria set " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"s3\\" to let link enterprise know which configured content system to search " }, { "name" "location", "kind" "optional", "type" "string", "description" "s3 bucket name where you want to search the document ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "l7maccvikcmgyr03j3 ap", "code" "\[\n\t{\n\t\t\\"compid\\" \\"data24\\",\n\t\t\\"content length\\" \\"3000\\",\n\t\t\\"contrep\\" \\"k2456\\",\n\t\t\\"docid\\" \\"1234\\",\n\t\t\\"scanperformed\\" \\"true\\"\n\t}\n]", "language" "200" }, { "id" "c0tj4vmrgrtv7xq8zvvau", "code" "", "language" "500" } ], "selectedlanguageid" "l7maccvikcmgyr03j3 ap" }, "examples" { "languages" \[ { "id" "rinxzo0waaz3lekuoh2ux", "code" "{\n \\"cmsname\\" \\"insertproductionsystemname (located in link enterprise gui)\\",\n \\"selectedcms\\" \\"s3\\",\n\t\\"whereclause\\" \\"contrep,k2456\\",\n\t \\"location\\" \\"s3 bucket name\\"\n}", "language" "json" } ], "selectedlanguageid" "rinxzo0waaz3lekuoh2ux" }, "description" "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 \n", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }