Breadcrumbs

Sharepoint Connector v1.0

1. Prerequisites and Additional Steps, Developer Key

 

a. SharePoint App setup on Azure Portal


image-20241231-063836.png


 

1.1.1 New App Registration

From the top header search box search for “App Registrations“, then select App Registration and click on the New Registration button:

image-20241231-063851.png


 

Fill out the new app form with the required details and click on the Register button.

image-20230106-145941.png

 

After creating a new app, the page is redirected to the App overview page.

image-20241231-063913.png


 

1.1.2 Create New Credentials

First click on the Certificates & Secrets menu on the left side, select Client Secrets menu from the middle menu and click “+New Client Secret” button to add a new client secret.

image-20230106-150224.png

 

Click on the New client secret button.

Provide the description and validity of that secret value and click on the Add button.

image-20230106-150332.png

 

Important: After the successful creation of the secret, it shows the secret ID and value. Please note this secret value for later use. It will be encrypted and not visible later. This secret value will be used for OAuth integration purposes.

 

You will see, your client’s secret is listed.

image-20241231-063934.png


 

1.1.3 Adding API Permissions

Go to the API permission screen from Menubar for adding the required permissions. Click on Add a permission button.

image-20230106-151832.png

 

Select the Microsoft Graph option:

image-20230106-151936.png

 

Application Permission for SharePoint Sites. Click on the Application permission button:

image-20230515-064228.png

 

From the search box, search for “Sites“ and under Sites, choose relevant permissions(For read/write/Manage Sites permissions) and click on Add permission.

image-20230515-064318.png

 

Now select the delegated permissions and from the search box, search for “Sites“ again

image-20230106-152007.png

 

Choose relevant permissions(For read/write OneDrive files permissions) and click on Add permission.

image-20230106-152151.png

 

Also, in the same way, find Offline Access permission, select it and click on Add permission.

image-20230515-065150.png

 

After adding permission, click on the Grant admin consent button. (This action can only be applied by the Azure Admin)

image-20230515-065309.png

 

1.1.4 Configure Platform, Authentication Type & Callback URL

Select the Authentication section from the left menu and click on Add a platform button:

image-20230106-153616.png

 

Choose the Web platform.

image-20230106-153730.png

 

Fill in the Redirect URIs field and click on the Configure button.

image-20241231-064009.png


 

Choose other settings shown below:

image-20230106-154205.png

 

1.1.5 Expose an API

Go to the Export an API section from the left menu and click on Add a scope button.

image-20230106-165324.png

 

Click on save and continue.

image-20241231-064024.png


 

Provide the required details and choose “Admin and Users” as consent:

image-20241231-064037.png


 

b. SharePoint Office Portal

Log into SharePoint Portal with the correct credentials.

image-20241231-064106.png


image-20230407-092049.png

 

Click Pages from the left menu.

image-20230407-092259.png

 

Follow these steps to create new custom fields. Later we can link those fields with site and lists:

 

1-Navigate to settings from the top-right and click the settings icon. Then, select Site Settings

image-20230407-092739.png

2-Click Site Columns under Web Designer Galleries.

image-20230407-092800.png

3-Click Create.

image-20230407-092930.png

4-Fill column name field and type.

image-20230407-092958.png

5-Fill these fields as seen in the below screenshot and click OK.

image-20230407-093015.png
image-20230407-093137.png

2. Connector Action & Tests

 

Action Name / Method

Get Items by Path (GET)

Action Description

Get items from SharePoint drive by providing complete path

Test Case

Items are retrieved from specified path

Request Body Name

Parameter

Type

Description (Example)

 

Itempath

String

  1. /sites/<SITE-ID>/drives/<DRIVE-ID>/root:/<FOLDER-NAME>:/children

  2. /sites/yoursite/Shared Documents

  3. /sites/yoursite/Shared Documents/Your Folder

  4. /sites/yoursite/Shared Documents/Your Folder/Your Document.docx

Access files directly with path:

  1. /sites/<site-id>/drives/<drive-id>/id/root:/<folder-path>/<File>
    Example: /sites/xxxxx/drives/xxxxxxx/root:/FromSharepoint/Excel315.xlsx

image-20240116-132734.png
image-20240118-102337.png

Action Name / Method

Get my organization's default site collection (GET)

Action Description

Get my organization's default site collection (GET)

Test Case

Get default site collection of an Organization

Request Body Name

Parameter

Type

Description (Example)

 

 


 

image-20230409-141633.png

 

Action Name / Method

Get site lists (GET)

Action Description

Get site lists (GET)

Test Case

Get site list of an Organization

Request Body Name

Parameter

Type

Description (Example)

 

 


 

image-20230409-141921.png

Action Name / Method

Get Site ID (GET)

Action Description

Get Site ID (GET)

Test Case

Get id of site by name

Request Body Name

Parameter

Type

Description (Example)

 

 


 

image-20230409-142120.png

 

Action Name / Method

Get Drive ID (GET)

Action Description

Get Drive ID (GET)

Test Case

Get drive id of an site

Request Body Name

Parameter

Type

Description (Example)

 

Site ID

String

cyangatte.sharepoint.com,fbd3a474-a618-4ecd-a590-9df1804dc9f5,dc63793d-18ce-43b9-970f-d74a5f9e

image-20230409-142227.png

 

Action Name / Method

Get Drive/Folder Items (GET)

Action Description

Get Drive/Folder Items (GET)

Test Case

Get objects of an drive by providing drive id

Request Body Name

Parameter

Type

Description (Example)

 

Drive ID

String

b!dKTT-ximzU6lkJ3xgE3J9T15Y9zOGLlDlw_XSl_nbuAdl

image-20230409-142412.png

 

Action Name / Method

Search for site by name (GET)

Action Description

Search for site by name (GET)

Test Case

Search site using query

Request Body Name

Parameter

Type

Description (Example)

 

Search

String

OneTegTeamPk

image-20230409-142615.png

3. Connection Settings and Configuration

image-20241231-064253.png


image-20241231-064314.png