Microsoft Graph API Sharepoint

The Microsoft Graph API SharePoint connector facilitates interaction with SharePoint resources such as sites, lists, and documents, enabling comprehensive data management and workflow automation.

Microsoft Graph API SharePoint connector allows Swimlane Turbine users to manage content, collaborate on documents, and control document versions within SharePoint. By leveraging this integration, users can automate file uploads, updates, and management tasks, create and organize lists and folders, and maintain strict version control through check-in and check-out functionalities. This connector streamlines SharePoint operations, enhances team collaboration, and ensures data is organized and secure, all within the Swimlane Turbine platform.

The Microsoft Graph API Sharepoint connector allows Swimlane to ingest CRUD operations for lists, list items, sites and files in Sharepoint sites.

Prerequisites

To utilize the Microsoft Graph API SharePoint connector in Swimlane, ensure you have the following prerequisites:

OAuth 2.0 client credentials authentication with these parameters:

URL: Endpoint URL for Microsoft Graph API.

Client ID: Application ID registered in Azure AD to represent the application.

Client Secret: A secret string that the application uses to prove its identity when requesting a token.

Token URL: URL to obtain the access token from Azure AD.

Scope: Permissions the application requires.

Delegated user flow authentication with these parameters:

URL: Endpoint URL for Microsoft Graph API.

Tenant ID: Directory ID of the Azure AD tenant.

Username: The username of the user on behalf of whom the application is authenticating.

Password: The password of the user on behalf of whom the application is authenticating.

Client ID: Application ID registered in Azure AD to represent the application.

Client Secret: A secret string that the application uses to prove its identity when requesting a token.

Capabilities

The Microsoft Graph API Sharepoint connector provides the below capabilities:

Add or Update File

Create Folder

Create List Column

Create List Item

Create List

Delete Folder

Delete List Column

Delete List Item

Drive Item Checkin

Drive Item Checkout

Get File

Get List Columns

Get List Content Types

Get List Item

Get List Items ... and so on

Asset Setup

Client Credential Flow Authentication

Authentication uses Azure application OAuth2. You will need an admin account in Azure to create the application.

Recommended Application Permissions (feel free use custom permissions if you only use certain actions):

User.ReadWrite.All

Directory.ReadWrite.All

Directory.AccessAsUser.All

SecurityEvents.Read.All

SecurityEvents.ReadWrite.All

Mail.ReadWrite

Mail.Send

Sites.ReadWrite.All

Files.ReadWrite.All

Sites.ReadWrite.All is needed by Sharepoint actions only.

In order to set up the asset, you need the following:

Azure Application Client ID

Azure Application Client Secret

Azure Tenant ID

Steps to create the Azure app:

Go to the App Registration page in the Azure portal.

Click New Registration.

Enter a name for your new application and choose Accounts in this organizational directory only, then click Register at the bottom.

Navigate to the API permissions tab on the left navigation menu.

Select Add a permission.

Select Microsoft Graph.

Select Application permissions, then mark all the permissions you need for the actions you are using (See suggested permissions at the top of the asset setup section).

Click the Add permissions button at the bottom of the page.

Select Grant admin consent for your organization, then your permissions should look as below.

Navigate to the Certificates & secrets tab and select New client secret.

Fill out the description and expiration, then click the Add button at the bottom.

The Value of the secret you just created is the Client Secret needed for the Swimlane asset.

Navigate to the Overview tab on the left menu.

The Client ID and Tenant ID needed in the asset are shown on this page.

The Client ID, Tenant ID, and Client Secret described in the steps above are the credentials you need for the asset.

Password Flow (Delegated Auth)

Use Delegated Permissions, instead of Application Permissions, and generate Client ID, Tenant ID, and Client Secret as described in the above Client Credential Flow Authentication.

We also need an Username and a Password for this authentication.

Sites Get Site

All the Sites actions require the site ID to be executed. The site ID can be obtained using the action Sites Get Site, in order to run the action the site_hostname and site_name are needed. This two values can be found in a site URL:

https://.sharepoint.com/sites/

For example if our site URL is https://swimlaneintegrations.sharepoint.com/sites/IntegrationsSite we should use:

site_hostname : swimlaneintegrations

site_name: IntegrationsSite

After the action execution you can find the Site ID on the ID output field.

Sites Create List

