Agnostic Guides
...
S3 Endpoints
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 { "tab" "examples", "url" "https //localhost 82/scrud/read", "name" "read (metadata)", "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" "id", "type" "string", "description" "unique id of s3 file or folder " }, { "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" " if no repository value is present middleware considers the location as bucket name configured in ini file ", "children" \[] }, { "name" "getcontent", "kind" "optional", "type" "string", "description" "if true, returns binary content of the document if false, returns metadata properties ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ymgovs5m1fdi32 gkqqch", "code" "\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}", "language" "200" }, { "id" "guazg kjaci06qaxi6hod", "code" "", "language" "500" } ], "selectedlanguageid" "ymgovs5m1fdi32 gkqqch" }, "examples" { "languages" \[ { "id" "ya6pahjglmna njr8xpmc", "code" "{\n \\"cmsname\\" \\"insertproductionsystemname (located in link enterprise gui)\\",\n \\"id\\" \\"unique s3 id specfic to folder/id\\",\n\t\\"selectedcms\\" \\"s3\\",\n\t \\"location\\" \\"s3 bucket name\\"\n\t\n}\n", "language" "json" } ], "selectedlanguageid" "ya6pahjglmna njr8xpmc" }, "description" "retrieve a file metadata by using s3 unique id ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/read", "name" "read (content)", "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" "id", "type" "string", "description" "unique id of s3 file or folder " }, { "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 read the document if no location value is present middleware considers the location as bucket name configured in ini file ", "children" \[] }, { "name" "getcontent", "kind" "required", "type" "string", "description" "if true, returns binary content of the document if false, returns metadata properties ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ymgovs5m1fdi32 gkqqch", "code" "\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}", "language" "200" }, { "id" "guazg kjaci06qaxi6hod", "code" "", "language" "500" } ], "selectedlanguageid" "ymgovs5m1fdi32 gkqqch" }, "examples" { "languages" \[ { "id" "ya6pahjglmna njr8xpmc", "code" "{\n \\"cmsname\\" \\"insertproductionsystemname (located in link enterprise gui)\\",\n \\"id\\" \\"unique s3 id specfic to folder/id\\",\n\t\\"selectedcms\\" \\"s3\\",\n\t \\"location\\" \\"s3 bucket name\\",\n\t \\"getcontent\\"\ true\n\t\n}\n", "language" "json" } ], "selectedlanguageid" "ya6pahjglmna njr8xpmc" }, "description" "retrieve a file metadata by using s3 unique id ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }