Nav

SharePoint Connector Reference

SharePoint Online Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

  • Okta

  • Online

  • Security Token

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

SharePoint Online Connection Types

Okta

Parameters

Name Type Description Default Value Required

Username

String

Username that you want to login with against Okta Identity Provider.

x

Password

String

Password for the user that you are going to login against Okta Identity Provider.

x

Okta Domain

String

Domain name for Okta Identity Provider.

x

Okta API token

String

x

SharePoint Online embedded link from Okta

String

x

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Online

Parameters

Name Type Description Default Value Required

Username

String

Username that you want to login with. Domain should not be included.

x

Password

String

Password for the user that you are going to login.

x

Site Url

String

URL for the SharePoint instance that the connector is going to interact with.

x

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Security Token

Parameters

Name Type Description Default Value Required

Security Token

String

x

Security Token Provider

SecurityTokenProvider

(Optional) Provider instance that provides the security token when required.

Site Url

String

URL for the SharePoint instance that the connector is going to interact with.

x

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Operations

  • Attach File (attach-file)

  • File Add (file-add)

  • File Approve (file-approve)

  • File Check In (file-check-in)

  • File Check Out (fileCheck-out)

  • File CopyTo (file-copy-to)

  • File Delete (file-delete)

  • File Deny (file-deny)

  • File Get Content (file-get-content)

  • File Publish (file-publish)

  • File Query (file-query)

  • File Recycle (file-recycle)

  • File Undo Check Out (file-undo-check-out)

  • File Unpublish (file-unpublish)

  • File Update Metadata (file-update-metadata)

  • Folder Create (folder-create)

  • Folder Delete (folder-delete)

  • Folder Query (folder-query)

  • Get Metadata (get-metadata)

  • List Create (list-create)

  • List Delete (list-delete)

  • List Get (list-get)

  • List Get All (list-get-all)

  • List Item Create (list-item-create)

  • List Item Delete (list-item-delete)

  • List Item Query (list-item-query)

  • List Item Update (list-item-update)

  • List Update (list-update)

  • Resolve Collection (resolve-collection)

  • Resolve Object (resolve-object)

SharePoint On-Premise Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

  • Claims

  • Kerberos

  • Ntlm

  • Security Token

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

SharePoint On-Premise Connection Types

Claims

Parameters

Name Type Description Default Value Required

Username

String

Username that you want to login with. Domain should not be included.

x

Password

String

Password for the user that you are going to login.

x

Site Url

String

URL for the SharePoint instance that the connector is going to interact with.

x

Sts Url

String

Security Token Service URL to use for claims authentication

x

Scope

String

Application Identifier configured for this SharePoint Site in the Sts (a.k.a. 'Relying Party Identifier', 'Client Identifier', 'Scope' or 'Realm').

x

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Kerberos

Parameters

Name Type Description Default Value Required

Username

String

Username that you want to login with. Domain should not be included.

x

Password

String

Password for the user that you are going to login.

x

Site Url

String

URL for the SharePoint instance that the connector is going to interact with.

x

SPN

String

(Optional) SPN for the SharePoint Web Service.

Realm

String

(Optional) The case-sensitive default realm (Domain Name) that the user belongs to.

KDC

String

(Optional) The KDC (usually the Domain Controller name) to authenticate the user.

Login Properties File Path

String

(Optional) Path to a customized Login Properties File. When not specified, default values which usually work for most cases are set up.

Kerberos Properties File Path

String

(Optional) Path to a customized Kerberos Properties File.

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

NTLM

Parameters

Name Type Description Default Value Required

Domain

String

Domain name to use for NTLM auth

x

Username

String

Username that you want to login with. Domain should not be included.

x

Password

String

Password for the user that you are going to login.

x

Site Url

String

URL for the SharePoint instance that the connector is going to interact with.

x

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Security Token

Parameters

Name Type Description Default Value Required

Security Token

String

x

Security Token Provider

SecurityTokenProvider

(Optional) Provider instance that provides the security token when required.

Site Url

String

URL for the SharePoint instance that the connector is going to interact with.

x

Disable SSL certificate validation

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception. To prevent this, it is possible to disable the CN (Common Name) check. Note: This is not recommended for production environments.

false

Proxy Settings

One of:

  • proxy

  • ntlm-proxy

Settings for the proxy server that the connector is going to send data through.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Operations

  • Attach File (attach-file)

  • File Add (file-add)

  • File Approve (file-approve)

  • File Check In (file-check-in)

  • File Check Out (fileCheck-out)

  • File CopyTo (file-copy-to)

  • File Delete (file-delete)

  • File Deny (file-deny)

  • File Get Content (file-get-content)

  • File Publish (file-publish)

  • File Query (file-query)

  • File Recycle (file-recycle)

  • File Undo Check Out (file-undo-check-out)

  • File Unpublish (file-unpublish)

  • File Update Metadata (file-update-metadata)

  • Folder Create (folder-create)

  • Folder Delete (folder-delete)

  • Folder Query (folder-query)

  • Get Metadata (get-metadata)

  • List Create (list-create)

  • List Delete (list-delete)

  • List Get (list-get)

  • List Get All (list-get-all)

  • List Item Create (list-item-create)

  • List Item Delete (list-item-delete)

  • List Item Query (list-item-query)

  • List Item Update (list-item-update)

  • List Update (list-update)

  • Resolve Collection (resolve-collection)

  • Resolve Object (resolve-object)

Operations

Attach File

<sharepoint:attach-file>

Attach a File to an item from a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Title

String

(Mandatory) Title of the list the item belongs to.

x

Attachment Info

AttachmentInformation

(Mandatory) the attachment information. Contains the itemId of the list item, the file name and the file content represented as a stream. The stream and file name must be given if localFilePath is empty.

Local File Path

String

The path to the file. Mandatory if the attachmentInfo is not filled with the relevant file information.

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Add

<sharepoint:file-add>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

x

File Content Stream

Binary

Local File Path

String

Overwrite

Boolean

false

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type SharePointFile

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Approve

<sharepoint:file-approve>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Comment

String

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Check In

<sharepoint:file-check-in>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Check In Type

Enumeration, one of:

  • MINOR_CHECK_IN

  • MAJOR_CHECK_IN

  • OVERWRITE_CHECK_IN

x

Comment

String

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Check Out

<sharepoint:file-check-out>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Copy To

<sharepoint:file-copy-to>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

New File Server Relative Url

String

x

Overwrite

Boolean

false

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Delete

<sharepoint:file-delete>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Deny

<sharepoint:file-deny>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Comment

String

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Get Content

<sharepoint:file-get-content>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Binary

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Publish

<sharepoint:file-publish>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Comment

String

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Query

<sharepoint:file-query>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

x

Starting Folder Path

String

/

Recursive

Boolean

false

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Recycle

<sharepoint:file-recycle>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type String

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Undo Check Out

<sharepoint:file-undo-check-out>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Unpublish

<sharepoint:file-unpublish>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Comment

String

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

File Update Metadata

<sharepoint:file-update-metadata>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

x

Update Properties

Object

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Folder Create

<sharepoint:folder-create>

Creates a folder in a document list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Url

String

(Mandatory) Server relative URL of the folder to create, for example, /Shared Documents/new folder, creates a folder in the Shared Documents list.

Welcome Page

String

(Optional) Welcome page property of the folder, for example, index.html.

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type SharePointFolder

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Folder Delete

<sharepoint:folder-delete>

Deletes a folder from a document list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Url

String

(Mandatory) Server relative URL of the folder to delete, for example, /Shared Documents/new folder, deletes 'new folder' from 'Shared Documents' list

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Folder Query

<sharepoint:folder-query>

Retrieves all folders that matches the specified criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

(Mandatory) OData query in the format listDocumentName?queryString, for example, Shared Documents?$select=Name&$filter Name for example, folderName

x

Starting Folder Path

String

(Optional) The starting path of the folder from where to begin the query, relative to the document library selected as part of the query below, for example, /myfolder/level2 search for folders inside /document library/myfolder/level2. Note: You must specify the document library as part of the query below.

/

Recursive

Boolean

Specifies whether to search recursively in inner folders

false

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Get Metadata

<sharepoint:get-metadata>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Server Relative Url

String

#[payload]

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type SharePointFile

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Create

<sharepoint:list-create>

Creates a new SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List

SharePointList

(Mandatory) SharePoint List reference to create

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type SharePointList

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Delete

<sharepoint:list-delete>

Deletes a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Id

String

(Mandatory) ID of the list to delete.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Get

<sharepoint:list-get>

Retrieves a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Id

String

(Mandatory) ID of the list to retrieve

#[payload]

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type SharePointList

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Get All

<sharepoint:list-get-all>

Retrieves all SharePoint lists.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of SharePointList

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Item Create

<sharepoint:list-item-create>

Creates a new item in an existing SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Id

String

(Mandatory) ID of the list where to create the Item.

x

Properties

Object

(Mandatory) Properties of the item to create.

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Item Delete

<sharepoint:list-item-delete>

Deletes an item from a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Id

String

(Mandatory) ID of the list where to delete the Item.

x

Item Id

String

(Mandatory) ID of the item to delete.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Item Query

<sharepoint:list-item-query>

Executes a query against a SharePoint list and returns list items that match the specified criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

Query in the format listId?queryString

x

Retrieve References

Boolean

Retrieve full objects for reference fields. Note: Large lists with many reference fields can take a long time to retrieve.

false

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure to use repeatable streams and their behavior.

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:UNKNOWN

List Item Update

<sharepoint:list-item-update>

Updates an Item from a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Id

String

(Mandatory) ID of the list where to update the Item

x

Item Id

String

(Mandatory) ID of the item to update

x

Updated Properties

Object

(Mandatory) Item properties to update

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

List Update

<sharepoint:list-update>

Updates the specified properties of a SharePoint lists.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List Id

String

(Mandatory) ID of the list to update

x

List

SharePointList

(Mandatory) List Properties to update

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Resolve Collection

<sharepoint:resolve-collection>

Executes an HTTP GET against the SharePoint API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Url

String

(Mandatory) The absolute or relative url to get.

x

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Resolve Object

<sharepoint:resolve-object>

Executes an HTTP GET against the SharePoint API (POST if body is a blob).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Url

String

(Mandatory) The absolute or relative url to get.

x

Request Type

Enumeration, one of:

  • Get

  • Create

  • Merge

  • Delete

The request type to be sent.

Get

Request Body

Any

Body of the request to send. 'null' if empty request body.

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sharepoint-online

  • sharepoint-onpremise

Throws

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:CONNECTIVITY

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Attachment Information

Field Type Description Default Value Required

File Content Stream

Binary

File Name

String

Item Id

String

SharePoint File

Field Type Description Default Value Required

Author

Object

Check In Comment

String

Check Out Type

String

Checked Out By User

Object

Content Tag

String

Customized Page Status

String

E Tag

String

Exists

Boolean

Length

Number

Level

Number

Linking Url

String

List Item All Fields

Object

Locked By User

Object

Major Version

Number

Metadata

Object

Minor Version

Number

Modified By

Object

Name

String

Server Relative Url

String

Time Created

String

Time Last Modified

String

Title

String

U I Version

Number

U I Version Label

String

Unique Id

String

Versions

Object

SharePoint Folder

Field Type Description Default Value Required

Exists

Boolean

Files

Object

Folders

Object

Item Count

Number

List Item All Fields

Object

Metadata

Object

Name

String

Parent Folder

Object

Properties

Object

Server Relative Url

String

Time Created

String

Time Last Modified

String

Unique Id

String

Welcome Page

String

SharePoint List

Field Type Description Default Value Required

Allow Content Types

Boolean

Base Template

