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