In order to create a list with its columns, use the input Columns. You can find all the possible values with its configuration in the official column definition table

Create List Column

Refer to the link to get the Type properties and Column type input. The type properties are documented within the links in the type column.

Get list items

In order to use the filter input please refer to the OData filters section.

The column used to filter the output must be indexed, see the Microsoft documentation to add an index to a list.

Limitations

When using $filter and $orderby in the same query to get messages, make sure to specify properties in the following ways:

Properties that appear in $orderby must also appear in $filter.

Properties that appear in $orderby are in the same order as in $filter.

Properties that are present in $orderby appear in $filter before any properties that aren't.

Failing to do this results in the following error:

Error code: InefficientFilter

Error message: The restriction or sort order is too complex for this operation.

Notes

Microsoft Graph API Sharepoint API Documentation

Azure AD OAuth2 flow

Query Parameters Documentation - OData V4

oauthlib Legacy Application client, this is sort of a hack to bypass manual login (typically required)

Configurations

Password Grant (Delegated Authentication)

Authenticates on behalf of a user using oauth 2.0 credentials

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
login_url		string	Optional
tenant_id		string	Required
oauth_username	The username for authentication	string	Required
oauth_password	The password for authentication	string	Required
oauth_client_id	The client ID	string	Required
oauth_client_secret	The client secret.	string	Required
scope	Permission scopes for this action.	array	Optional
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

MS Graph Sharepoint Oauth 2.0 Client Credentials

Authenticates Sharepoint using oauth 2.0 client credentials

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
token_url	Must start with https://login.microsoftonline.com/ and then continue with the tenant_id, and then be prepended with /oauth2/v2.0/token	string	Required
client_id	The client ID	string	Required
client_secret	The client secret.	string	Required
scope	List of permission scopes for this action.	array	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Add or Update File

Add a new file or update an existing one within Sharepoint, supporting files up to 250 MB. Requires 'drive-id', 'item-id', and file contents.

Endpoint

URL: /v1.0/drives/{{drive-id}}/items/{{item-id}}/content

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.drive-id	string	Required	Parameters for the Add or Update File action
path_parameters.item-id	string	Required	Parameters for the Add or Update File action
file	array	Optional	Parameter for Add or Update File
file.file_name	string	Required	Name of the resource
file.file	string	Required	Parameter for Add or Update File

Input Example

{"json_body":{"file":[]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
audio	object	Output field: audio
bundle	object	Output field: bundle
content	object	Response content
cTag	string	Output field: cTag
deleted	object	Output field: deleted
description	string	Output field: description
file	object	Output field: file
fileSystemInfo	object	Output field: fileSystemInfo
folder	object	Output field: folder
image	object	Output field: image
location	object	Output field: location
malware	object	Output field: malware
package	object	Output field: package
pendingOperations	object	Output field: pendingOperations
photo	object	Output field: photo
publication	object	Output field: publication
remoteItem	object	Output field: remoteItem
root	object	Output field: root
searchResult	object	Result of the operation
shared	object	Output field: shared
sharepointIds	object	Unique identifier
size	number	Output field: size
specialFolder	object	Output field: specialFolder

Output Example

{"audio":{},"bundle":{},"content":{},"cTag":"string","deleted":{},"description":"string","file":{},"fileSystemInfo":{},"folder":{},"image":{},"location":{},"malware":{},"package":{},"pendingOperations":{},"photo":{}}

Create Folder

Creates a new folder within a SharePoint document library, requiring '__metadata' and 'ServerRelativeUrl'.

Endpoint

URL: /_api/web/folders

Method: POST

Input

Argument Name	Type	Required	Description
__metadata	object	Optional	Response data
__metadata.type	string	Required	Response data
ServerRelativeUrl	string	Optional	URL endpoint for the request

Input Example

{"__metadata":{"type":"string"},"ServerRelativeUrl":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":201,"response_headers":{"Content-Type":"application/json;odata=verbose"},"reason":"Created","json_body":{"d":{"Name":"NewFolder","ServerRelativeUrl":"/sites/demo/Shared Documents/NewFolder"}}}

Create List

Creates a new list within a specified site in Microsoft Graph API Sharepoint, requiring the site's unique ID.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Create List action
createdBy	object	Optional	Parameter for Create List
createdDateTime	string	Optional	Time value
description	string	Optional	Parameter for Create List
displayName	string	Optional	Name of the resource
eTag	string	Optional	Parameter for Create List
id	string	Optional	Unique identifier
lastModifiedBy	object	Optional	Parameter for Create List
lastModifiedDateTime	string	Optional	Time value
list	object	Optional	Parameter for Create List
name	string	Optional	Name of the resource
parentReference	object	Optional	Parameter for Create List
sharepointIds	object	Optional	Unique identifier
system	boolean	Optional	Parameter for Create List
webUrl	string	Optional	URL endpoint for the request

Input Example

{"json_body":{"createdBy":{},"createdDateTime":"2021-09-22T14:50:55Z","description":"String","displayName":"String","eTag":"String","id":"String","lastModifiedBy":{},"lastModifiedDateTime":"2021-09-22T14:50:55Z","list":{},"name":"String","parentReference":{},"sharepointIds":{},"system":false,"webUrl":"String"},"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
createdBy	object	Output field: createdBy
createdDateTime	string	Time value
description	string	Output field: description
displayName	string	Name of the resource
eTag	string	Output field: eTag
id	string	Unique identifier
lastModifiedBy	object	Output field: lastModifiedBy
lastModifiedDateTime	string	Time value
list	object	Output field: list
name	string	Name of the resource
parentReference	object	Output field: parentReference
sharepointIds	object	Unique identifier
system	boolean	Output field: system
webUrl	string	URL endpoint for the request

Output Example

{"status_code":201,"response_headers":{"Cache-Control":"no-store, no-cache","Strict-Transport-Security":"max-age=31536000","request-id":"29eecc90-ff91-4911-a77f-f383dbda7d6f","client-request-id":"29eecc90-ff91-4911-a77f-f383dbda7d6f","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00...","Date":"Thu, 08 Feb 2024 07:26:16 GMT"},"reason":"Created","json_body":{"createdBy":{},"createdDateTime":"2021-09-22T14:50:55Z","description"...

Create List Column

Creates a new column in a specified SharePoint list using the Microsoft Graph API, requiring site-id and list-id as path parameters.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/columns

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Create List Column action
path_parameters.list-id	string	Required	Parameters for the Create List Column action
boolean	object	Optional	Parameter for Create List Column
calculated	object	Optional	Parameter for Create List Column
choice	object	Optional	Parameter for Create List Column
columnGroup	string	Optional	Parameter for Create List Column
contentApprovalStatus	object	Optional	Status value
currency	object	Optional	Parameter for Create List Column
dateTime	object	Optional	Time value
defaultValue	object	Optional	Value for the parameter
description	string	Optional	Parameter for Create List Column
displayName	string	Optional	Name of the resource
enforceUniqueValues	boolean	Optional	Value for the parameter
geolocation	object	Optional	Parameter for Create List Column
hidden	boolean	Optional	Unique identifier
hyperlinkOrPicture	object	Optional	Parameter for Create List Column
id	string	Optional	Unique identifier
indexed	boolean	Optional	Parameter for Create List Column
isDeletable	boolean	Optional	Parameter for Create List Column
isReorderable	boolean	Optional	Parameter for Create List Column
isSealed	boolean	Optional	Parameter for Create List Column
lookup	object	Optional	Parameter for Create List Column
name	string	Optional	Name of the resource
number	object	Optional	Parameter for Create List Column
personOrGroup	object	Optional	Parameter for Create List Column

Input Example

{"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd","list-id":"aff85e52-b5a8-42e6-908f-4db58482a587"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
boolean	object	Output field: boolean
calculated	object	Output field: calculated
choice	object	Output field: choice
columnGroup	string	Output field: columnGroup
contentApprovalStatus	object	Status value
currency	object	Output field: currency
dateTime	object	Time value
defaultValue	object	Value for the parameter
description	string	Output field: description
displayName	string	Name of the resource
enforceUniqueValues	boolean	Value for the parameter
geolocation	object	Output field: geolocation
hidden	boolean	Unique identifier
hyperlinkOrPicture	object	Output field: hyperlinkOrPicture
id	string	Unique identifier
indexed	boolean	Output field: indexed
isDeletable	boolean	Output field: isDeletable
isReorderable	boolean	Output field: isReorderable
isSealed	boolean	Output field: isSealed
lookup	object	Output field: lookup
name	string	Name of the resource
number	object	Output field: number
personOrGroup	object	Output field: personOrGroup

Output Example

{"boolean":{},"calculated":{},"choice":{},"columnGroup":"string","contentApprovalStatus":{},"currency":{},"dateTime":{},"defaultValue":{},"description":"string","displayName":"Example Name","enforceUniqueValues":true,"geolocation":{},"hidden":true,"hyperlinkOrPicture":{},"id":"12345678-1234-1234-1234-123456789abc"}

Create List Item

Creates a new item within a specified SharePoint list, requiring both 'site-id' and 'list-id' as path parameters.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/items

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Create List Item action
path_parameters.list-id	string	Required	Parameters for the Create List Item action
contentType	object	Optional	Type of the resource
fields	object	Optional	Parameter for Create List Item
sharepointIds	object	Optional	Unique identifier
activities	array	Optional	Parameter for Create List Item
analytics	object	Optional	Parameter for Create List Item
documentSetVersions	array	Optional	Parameter for Create List Item
driveItem	object	Optional	Parameter for Create List Item
versions	array	Optional	Parameter for Create List Item
id	string	Optional	Unique identifier
name	string	Optional	Name of the resource
createdBy	object	Optional	Parameter for Create List Item
createdDateTime	string	Optional	Time value
description	string	Optional	Parameter for Create List Item
eTag	string	Optional	Parameter for Create List Item
lastModifiedBy	object	Optional	Parameter for Create List Item
lastModifiedDateTime	string	Optional	Time value
parentReference	object	Optional	Parameter for Create List Item
webUrl	string	Optional	URL endpoint for the request

Input Example

{"json_body":{"contentType":{},"fields":{},"sharepointIds":{},"activities":[{}],"analytics":{},"documentSetVersions":[{}],"driveItem":{},"versions":[{}],"id":"string","name":"name of resource","createdBy":{},"createdDateTime":"2022-12-27T17:11:45Z","description":"description of resource","eTag":"string","lastModifiedBy":{},"lastModifiedDateTime":"2022-12-27T17:11:45Z","parentReference":{},"webUrl":"url"},"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd","list-id":"aff85e52-b5a8-42e6-908f-4db58482a587"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
createdDateTime	string	Time value
createdBy	object	Output field: createdBy
createdBy.user	object	Output field: createdBy.user
createdBy.user.displayName	string	Name of the resource
createdBy.user.id	string	Unique identifier
lastModifiedDateTime	string	Time value
lastModifiedBy	object	Output field: lastModifiedBy
lastModifiedBy.user	object	Output field: lastModifiedBy.user
lastModifiedBy.user.displayName	string	Name of the resource
lastModifiedBy.user.id	string	Unique identifier

Output Example

{"status_code":201,"response_headers":{"Cache-Control":"no-store, no-cache","Strict-Transport-Security":"max-age=31536000","request-id":"29eecc90-ff91-4911-a77f-f383dbda7d6f","client-request-id":"29eecc90-ff91-4911-a77f-f383dbda7d6f","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00...","Date":"Thu, 08 Feb 2024 07:26:16 GMT"},"reason":"Created","json_body":{"id":"20","createdDateTime":"2016-08-30T08:26:00Z","createdBy":{"user...

Delete Folder

Remove a specified folder from a SharePoint document library using the server-relative URL.

Endpoint

URL: /_api/web/getfolderbyserverrelativeurl('{{server_relative_url}}')

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.server_relative_url	string	Required	Parameters for the Delete Folder action

Input Example

{"path_parameters":{"server_relative_url":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":204,"response_headers":{"Content-Type":"application/json;odata=verbose"},"reason":"No Content","json_body":{}}

Delete List Column

Removes a specified column from a SharePoint list using the site-id, list-id, and column-id as path parameters.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/columns/{{column-id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Delete List Column action
path_parameters.list-id	string	Required	Parameters for the Delete List Column action
path_parameters.column-id	string	Required	Parameters for the Delete List Column action

Input Example

{"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd","list-id":"aff85e52-b5a8-42e6-908f-4db58482a587","column-id":"6"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"status_code":204,"response_headers":{"Cache-Control":"no-store, no-cache","Strict-Transport-Security":"max-age=31536000","request-id":"29eecc90-ff91-4911-a77f-f383dbda7d6f","client-request-id":"29eecc90-ff91-4911-a77f-f383dbda7d6f","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00...","Date":"Thu, 08 Feb 2024 07:26:16 GMT"},"reason":"No Content","response_text":""}

Delete List Item

Removes a specified item from a SharePoint list using the site-id, list-id, and item-id.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/items/{{item-id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Delete List Item action
path_parameters.list-id	string	Required	Parameters for the Delete List Item action
path_parameters.item-id	string	Required	Parameters for the Delete List Item action

Input Example

{"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd","list-id":"aff85e52-b5a8-42e6-908f-4db58482a587","item-id":"8"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

Drive Item Checkin

Checks in a drive item on Microsoft Graph API Sharepoint, making the document's version available to others. Requires 'driveId' and 'itemId'.

Endpoint

URL: /v1.0/drives/{{driveId}}/items/{{itemId}}/checkin

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.driveId	string	Required	Parameters for the Drive Item Checkin action
path_parameters.itemId	string	Required	Parameters for the Drive Item Checkin action
checkInAs	string	Optional	The status of the document after the check-in operation is complete. Can be published or unspecified.
comment	string	Optional	A check-in comment that is associated with the version.

Input Example

{"json_body":{"checkInAs":"published","comment":"Updating the latest guidelines"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

Drive Item Checkout

Check out a driveItem in SharePoint to lock the document for editing and keep changes private until check-in. Requires 'driveId' and 'itemId'.

Endpoint

URL: /v1.0/drives/{{driveId}}/items/{{itemId}}/checkout

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.driveId	string	Required	Parameters for the Drive Item Checkout action
path_parameters.itemId	string	Required	Parameters for the Drive Item Checkout action

Input Example

{"path_parameters":{"driveId":"string","itemId":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

Get File

Downloads the primary stream (file) of a specified driveItem from Microsoft Graph API Sharepoint, requiring 'drive-id' and 'item-id'.

Endpoint

URL: /v1.0/drives/{{drive-id}}/items/{{item-id}}/content

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.drive-id	string	Required	Parameters for the Get File action
path_parameters.item-id	string	Required	Parameters for the Get File action

Input Example

{"path_parameters":{"drive-id":"string","item-id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
location	string	Output field: location

Output Example

{"status_code":302,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"f71ff5a5-835c-427e-8883-c2a7e4939d53","client-request-id":"f71ff5a5-835c-427e-8883-c2a7e4939d53","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Get List Columns

Retrieve the collection of columnDefinition resources for specified 'site-id' and 'list-id' in Microsoft Graph API Sharepoint.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/columns

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Get List Columns action
path_parameters.list-id	string	Required	Parameters for the Get List Columns action
parameters.count	boolean	Optional	Parameters for the Get List Columns action
parameters.expand	string	Optional	Parameters for the Get List Columns action
parameters.filter	string	Optional	Parameters for the Get List Columns action
parameters.format	string	Optional	Parameters for the Get List Columns action
parameters.orderby	string	Optional	Parameters for the Get List Columns action
parameters.search	string	Optional	Parameters for the Get List Columns action
parameters.select	string	Optional	Parameters for the Get List Columns action
parameters.skip	number	Optional	Parameters for the Get List Columns action
parameters.top	number	Optional	Parameters for the Get List Columns action

Input Example

{"parameters":{"count":true,"expand":"members","filter":"startswith(givenName,J)","format":"json","orderby":"displayName desc","search":"pizza","select":"givenName,surname","skip":11,"top":2},"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd","list-id":"aff85e52-b5a8-42e6-908f-4db58482a587"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
@odata.context	string	Response data
value	array	Value for the parameter
value.columnGroup	string	Value for the parameter
value.description	string	Value for the parameter
value.displayName	string	Name of the resource
value.enforceUniqueValues	boolean	Value for the parameter
value.hidden	boolean	Unique identifier
value.id	string	Unique identifier
value.indexed	boolean	Value for the parameter
value.name	string	Name of the resource
value.readOnly	boolean	Value for the parameter
value.required	boolean	Value for the parameter

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"0da6c0d2-49ca-4b4f-8f89-bffe60826baf","client-request-id":"0da6c0d2-49ca-4b4f-8f89-bffe60826baf","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Get List Content Types

Retrieve the collection of content type resources from a specified list in Microsoft Graph API Sharepoint, requiring 'site-id' and 'list-id'.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/contentTypes

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Get List Content Types action
path_parameters.list-id	string	Required	Parameters for the Get List Content Types action
parameters.count	boolean	Optional	Retrieves the total count of matching resources.
parameters.expand	string	Optional	Retrieves related resources.
parameters.filter	string	Optional	Filters results (rows).
parameters.format	string	Optional	Returns the results in the specified media format.
parameters.orderby	string	Optional	Orders results.
parameters.search	string	Optional	Returns results based on search criteria.
parameters.select	string	Optional	Filters properties (columns).
parameters.skip	number	Optional	Indexes into a result set.
parameters.top	number	Optional	Sets the page size of results.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
@odata.context	string	Response data
value	array	Value for the parameter
[email protected]	string	Response data
value.id	string	Unique identifier
value.description	string	Value for the parameter
value.group	string	Value for the parameter
value.hidden	boolean	Unique identifier
value.name	string	Name of the resource
value.parentId	string	Unique identifier
value.readOnly	boolean	Value for the parameter
value.sealed	boolean	Value for the parameter
value.base	object	Value for the parameter
value.base.id	string	Unique identifier
value.base.description	string	Value for the parameter
value.base.group	string	Value for the parameter
value.base.hidden	boolean	Unique identifier
value.base.name	string	Name of the resource
value.base.readOnly	boolean	Value for the parameter
value.base.sealed	boolean	Value for the parameter

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"cc478c80-5fcc-4301-9ea0-626ebeafc1d7","client-request-id":"cc478c80-5fcc-4301-9ea0-626ebeafc1d7","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Get List Item

Retrieves metadata for a specified item from a list in Microsoft Graph API Sharepoint, requiring site-id, list-id, and item-id.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/items/{{item-id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Get List Item action
path_parameters.list-id	string	Required	Parameters for the Get List Item action
path_parameters.item-id	string	Required	Parameters for the Get List Item action
parameters.count	boolean	Optional	Retrieves the total count of matching resources.
parameters.expand	string	Optional	Retrieves related resources.
parameters.filter	string	Optional	Filters results (rows).
parameters.format	string	Optional	Returns the results in the specified media format.
parameters.orderby	string	Optional	Orders results.
parameters.search	string	Optional	Returns results based on search criteria.
parameters.select	string	Optional	Filters properties (columns).
parameters.skip	number	Optional	Indexes into a result set.
parameters.top	number	Optional	Sets the page size of results.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
error	object	Error message if any
error.code	string	Error message if any
error.message	string	Response message
error.innerError	object	Error message if any
error.innerError.date	string	Error message if any
error.innerError.request-id	string	Unique identifier
error.innerError.client-request-id	string	Unique identifier

Output Example

{"status_code":400,"response_headers":{"Cache-Control":"max-age=0, private","Transfer-Encoding":"chunked","Content-Type":"application/json","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"937766e5-deb9-4c1d-a23e-d196e9b3df2c","client-request-id":"937766e5-deb9-4c1d-a23e-d196e9b3df2c","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E\",\"Ring\":\"2\",\"ScaleUnit\":\"00...","Date":"Wed, 14 Feb 2024 1...

Get List Items

Retrieve a collection of items from a specified list in Microsoft Graph API Sharepoint using 'site-id' and 'list-id'.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/items

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Get List Items action
path_parameters.list-id	string	Required	Parameters for the Get List Items action
parameters.expand	string	Optional	Retrieves related resources.

Input Example

{"parameters":{"expand":"members"},"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd","list-id":"aff85e52-b5a8-42e6-908f-4db58482a587"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
@odata.context	string	Response data
value	array	Value for the parameter
[email protected]	string	Response data
value.createdDateTime	string	Value for the parameter
value.eTag	string	Value for the parameter
value.id	string	Unique identifier
value.lastModifiedDateTime	string	Value for the parameter
value.webUrl	string	URL endpoint for the request
value.createdBy	object	Value for the parameter
value.createdBy.user	object	Value for the parameter
value.createdBy.user.displayName	string	Name of the resource
value.lastModifiedBy	object	Value for the parameter
value.lastModifiedBy.application	object	Value for the parameter
value.lastModifiedBy.application.id	string	Unique identifier
value.lastModifiedBy.application.displayName	string	Name of the resource
value.lastModifiedBy.user	object	Value for the parameter
value.lastModifiedBy.user.displayName	string	Name of the resource
value.parentReference	object	Value for the parameter
value.parentReference.id	string	Unique identifier
value.parentReference.siteId	string	Unique identifier
value.contentType	object	Type of the resource
value.contentType.id	string	Unique identifier
value.contentType.name	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"3fe9f673-6979-4082-853b-e3b27c150193","client-request-id":"3fe9f673-6979-4082-853b-e3b27c150193","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Get Lists

Retrieves a collection of lists from a specified site in Microsoft Graph API Sharepoint, requiring the 'site-id' as a path parameter.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Get Lists action

Input Example

{"path_parameters":{"site-id":"ea1e61eb-9941-4e3e-8155-5f4c484d7afd"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
@odata.context	string	Response data
value	array	Value for the parameter
[email protected]	string	Response data
value.createdDateTime	string	Value for the parameter
value.description	string	Value for the parameter
value.eTag	string	Value for the parameter
value.id	string	Unique identifier
value.lastModifiedDateTime	string	Value for the parameter
value.name	string	Name of the resource
value.webUrl	string	URL endpoint for the request
value.displayName	string	Name of the resource
value.createdBy	object	Value for the parameter
value.createdBy.user	object	Value for the parameter
value.createdBy.user.email	string	Value for the parameter
value.createdBy.user.id	string	Unique identifier
value.createdBy.user.displayName	string	Name of the resource
value.lastModifiedBy	object	Value for the parameter
value.lastModifiedBy.user	object	Value for the parameter
value.lastModifiedBy.user.email	string	Value for the parameter
value.lastModifiedBy.user.id	string	Unique identifier
value.lastModifiedBy.user.displayName	string	Name of the resource
value.parentReference	object	Value for the parameter
value.parentReference.siteId	string	Unique identifier

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"af55c5ad-270b-4d94-a6ef-90369771b43c","client-request-id":"af55c5ad-270b-4d94-a6ef-90369771b43c","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Get Site

Retrieve details of a specific SharePoint site by using the unique site-id provided as a path parameter.

Endpoint

URL: /v1.0/sites/{{site-id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Get Site action

Input Example

{"path_parameters":{"site-id":"swimlaneintegrations.sharepoint.com"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
@odata.context	string	Response data
createdDateTime	string	Time value
description	string	Output field: description
id	string	Unique identifier
lastModifiedDateTime	string	Time value
name	string	Name of the resource
webUrl	string	URL endpoint for the request
displayName	string	Name of the resource
root	object	Output field: root
siteCollection	object	Output field: siteCollection
siteCollection.hostname	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"f71ff5a5-835c-427e-8883-c2a7e4939d53","client-request-id":"f71ff5a5-835c-427e-8883-c2a7e4939d53","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

List Column Definitions

Retrieve a collection of columnDefinition resources from a specified list in Microsoft Graph API Sharepoint, requiring site-id and list-id.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/columns

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the List Column Definitions action
path_parameters.list-id	string	Required	Parameters for the List Column Definitions action
parameters.count	boolean	Optional	Retrieves the total count of matching resources.
parameters.expand	string	Optional	Retrieves related resources.
parameters.filter	string	Optional	Filters results (rows).
parameters.format	string	Optional	Returns the results in the specified media format.
parameters.orderby	string	Optional	Orders results.
parameters.search	string	Optional	Returns results based on search criteria.
parameters.select	string	Optional	Filters properties (columns).
parameters.skip	number	Optional	Indexes into a result set.
parameters.top	number	Optional	Sets the page size of results.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
@odata.context	string	Response data
value	array	Value for the parameter
value.columnGroup	string	Value for the parameter
value.description	string	Value for the parameter
value.displayName	string	Name of the resource
value.enforceUniqueValues	boolean	Value for the parameter
value.hidden	boolean	Unique identifier
value.id	string	Unique identifier
value.indexed	boolean	Value for the parameter
value.name	string	Name of the resource
value.readOnly	boolean	Value for the parameter
value.required	boolean	Value for the parameter

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"63ebb3e2-926f-4116-a1ab-52a732e7906b","client-request-id":"63ebb3e2-926f-4116-a1ab-52a732e7906b","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Rename Folder

Renames a folder within a SharePoint document library by updating its server-relative URL.

Endpoint

URL: /_api/web/getfolderbyserverrelativeurl('{{old_server_relative_url}}')/moveto(newurl='{{new_server_relative_url}}',flags=1)

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.old_server_relative_url	string	Required	Parameters for the Rename Folder action
path_parameters.new_server_relative_url	string	Required	Parameters for the Rename Folder action

Input Example

{"path_parameters":{"old_server_relative_url":"string","new_server_relative_url":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Content-Type":"application/json;odata=verbose"},"reason":"OK","json_body":{}}

Update List Item

Updates a specified list item's properties in Microsoft Graph API Sharepoint using site-id, list-id, and item-id.

Endpoint

URL: /v1.0/sites/{{site-id}}/lists/{{list-id}}/items/{{item-id}}/fields

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.site-id	string	Required	Parameters for the Update List Item action
path_parameters.list-id	string	Required	Parameters for the Update List Item action
path_parameters.item-id	string	Required	Parameters for the Update List Item action
headers	object	Optional	HTTP headers for the request
headers.if-match	string	Optional	etag. If this request header is included and the eTag provided does not match the current eTag on the item, a 412 Precondition Failed response is returned and the item will not be updated.
Author	string	Optional	Parameter for Update List Item
AuthorLookupId	string	Optional	Unique identifier
Color	string	Optional	Parameter for Update List Item
Name	string	Optional	Name of the resource
Quantity	number	Optional	Parameter for Update List Item

Input Example

{"json_body":{"Author":"Brad Cleaver","AuthorLookupId":"13","Color":"Red","Name":"Kangaroos and Wallabies: A Deep Dive","Quantity":350},"headers":{"if-match":"etag"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Name	string	Name of the resource
Color	string	Output field: Color
Quantity	number	Output field: Quantity

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-store, no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=f...","Content-Encoding":"gzip","Vary":"Accept-Encoding","Strict-Transport-Security":"max-age=31536000","request-id":"f71ff5a5-835c-427e-8883-c2a7e4939d53","client-request-id":"f71ff5a5-835c-427e-8883-c2a7e4939d53","x-ms-ags-diagnostic":"{\"ServerInfo\":{\"DataCenter\":\"South India\",\"Slice\":\"E...

Upload File

Uploads a file to a specified SharePoint document library folder using the server-relative URL and file name.

Endpoint

URL: /_api/web/getfolderbyserverrelativeurl('{{folder_server_relative_url}}')/files/add(overwrite=true,url='{{file_name}}')

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.folder_server_relative_url	string	Required	Parameters for the Upload File action
path_parameters.file_name	string	Required	Parameters for the Upload File action
files	object	Required	File to be analysed
files.file	string	Optional	Parameter for Upload File
files.file_name	string	Optional	Name of the resource

Input Example

{"path_parameters":{"folder_server_relative_url":"string","file_name":"Example Name"},"files":{"file":"string","file_name":"Example Name"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":201,"response_headers":{"Content-Type":"application/json;odata=verbose"},"reason":"Created","json_body":{"d":{"Name":"example.txt","ServerRelativeUrl":"/sites/demo/Shared Documents/FolderName/example.txt"}}}

Response Headers

Header	Description	Example
Cache-Control	Directives for caching mechanisms	max-age=0, private
client-request-id	HTTP response header: client-request-id	cc478c80-5fcc-4301-9ea0-626ebeafc1d7
Content-Encoding	HTTP response header: Content-Encoding	gzip
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Wed, 14 Feb 2024 14:47:46 GMT
OData-Version	HTTP response header: OData-Version	4.0
request-id	HTTP response header: request-id	63ebb3e2-926f-4116-a1ab-52a732e7906b
Strict-Transport-Security	HTTP response header: Strict-Transport-Security	max-age=31536000
Transfer-Encoding	HTTP response header: Transfer-Encoding	chunked
Vary	HTTP response header: Vary	Accept-Encoding
x-ms-ags-diagnostic	HTTP response header: x-ms-ags-diagnostic	{"ServerInfo":{"DataCenter":"South India","Slice":"E","Ring":"2","ScaleUnit":"000","RoleInstance":"MA1PEPF0000496C"}}