Enumeration, one of:

  • ACCESS_REQUEST

  • ADMIN_TASKS

  • AGENDA

  • ANNOUNCEMENTS

  • APP_DATA_CATALOG

  • CALL_TRACK

  • CATEGORIES

  • CIRCULATION

  • COMMENTS

  • CONTACTS

  • CUSTOM_GRID

  • DATA_CONNECTION_LIBRARY

  • DATASOURCES

  • DECISION

  • DESIGN_CATALOG

  • DEVELOPER_SITE_DRAFT_APPS

  • DISCUSSION_BOARD

  • DOCUMENT_LIBRARY

  • EVENTS

  • EXTERNAL_LIST

  • FACILITY

  • GANTT_TASKS

  • GENERIC_LIST

  • HEALTH_REPORTS

  • HEALTH_RULES

  • HELP_LIBRARY

  • HOLIDAYS

  • HOME_PAGE_LIBRARY

  • IME_DIC

  • ISSUE_TRACKING

  • LINKS

  • LIST_TEMPLATE_CATALOG

  • MAINTENANCE_LOGS

  • MASTER_PAGE_CATALOG

  • MEETING_OBJECTIVE

  • MEETING_USER

  • MEETINGS

  • MY_SITE_DOCUMENT_LIBRARY

  • NO_CODE_PUBLIC

  • NO_CODE_WORKFLOWS

  • PICTURE_LIBRARY

  • POSTS

  • SOLUTION_CATALOG

  • SURVEY

  • TASKS

  • TASKS_WITH_TIMELINE_AND_HIERARCHY

  • TEXT_BOX

  • THEME_CATALOG

  • THINGS_TO_BRING

  • TIMECARD

  • USER_INFORMATION

  • WEB_PAGE_LIBRARY

  • WEB_PART_CATALOG

  • WEB_TEMPLATE_CATALOG

  • WHEREABOUTS

  • WORKFLOW_HISTORY

  • WORKFLOW_PROCESS

  • XML_FORM

Base Type

Number

Content Types

Object

Content Types Enabled

Boolean

Crawl Non Default Views

Boolean

Creatables Info

Object

Created

String

Default Content Approval Workflow Id

String

Default Display Form Url

String

Default Edit Form Url

String

Default New Form Url

String

Default View

Object

Description

String

Description Resource

Object

Direction

Enumeration, one of:

  • NONE

  • LTR

  • RTL

Document Template Url

String

Draft Version Visibility

Enumeration, one of:

  • READER

  • AUTHOR

  • APPROVER

Enable Attachments

Boolean

Enable Folder Creation

Boolean

Enable Minor Versions

Boolean

Enable Moderation

Boolean

Enable Versioning

Boolean

Entity Type Name

String

Event Receivers

Object

Fields

Object

First Unique Ancestor Securable Object

Object

Force Checkout

Boolean

Forms

Object

Has External Data Source

Boolean

Hidden

Boolean

Id

String

Image Url

String

Information Rights Management Settings

Object

Irm Enabled

Boolean

Irm Expire

Boolean

Irm Reject

Boolean

Is Application List

Boolean

Is Catalog

Boolean

Is Private

Boolean

Item Count

Number

Items

Object

Last Item Deleted Date

String

Last Item Modified Date

String

List Item Entity Type Full Name

String

Major Version Limit

Number

Major With Minor Versions Limit

Number

Metadata

Object

Multiple Data List

Boolean

No Crawl

Boolean

On Quick Launch

Boolean

Parent Web

Object

Parent Web Url

String

Parser Disabled

Boolean

Role Assignments

Object

Root Folder

Object

Server Template Can Create Folders

Boolean

Template Feature Id

String

Title

String

Title Resource

Object

User Custom Actions

Object

Validation Formula

String

Validation Message

String

Views

Object

Workflow Associations

Object

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to keep in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit in buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum amount of instances to keep in memory. If more memory is required, then it buffers the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Ntlm Proxy

Field Type Description Default Value Required

Ntlm Domain

String

Host

String

x

Port

Number

x

Username

String

Password

String

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.

+