Agnostic Guides
...
SharePoint Endpoints
Search
1 min
link enterprise provides a web service endpoint that will allow you to retrieve a subset of documents/folders 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 sharepoint system configured in link enterprise " }, { "kind" "required", "name" "whereclause", "type" "string", "description" "a where clause used to query sharepoint to return a set of files/folders depending on criteria set " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"sp\\" to let link enterprise know which configured content system to search " }, { "name" "repository", "kind" "required", "type" "string", "description" "sharepoint repository id it consists of sharepoint domain name and root site name separated with \\"/sites/\\" or \\" /teams/\\"", "children" \[] }, { "name" "location", "kind" "required", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "l7maccvikcmgyr03j3 ap", "code" "\[\n\t{\n\t\t\\"modified\\" \\"2022 10 14t19 46 38z\\",\n\t\t\\"linkfilename\\" \\"demo txt\\",\n\t\t\\"contenttype\\" \\"document\\",\n\t\t\\"edit\\" \\"0\\",\n\t\t\\"fileleafref\\" \\"demo txt\\",\n\t\t\\" compliancetag\\" \\"\\",\n\t\t\\"created\\" \\"2022 10 14t19 44 57z\\",\n\t\t\\" displayname\\" \\"\\",\n\t\t\\" uiversionstring\\" \\"1 0\\",\n\t\t\\"docicon\\" \\"txt\\",\n\t\t\\"parentversionstring\\" \\"\\",\n\t\t\\"linkfilenamenomenu\\" \\"demo txt\\",\n\t\t\\"id\\" \\"01chittn72qlkgj5b3rreabcdef3\\",\n\t\t\\"saplinktrigger\\" \\"false\\",\n\t\t\\"parentleafname\\" \\"\\",\n\t\t\\" compliancetagwrittentime\\" \\"\\",\n\t\t\\" commentcount\\" \\"\\",\n\t\t\\"@odata etag\\" \\"\\\\\\"64d482fa 3bf4 498c b628 f9fbrbf33efb,2\\\\\\"\\",\n\t\t\\"title\\" \\"202\\",\n\t\t\\" checkincomment\\" \\"\\",\n\t\t\\"filesizedisplay\\" \\"33456\\",\n\t\t\\" compliancetaguserid\\" \\"\\",\n\t\t\\"itemchildcount\\" \\"0\\",\n\t\t\\"author\\" \\"\\",\n\t\t\\" complianceflags\\" \\"\\",\n\t\t\\"id\\" \\"01chittn72qlkgj5b3rreabcdef3\\",\n\t\t\\"editor\\" \\"\\",\n\t\t\\" likecount\\" \\"\\",\n\t\t\\"folderchildcount\\" \\"0\\"\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\\" \\"\<domain name>/sites/\<rootsitename>\\",\n\\"whereclause\\" \\"insertmetadatacolumnname eq 'insertmetadatavalue'\\",\n\\"location\\" \\"/\<subsitename>/\<documentlibraryname>\\",\n\\"selectedcms\\" \\"sp\\"\n}\n\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" } }