--- title: Create slug: WhPC-create docTags: createdAt: 2022-01-05T08:54:05.000Z --- Link Enterprise provides a web service endpoint that will allow you to create a document or folder. The following endpoint allows the following capabilities. 1. Create a File 2. Create a File with metadata 3. Create a folder 4. Create a folder with metadata 5. Create a nested folder structure (with parent obtaining metadata) 6. Create a single level tree structure (with parent obtaining metadata) :::ApiMethodV2 ```json { "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\":\"/sites/\", \n \"fileLocation\":\"C:\\\\someFolder\\\\someFile.txt\",\n \"location\":\"//\",\n \"selectedCMS\":\"sp\"\n}", "language": "json" } ], "selectedLanguageId": "CXPum3DlkEh5CtlxE_mJB" }, "description": "Create a file with no metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file", "legacyHash": "LTZYKRF4XjDFS4dN8yyEx" } ``` ::: :::ApiMethodV2 ```json { "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\":\"/sites/\", \n \"fileLocation\":\"C:\\\\someFolder\\\\someFile.txt\",\n \"type\":\"insertMetaDataTemplate\",\n \"location\":\"//\",\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" }, "autoGeneratedAnchorSlug": "create-a-file-metadata", "legacyHash": "jwu3C_6nkyZkTjqhuztuj" } ``` ::: :::ApiMethodV2 ```json { "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\":\"/sites/\",\n \"location\":\"//\",\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" }, "autoGeneratedAnchorSlug": "create-a-folder", "legacyHash": "wIxsI8djIx6QeX1UJGwdT" } ``` ::: :::ApiMethodV2 ```json { "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\":\"/sites/\", \n \"type\":\"insertMetaDataTemplate\",\n \"location\":\"//\",\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" }, "autoGeneratedAnchorSlug": "create-a-folder-metadata", "legacyHash": "Jv0MnAE3164FpSznGPg08" } ``` ::: :::ApiMethodV2 ```json { "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\":\"/sites/\", \n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\n \"type\":\"insertMetaDataTemplate\",\n \"location\":\"//\",\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" }, "autoGeneratedAnchorSlug": "create-a-folder-metadata-and-nested", "legacyHash": "wCBvhfT17RLyLiW_SsYpj" } ``` ::: :::ApiMethodV2 ```json { "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\":\"/sites/\", \n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\n \"type\":\"insertMetaDataTemplate\",\n \"location\":\"//\",\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" }, "autoGeneratedAnchorSlug": "create-a-folder-metadata-and-nested-false", "legacyHash": "GD-3v2PH9Zpl5L7CzrcqT" } ``` ::: :::ApiMethodV2 ```json { "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\":\"/sites/\", \n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\n \"type\":\"insertMetaDataTemplate\",\n \"location\":\"//\",\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" }, "autoGeneratedAnchorSlug": "create-a-folder-no-metadata-and-nested-false", "legacyHash": "iamkEN4dx3y-wyZdXaiVe" } ``` :::