Search

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 filenet system configured in link enterprise " }, { "kind" "required", "name" "whereclause", "type" "string", "description" "a where clause used to query filenet to return a set of files depending on criteria set " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"filenet\\" to let link enterprise know which configured content system to search " }, { "name" "location", "kind" "optional", "type" "string", "description" "filenet folder where the file exists ", "children" \[] }, { "name" "repository", "kind" "required", "type" "string", "description" "filenet repository where the file exists ", "children" \[] }, { "name" "domain", "kind" "required", "type" "string", "description" "filenet domain where the file exists ", "children" \[] }, { "name" "selectclause", "kind" "required", "type" "string", "description" "filenet metadata field on which search is performed ", "children" \[] }, { "name" "fromclause", "kind" "required", "type" "string", "description" "metadata class name where the metadata fields and values are available ", "children" \[] }, { "name" "recursive", "kind" "required", "type" "string", "description" "enable it to check if the file exists inside a subfolder ", "children" \[] }, { "name" "orderby", "kind" "required", "type" "string", "description" "filenet property that needs to be displayed in response this can multiple values separated with \\",\\" ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "l7maccvikcmgyr03j3 ap", "code" "\[\n\t{\n\t\t\\"somerequiredmetadatafield\\" \\"somerequiredmetadatavalue\\"\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\\"repository\\" \\"filenet repository name\\",\n\\"domain\\" \\"filenet domain name\\",\n\\"selectedcms\\" \\"filenet\\",\n\t\\"selectclause\\" \\"somemetadatafield\\",\n\t\\"whereclause\\" \\"this infolder '/somefoldername' and this = object('somemetadatavalue')\\",\n\t\\"fromclause\\" \\"metadataclassname\\",\n\t\\"recursive\\" \\"true\\",\n\\"orderby\\" \\"somerequiredmetadatafield\\",\n\t\\"includesubfolders\\" \\"true\\"\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" } }