Microsoft SharePoint On-premises (REST API)

Create a Microsoft SharePoint on-premises connection using the DryvIQ REST API.


Creating a Basic Connection

Create a basic SharePoint connection at the following endpoint.

GET {{url}}v1/connections/platforms/SharePoint/new

Create a Connection with Applicable Authorization Type

Verify your instance support forms. In rare instances, a misconfiguration in SharePoint on-premises can falsely report that Forms are supported. If you are experiencing connection issues with SharePoint, you may need to configure for NTLM authentication for the auth_type parameter.

POST {{url}}v1/connections/
{
 "name": "SharePoint 2016",
 "platform": {
   "id": "sharepoint"
 },
 "auth": {
   "uri":"http://url.com",
   "username":"USER",
   "password":"PASSWORD",
   "auth_type":"ntlm"    
 }
}

Creating a Job

The example below shows a simple job for a SharePoint connection created as a standard user without impersonation.

POST {{url}}v1/jobs
{
   "name":"Simple Job",
   "kind": "transfer",
   "transfer": {
     "transfer_type": "copy",
       "source": {
           "connection": { "id": "{{SharePoint_Connection_sourceID}}" },
           "target": {
               "path": "/sourceDocumentLibrary"
           }
       },
       "destination": {
           "connection": { "id": "{{Box_Connection_destinationID}}" },
           "target": {
               "path": "/destinationFolder"
           }
       },
       "simulation_mode": false
   },
   "schedule": {
       "mode": "manual"
   },
   "stop_policy": {
       "on_success": 5,
       "on_failure": 5,
       "on_execute": 25
   },
   "category": {
     "name": "Report {Name}"
   }
}