Agnostic Guides
...
Developers Guide
SharePoint Endpoints

Create

4min

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)



Create a file with no metadata
POST
Request
Body Parameters
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in docuflow.
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"
fileLocation
String
required
file location in local system that needs to be stored in sharepoint.

Create a file with metadata
POST
Request
Body Parameters
type
String
required
Content Type name in sharepoint.
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in docuflow.
mdArray
Array
required
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.
fileLocation
String
required
file location in local system that needs to be stored in sharepoint.
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"

Create a folder with no metadata
POST
Request
Body Parameters
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in Link Enterprise.
custom1
String
required
Name of the folder you would like to create.
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"
fileLocation
String
optional
file location in local system that needs to be stored in sharepoint.

Create a Folder with metadata
POST
Request
Body Parameters
type
String
required
Content Type name in sharepoint.
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in Link Enterprise.
custom1
String
required
Name of the folder you would like to create.
mdArray
Array
required
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.
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"
fileLocation
String
optional
file location in local system that needs to be stored in sharepoint.

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.
POST
Request
Body Parameters
type
String
required
Content Type name in sharepoint.
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in Link Enterprise.
custom1
String
required
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. example: folder1#DFLOW#folder2#DFLOW#~folder3. (The document is will be stored inside folder3). By default, The document goes into parent folder.
mdArray
Array
required
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.
enableNested
Boolean
required
true (if wanting each folder to have one child in a nested manner) false (if all children are located under the first folder name)
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders
fileLocation
String
optional
file location in local system that needs to be stored in sharepoint.
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"

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.
POST
Request
Body Parameters
type
String
required
Content Type name in sharepoint.
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in Link Enterprise.
custom1
String
required
Name of the folder you would like to create. If using nested the delimiter is #DFLOW#
mdArray
Array
required
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.
enableNested
Boolean
required
true (if wanting each folder to have one child in a nested manner) false (if all children are located under the first folder name) When false and metadata is
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders
fileLocation
String
optional
file location in local system that needs to be stored in sharepoint.
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"

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.
POST
Request
Body Parameters
type
String
optional
Content Type name in sharepoint.
location
String
required
Sharepoint Document Library location (including any sub site present). Each field is separated with "/".
selectedCMS
String
required
Value should always be set to "sp" to let Link Enterprise know which configured content system to search.
cmsName
String
required
Name of the sharepoint system configured in Link Enterprise.
custom1
String
required
Name of the folder you would like to create. If using nested the delimiter is #DFLOW#
mdArray
Array
required
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.
enableNested
Boolean
required
true (if wanting each folder to have one child in a nested manner) false (if all children are located under the first folder name)
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders
fileLocation
String
optional
file location in local system that needs to be stored in sharepoint.
repository
String
required
Sharepoint repository Id. It consists of sharepoint domain name and root site name separated with "/sites/" or ":/teams/"