Agnostic Guides
...
S3 Endpoints
Create
2 min
link enterprise provides a web service endpoint that will allow you to create a document the following endpoint allows the following capabilities create a file create a file with metadata { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a file", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the s3 system configured in docuflow " }, { "name" "filelocation", "kind" "required", "type" "string", "description" "file location in local system that needs to be stored in s3 ", "children" \[] }, { "name" "location", "kind" "optional", "type" "string", "description" "s3 bucket name where you want to create the document ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "vzfozygcxsopbwzdx0yew", "code" "{\n\t\\"docid\\" \[\n\t\t\\"01kwrznisoyooxwoqbkjgirkqbppkm\\",\n\t\tnull,\n\t\tnull\n\t],\n\t\\"folderids\\" \[\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n \n\t]\n}", "language" "200" }, { "id" "vqkvxqfkvkg x3yyvkcwc", "code" "{\n\t\\"docid\\" \[\n\t\t\\"123demotest\\",\n\t\tnull,\n\t\tnull\n\t]\n}", "language" "500" } ], "selectedlanguageid" "vqkvxqfkvkg x3yyvkcwc" }, "examples" { "languages" \[ { "id" "cxpum3dlkeh5ctlxe mjb", "code" "{\n \\"cmsname\\" \\"name of the s3 system configured in link enterpri \\", \n \\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\somefile txt\\",\n \\"selectedcms\\" \\"s3\\",\n \\"location\\" \\"s3 bucket name\\"\n}", "language" "json" } ], "selectedlanguageid" "cxpum3dlkeh5ctlxe mjb" }, "description" "create a file with no metadata", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "http //localhost 82/scrud/create", "name" "create a file (metadata)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the s3 system configured in docuflow " }, { "kind" "required", "name" "mdarray", "type" "array", "description" "a json array where each index is a json object with the keys \\"md1\\" and \\"md2\\" where md1 is the column name, and md2 is the value to be inserted in that column " }, { "name" "filelocation", "kind" "required", "type" "string", "description" "file location in local system that needs to be stored in s3 ", "children" \[] }, { "name" "location", "kind" "optional", "type" "string", "description" "s3 bucket name where you want to create the document ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "0imkcf4s ykchraaxwjq3", "code" "{\n\t\\"docid\\" \[\n\t\t\\"123demotest\\",\n\t\tnull,\n\t\tnull\n\t]\n}", "language" "200" }, { "id" "idjmyl woawfo4s5k3 bg", "code" "", "language" "500" } ], "selectedlanguageid" "0imkcf4s ykchraaxwjq3" }, "examples" { "languages" \[ { "id" "yykmw0eact jck9 cgjjs", "code" "{\n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n\\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\1gb bin\\",\n \\"mdarray\\" \[\n {\n \\"md1\\" \\"contrep\\",\n \\"md2\\" \\"k1\\"\n }\t\t \n ],\n \\"selectedcms\\" \\"s3\\",\n \\"location\\" \\"s3 bucket name\\"\n}", "language" "json" } ], "selectedlanguageid" "yykmw0eact jck9 cgjjs" }, "description" "create a file with metadata", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }