Agnostic Guides
...
SharePoint Endpoints
Create
4 min
link enterprise provides a web service endpoint that will allow you to create a document or folder the following endpoint allows the following capabilities create a file create a file with metadata create a folder create a folder with metadata create a nested folder structure (with parent obtaining metadata) create a single level tree structure (with parent obtaining metadata) { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a file", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint system configured in docuflow " }, { "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" "filelocation", "kind" "required", "type" "string", "description" " file location in local system that needs to be stored in sharepoint ", "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" "", "language" "500" } ], "selectedlanguageid" "vzfozygcxsopbwzdx0yew" }, "examples" { "languages" \[ { "id" "cxpum3dlkeh5ctlxe mjb", "code" "{\n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\", \n \\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\somefile txt\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\"\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" "type", "type" "string", "description" "content type name in sharepoint " }, { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint 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 sharepoint ", "children" \[] }, { "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" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "0imkcf4s ykchraaxwjq3", "code" "", "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 \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\", \n \\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\somefile txt\\",\n \\"type\\" \\"insertmetadatatemplate\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\",\n \\"mdarray\\" \[\n {\n \\"md1\\" \\"insertcolumnname\\",\n \\"md2\\" \\"insertvalue\\"\n },\n {\n \\"md1\\" \\"somevendor\\",\n \\"md2\\" \\"gimmal inc\\"\n }\n\t\t ]\n}", "language" "json" } ], "selectedlanguageid" "yykmw0eact jck9 cgjjs" }, "description" "create a file with metadata", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a folder", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint system configured in link enterprise " }, { "kind" "required", "name" "custom1", "type" "string", "description" "name of the folder you would like to create " }, { "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" "filelocation", "kind" "optional", "type" "string", "description" "file location in local system that needs to be stored in sharepoint ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "59h a2k0zonjiesyswrxe", "code" "", "language" "200" }, { "id" " cfsyxvo ljjekethbmed", "code" "", "language" "500" } ], "selectedlanguageid" "59h a2k0zonjiesyswrxe" }, "examples" { "languages" \[ { "id" "r7afh lq7ej9kyrx6 sdw", "code" "{ \n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\",\n \\"custom1\\" \\"test\\"\n}", "language" "json" } ], "selectedlanguageid" "r7afh lq7ej9kyrx6 sdw" }, "description" "create a folder with no metadata", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a folder (metadata)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "type", "type" "string", "description" "content type name in sharepoint " }, { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint system configured in link enterprise " }, { "kind" "required", "name" "custom1", "type" "string", "description" "name of the folder you would like to create " }, { "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 " }, { "kind" "required", "name" "metadatafolderflag", "type" "boolean", "description" "true if setting metadata for folders\nfalse if not setting metadata for folders" }, { "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" "filelocation", "kind" "optional", "type" "string", "description" "file location in local system that needs to be stored in sharepoint ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ecfzj0cyeeurqk6 xyi w", "code" "", "language" "200" }, { "id" "lxcnvel7gh2nxd xcils3", "code" "", "language" "500" } ], "selectedlanguageid" "ecfzj0cyeeurqk6 xyi w" }, "examples" { "languages" \[ { "id" "9wxksomg0n4vqqcvfqncy", "code" "{ \n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\", \n \\"type\\" \\"insertmetadatatemplate\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\",\n \\"mdarray\\" \[\n {\n \\"md1\\" \\"insertcolumnname\\",\n \\"md2\\" \\"insertvalue\\"\n },\n {\n \\"md1\\" \\"somevendor\\",\n \\"md2\\" \\"gimmal inc\\"\n }\n\t\t ],\n\t\t \\"custom1\\" \\"test\\",\n\t\t \\"metadatafolderflag\\"\ true\n}", "language" "json" } ], "selectedlanguageid" "9wxksomg0n4vqqcvfqncy" }, "description" "create a folder with metadata", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a folder (metadata and nested)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "type", "type" "string", "description" "content type name in sharepoint " }, { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint system configured in link enterprise " }, { "kind" "required", "name" "custom1", "type" "string", "description" "name of the folder you would like to create if using nested the delimiter is #dflow# and prefix \\" \\" before the folder name where the document needs to be stored \nexample folder1#dflow#folder2#dflow# folder3 (the document is will be stored inside folder3) by default, the document goes into parent folder " }, { "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 " }, { "kind" "required", "name" "enablenested", "type" "boolean", "description" "true (if wanting each folder to have one child in a nested manner)\n\nfalse (if all children are located under the first folder name)" }, { "kind" "required", "name" "metadatafolderflag", "type" "boolean", "description" "true if setting metadata for folders\nfalse if not setting metadata for folders" }, { "name" "filelocation", "kind" "optional", "type" "string", "description" "file location in local system that needs to be stored in sharepoint ", "children" \[] }, { "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" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "1p4dxmaxpscwhcaijsf w", "code" "", "language" "200" }, { "id" "yfjvjp7jqiuudivziep9b", "code" "", "language" "500" } ], "selectedlanguageid" "1p4dxmaxpscwhcaijsf w" }, "examples" { "languages" \[ { "id" "uewifobfukx7uxgdl9xbi", "code" "{ \n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\", \n \\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\somefile txt\\",\n \\"type\\" \\"insertmetadatatemplate\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\",\n \\"mdarray\\" \[\n {\n \\"md1\\" \\"insertcolumnname\\",\n \\"md2\\" \\"insertvalue\\"\n },\n {\n \\"md1\\" \\"somevendor\\",\n \\"md2\\" \\"gimmal inc\\"\n }\n\t\t ],\n \\"custom1\\" \\"foldername#dflow#foldername2#dflow#foldername3\\",\n \\"metadatafolderflag\\"\ true,\n \\"enablenested\\"\ true\n}", "language" "json" } ], "selectedlanguageid" "uewifobfukx7uxgdl9xbi" }, "description" "create a folder with metadatafolderflag set to true and enablenested set to false a nested folder structure is created with metadata type and fields set to the parent folder and a document is added inside the specified subfolder or the parent folder ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a folder (metadata and nested false)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "type", "type" "string", "description" "content type name in sharepoint " }, { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint system configured in link enterprise " }, { "kind" "required", "name" "custom1", "type" "string", "description" "name of the folder you would like to create if using nested the delimiter is #dflow#" }, { "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 " }, { "kind" "required", "name" "enablenested", "type" "boolean", "description" "true (if wanting each folder to have one child in a nested manner)\n\nfalse (if all children are located under the first folder name)\nwhen false and metadata is " }, { "kind" "required", "name" "metadatafolderflag", "type" "boolean", "description" "true if setting metadata for folders\nfalse if not setting metadata for folders" }, { "name" "filelocation", "kind" "optional", "type" "string", "description" "file location in local system that needs to be stored in sharepoint ", "children" \[] }, { "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" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "eznsiycqgduwgzvhvcpc ", "code" "", "language" "200" }, { "id" "n2nerzspkxazhkqm jwrv", "code" "", "language" "500" } ], "selectedlanguageid" "eznsiycqgduwgzvhvcpc " }, "examples" { "languages" \[ { "id" "bgcmlquzsw5m7cmhh8kbv", "code" "{ \n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\", \n \\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\somefile txt\\",\n \\"type\\" \\"insertmetadatatemplate\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\",\n \\"mdarray\\" \[\n {\n \\"md1\\" \\"insertcolumnname\\",\n \\"md2\\" \\"insertvalue\\"\n },\n {\n \\"md1\\" \\"somevendor\\",\n \\"md2\\" \\"gimmal inc\\"\n }\n\t\t ],\n \\"custom1\\" \\"foldername#dflow#foldername2#dflow#foldername3\\",\n \\"metadatafolderflag\\"\ true,\n \\"enablenested\\"\ false\n}", "language" "json" } ], "selectedlanguageid" "bgcmlquzsw5m7cmhh8kbv" }, "description" "create a folder with metadatafolderflag set to true and enablenested set to false a flat folder structure is created with metadata type and fields set to the parent folder and a document is added inside the parent folder ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/create", "name" "create a folder (no metadata and nested false)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "type", "type" "string", "description" "content type name in sharepoint " }, { "kind" "required", "name" "location", "type" "string", "description" "sharepoint document library location (including any sub site present) each field is separated with \\"/\\" " }, { "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 " }, { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the sharepoint system configured in link enterprise " }, { "kind" "required", "name" "custom1", "type" "string", "description" "name of the folder you would like to create if using nested the delimiter is #dflow#" }, { "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 " }, { "kind" "required", "name" "enablenested", "type" "boolean", "description" "true (if wanting each folder to have one child in a nested manner)\n\nfalse (if all children are located under the first folder name)" }, { "kind" "required", "name" "metadatafolderflag", "type" "boolean", "description" "true if setting metadata for folders\nfalse if not setting metadata for folders" }, { "name" "filelocation", "kind" "optional", "type" "string", "description" "file location in local system that needs to be stored in sharepoint ", "children" \[] }, { "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" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "vo9jnepriajj6wvw4sip ", "code" "", "language" "200" }, { "id" "l4o7oo2z1fbfxmqca pgy", "code" "", "language" "500" } ], "selectedlanguageid" "vo9jnepriajj6wvw4sip " }, "examples" { "languages" \[ { "id" "m 86xorhlr5rl 54vrddu", "code" "{ \n \\"cmsname\\" \\"name of the sharepoint system configured in link enterpri \\",\n \\"repository\\" \\"\<domain name>/sites/\<rootsitename>\\", \n \\"filelocation\\" \\"c \\\\\\\somefolder\\\\\\\somefile txt\\",\n \\"type\\" \\"insertmetadatatemplate\\",\n \\"location\\" \\"/\<subsite>/\<documentlibrary>\\",\n \\"selectedcms\\" \\"sp\\",\n \\"mdarray\\" \[\n {\n \\"md1\\" \\"insertcolumnname\\",\n \\"md2\\" \\"insertvalue\\"\n },\n {\n \\"md1\\" \\"somevendor\\",\n \\"md2\\" \\"gimmal inc\\"\n }\n\t\t ],\n \\"custom1\\" \\"foldername#dflow#foldername2#dflow#foldername3\\",\n \\"metadatafolderflag\\"\ false,\n \\"enablenested\\"\ false\n}", "language" "json" } ], "selectedlanguageid" "m 86xorhlr5rl 54vrddu" }, "description" "create a folder with metadatafloderflag and enablenested set to false a flat folder structure is created and a document is added inside the parent folder with metadata type and fields provided in the request ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }