Connected Systems

Introduction

This article provides details of the various types of connected systems. Each connected system is custom for the service it connects to, and it will tailor fit integrations that use this connected system with fields specific to that third party system.

Common Properties

Each connected system has the following properties:

Field Description
Name The name of the connected system. Use a name that will uniquely identify this connection to the external system.
Description Supplemental information about the connected system that is displayed when selecting the system in the integration designer and in the application contents grid.

OpenAPI

Designers can use OpenAPI documents to generate a connected system that can inherit base URLs, authentication details, and a list of operations. Then, using that connected system, the designer can create integrations for those operations. Appian will automatically generate an expression for the URL with rule inputs for any path parameters. It will also generate required headers and query parameters.

In addition to the common properties, an OpenAPI connected system has the following properties:

Field Description
System Logo An image document used to visually represent the external system or service being connected to. The logo is displayed in the integration designer and in the process modeler on integrations that connect to this system (using the Call Integration Smart Service). If no document is selected a default logo will be used instead.
OpenAPI/Swagger Document An OpenAPI documents (formerly known as a Swagger document) defines a standard interface to a RESTful API. They can be read by a human or computer to understand the capabilities of a web service without access to source code/documentation. By uploading these to your connected system, Appian can inherit base URLs, authentication details, and a list of operations.
Base URL A consistent prefix for the URLs of this connected system's integrations. This value supports environment specific configuration for variation across environments. This value can be selected from the list of base URLs that are inherited from the attached OpenAPI document.
Authentication The type of authentication that integrations leveraging this connected system will use. For authentication options, see connected system authentication.

Amazon Machine Learning

NOTE: Amazon ML is no longer available to new Amazon customers

Easily connect to Amazon Web Services Machine Learning models to make predictions based on your data. Pick from available models and quickly map your data to build smarter applications for fraud detection, demand forecasting, targeted marketing, and more.

See Amazon documentation on requesting real time predictions.

In addition to the common properties, an Amazon Machine Learning connected system has the following properties:

Field Description
Access Key Id Amazon uses a custom authentication schema that requires a special signing of the request using an access key, secret access key, and region. The access key id, along with an associated secret access key and region, are used to access Amazon services. Your access key id is the first piece of a set of programmatic credentials that can be generated for Amazon Identity and Access Management (IAM) user accounts.
Secret Access Key Your secret access key is the second piece of a set of programmatic credentials that can be generated for Amazon IAM user accounts.
Region Your region is the third piece of a set of programmatic credentials that can be generated for Amazon IAM user accounts.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

Operation

Name Description Type
Run a Prediction Run a prediction on an existing Amazon Machine Learning model READ

aml_integration.png

Blue Prism

Blue Prism Robotic Process Automation (RPA) Connected System provides an easy way to integrate software robots into your business process, and eliminate repetitive and error-prone tasks that people perform. Automatic discovery of the available Blue Prism processes and their data inputs makes it quick and easy to set up.

See Blue Prism documentation on exposing and calling web services.

In addition to the common properties, an Blue Prism connected system has the following properties:

Field Description
Username Blue Prism account used to execute the Blue Prism process or object
Password Blue Prism account used to execute the Blue Prism process or object
Host URL The Host URL for your Blue Prism instance
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details. Host URL will be validated by testing the connection. Username and Password are per process and will be validated when executing a process or object

Operations

Name Description Type
Execute Blue Prism Process Calls a Blue Prism Process that was exposed as a web service WRITE
Execute Blue Prism Business Object Calls an action defined in a Blue Prism business object WRITE

Execute Blue Prism Process

Calls a Blue Prism Process that was exposed as a web service

Note: Execute Blue Prism Process is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

bp_integration_process.png

Execute Blue Prism Business Object

Calls an action defined in a Blue Prism business object

Note: Execute Blue Prism Business Object is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

bp_integration_business_object.png

Notes

  • Blue Prism is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.
  • Encrypted fields in Blue Prism are exposed in WSDLs as text values. Therefore, we are not able to identify if a Blue Prism field is marked as encrypted or not. We will show those fields as text fields if they are present.
  • Date/Time/DateTime fields will appear as text fields with placeholder text on how to properly format the input
  • If your Blue Prism process or object has nested collections, the designer can simply enter a dictionary representing the collection row and Appian will properly format the request. ={row:{textInput:"abc", numberInput: 3.14}}
  • Asynchronous and long running Blue Prism processes are not supported
  • Please also see the Appian Skill for information on how to call Appian from Blue Prism.

Microsoft Azure LUIS

Easily connect to Microsoft Azure Language Understanding (LUIS) machine learning models to understand what your users want in their own words. Integrations using this connected system will allow you to provide a user's input and LUIS will extract the intent and associated entities represented by the text.

See Microsoft documentation on getting predictions from an endpoint.

In addition to the common properties, a Microsoft Azure LUIS connected system has the following properties:

Field Description
Subscription Key Subscription keys can been found in your Azure portal or in the “Publish” tab of the LUIS application. In the “Publish” tab, any key that is NOT labeled “Starter_Key” is a subscription key.
Subscription Key Region Region for LUIS Endpoint API. The region in which you publish your LUIS app corresponds to the region or location you specify in the Azure portal when you create an Azure LUIS endpoint key. When you publish an app, LUIS automatically generates an endpoint URL for the region associated with the key.
Starter Key This key can be found in the “Publish” tab of the LUIS portal for any of your LUIS apps and is called “Starter_Key”. This key is also referred to as the “Programmatic Key” in the Microsoft documentation.
Starter Key Region Region for LUIS Programmatic API. The authoring region app can only be published to a corresponding publish region.
Bing Spell Check Subscription Key Specifying this value allows you to run spell check on query text before sending it through the model. You can create a Bing Spell Check key in your Azure portal.
Use Staging? When checked, Appian will query your staging model. Use this feature to validate changes to your model. You should always uncheck this box in production using import customization.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

Operation

Name Description Type
Get Predictions from Endpoint Predict the intent and associated entities using an existing model READ

luis_integration.png

Microsoft Dynamics 365 CRM

Create, retrieve, update, and delete entity records in Dynamics Version 9 and Dynamics 365.

Two connected systems are available for Dynamics. Each has a different form of authentication available.

Connected System Description Dynamics Documentation
Authorization Code Each Appian user will be required to log in to their Dynamics account to authenticate. Dynamics OAuth 2.0 Code Grant Flow
Client Credentials All integrations will use a shared Dynamics service account. Individual Appian users do not need their own Dynamics accounts. Dynamics OAuth 2.0 Client Credentials Flow

Both Dynamics connected systems have the same operations available. However, any integration created under one connected system cannot be migrated to the other. For example, if you create an Add Document integration under Authorization Code connected system, you cannot change it to use a Client Credentials connected system. To resolve, you would recreate the integration from the Client Credentials connected system.

Dynamics Authorization Code Connected System

Each Appian user will be required to log in to their Dynamics account to authenticate. You must provide users a way to authenticate using OAuth 2.0.

See Dynamics OAuth 2.0 Code Grant Flow for more details.

In addition to the common properties, a Dynamics (Authorization Code) connected system has the following properties:

Field Description
Redirect URL Each connected system provides a callback URL that must be added to your Dynamics environment. In the Dynamics Setup portal, navigate to App Manager, and then find your App and select Edit. Add the callback URL in the field Callback URL. See Dynamics set up documentation for more details.
Instance URL Instance URL will be used for authorization. This URL is used to configure your integration object and when executing your operations. For example https://company-name.crm.dynamics.com
Application (Client) ID In the Azure portal, navigate to Azure Active Directory, select App Registrations, and then select your application. The Application (client) ID will be listed on this page.
Directory (Tenant) ID In the Azure portal, navigate to Azure Active Directory, select App Registrations, and then select your application. The Directory (tenant) ID will be listed on this page.
Client Secret In the App registrations page, select your application from the list, select Certificates & secrets, and then navigate to Client secrets. Add a new client secret and click Add. The generated key value is the Client Secret and must be copied before leaving this page.
AUTHORIZE Uses the provided configuration information to authorize the designer in a new window. See OAuth 2.0: Authorization Code Grant for more details.

dynamics_authorization_code_cs.png

Operations

Name Description Type
Create an Entity Record Creates a new entity record in Dynamics WRITE
Retrieve an Entity Record Retrieves the data for a given entity record from Dynamics READ
List Entity Records Retrieves a collection of entity records from Dynamics that match the given query READ
Update an Entity Record Updates an entity record in Dynamics WRITE
Delete an Entity Record Deletes an entity record from Dynamics WRITE

Dynamics Client Credentials Connected System

Provide a single Dynamics user’s credentials to authenticate. All integrations will use a shared Dynamics service account. Individual Appian users do not need their own Dynamics accounts.

See Dynamics OAuth 2.0 Client Credentials Flow for more details. Microsoft community also provides a helpful Setup Guide.

In addition to the common properties, a Dynamics (Client Credentials) connected system has the following properties:

Field Description
Instance URL Instance URL will be used for authorization. This URL is used to configure your integration object and when executing your operations. For example https://company-name.crm.dynamics.com
Application (Client) ID In the Azure portal, navigate to Azure Active Directory, select App Registrations, and then select your application. The Application (client) ID will be listed on this page.
Directory (Tenant) ID In the Azure portal, navigate to Azure Active Directory, select App Registrations, and then select your application. The Directory (tenant) ID will be listed on this page.
Client Secret From your application page in Azure portal, select Certificates & secrets, and then navigate to Client secrets. Add a new client secret and click Add. The generated key value is the Client Secret and must be copied before leaving this page.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

dynamics_client_credentials_cs.png

Operations

Name Description Type
Create an Entity Record Creates a new entity record in Dynamics WRITE
Retrieve an Entity Record Retrieves the data for a given entity record from Dynamics READ
List Entity Records Retrieves a collection of entity records from Dynamics that match the given query READ
Update an Entity Record Updates an entity record in Dynamics WRITE
Delete an Entity Record Deletes an entity record from Dynamics WRITE

Operations

Create an Entity Record

Creates a new entity record in Dynamics.

Note: The Create an Entity Record operation modifies data in Dynamics. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

dynamics_create.png

Retrieve an Entity Record

Retrieves the data for a given entity record from Dynamics.

dynamics_retrieve.png

List Entity Records

Retrieves a collection of entity records from Dynamics that match the given query. See Microsoft documentation for ODATA examples.

dynamics_list.png

Update an Entity Record

Updates an entity record in Dynamics.

Note: The Update an Entity Record operation modifies data in Dynamics. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

dynamics_update.png

Delete an Entity Record

Deletes an entity record from Dynamics.

Note: The Delete an Entity Record operation modifies data in Dynamics. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

dynamics_delete.png

Google Cloud Natural Language

Easily connect to Google Cloud Natural Language machine learning models. Extract structure and information from text, including both sentiment and key subjects such as people, places, and events. Integrations using this connected system will allow you to provide a text value and select which types of information to analyze.

See Google documentation on text analysis.

This is part of the Appian AI offering. You can request credentials and start using this service free of charge. Please see Appian AI for more details.

In addition to the common properties, a Google Cloud Natural Language connected system has the following properties:

Field Description
API Key Google API keys can be generated from Google’s cloud console. Be sure to restrict the API key to Google Natural Language.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

Operation

Name Description Type
Run Analysis Run analysis on provided text READ

gcnl_integration.png

Google Cloud Vision

Easily connect to Google Cloud Vision machine learning models. Extract structure and information from images, including logos, landmarks, and text (Optical Character Recognition). Provide an image and select different dimensions to analyze.

See Google documentation on image detection and annotation.

This is part of the Appian AI offering. You can request credentials and start using this service free of charge. Please see Appian AI for more details.

In addition to the common properties, a Google Cloud Vision connected system has the following properties:

Field Description
API Key Google API keys can be generated from Google’s cloud console. Be sure to restrict the API key to Google Cloud Vision.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

Operation

Name Description Type
Run Analysis Run analysis on provided image READ

gcv_integration.png

Notes

  • This connected system does not currently support the asyncBatchAnnotate function, which means we do not support PDF/TIFF files with the services we are leveraging (Google has noted this limitation in their API documentation).

Salesforce

Manage your customer information and interactions. Find, update, create, or delete records within your Salesforce instance.

Two connected systems are available for Salesforce. Each has a different form of authentication available.

Connected System Description Salesforce Documentation
Web Server OAuth Each Appian user will be required to log in to their Salesforce account to authenticate Salesforce Web Server OAuth Authentication Flow.
Username-Password OAuth All integrations will use a shared Salesforce username and password. Individual Appian users do not need their own Salesforce accounts. Salesforce Username-Password OAuth Authentication Flow

Both Salesforce connected systems have the same operations available. However, any integration created under one connected system cannot be migrated to the other. For example, if you create a SOQL Query integration under Web Server connected system, you cannot change it to use a Username-Password connected system. To resolve, you would recreate the integration from the Username-Password connected system.

Web Server OAuth Connected System

Each Appian user will be required to log in to their Salesforce account to authenticate. You must provide users a way to authenticate using OAuth 2.0.

Please see Salesforce Web Server OAuth documentation for more details.

In addition to the common properties, a Salesforce (Web Server OAuth) connected system has the following properties:

Field Description
Redirect URL Each connected system provides a callback URL that must be added to your Salesforce environment. In the Salesforce Setup portal, navigate to App Manager, and then find your App and select Edit. Add the callback URL in the field Callback URL. See Salesforce set up documentation for more details.
Instance URL Instance URL will be used for authorization. This URL is used to configure your integration object and when executing your operations. e.g. https://na59.salesforce.com
Client Id In the Salesforce Setup portal, navigate to App Manager, and then find your App and select View. The Client Id will be listed on this page as “Consumer Key”. See Salesforce set up documentation for more details.
Client Secret In the Salesforce Setup portal, navigate to App Manager, and then find your App and select View. The Client Secret will be listed on this page as “Consumer Secret”. See Salesforce set up documentation for more details.
Scopes In the Salesforce Setup portal, navigate to App Manager, and then find your App and select View. The scopes will be listed on this page as “Selected OAuth Scopes”. This connected system requires API and refresh token access. You must provide API access using either the api or full scope. Please see Salesforce scope documentation for more details.
AUTHORIZE Uses the provided configuration information to authorize the designer in a new window. See OAuth 2.0: Authorization Code Grant for more details.

sf_web_server_connected_system.png

Operations

Name Description Type
Create SObject Adds a new business object to Salesforce WRITE
Update SObject Updates data for an existing business object in Salesforce WRITE
Delete SObject Removes a business object from Salesforce WRITE
SOQL Query Allows querying a Salesforce instance using the Salesforce Object Query Language (SOQL) READ
SOSL Search Allows searching a Salesforce instance using the Salesforce Object Search Language (SOSL) READ
Describe SObject Provides introspection into the metadata of the given Salesforce objects READ
Describe All SObjects Provides introspection into the objects available in the target Salesforce instance READ

Username-Password OAuth Connected System

Provide a single Salesforce user’s credentials to authenticate. All integrations will use a shared Salesforce username and password. Individual Appian users do not need their own Salesforce accounts.

Please see Salesforce Username-Password OAuth documentation for more details.

In addition to the common properties, a Salesforce (Username-Password OAuth) connected system has the following properties:

Field Description
Instance URL Instance URL will be used for authorization. This URL is used to configure your integration object and when executing your operations. e.g. https://na59.salesforce.com
Client Id In the Salesforce Setup portal, navigate to App Manager, and then find your App and select View. The Client Id will be listed on this page as “Consumer Key”. See Salesforce set up documentation for more details.
Client Secret In the Salesforce Setup portal, navigate to App Manager, and then find your App and select View. The Client Secret will be listed on this page as “Consumer Secret”. See Salesforce set up documentation for more details.
Username The username used to sign into the provided Salesforce instance
Password The password used to sign into the provided Salesforce instance
Security Token This is an automatically-generated user security token from Salesforce. In the Salesforce personal settings for the user, select Reset My Security Token to generate a new security token. When authorizing, this security token will be appended to the password. Please see Salesforce security token documentation for more details.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

sf_username_password_connected_system.png

Operations

Name Description Type
Create SObject Adds a new business object to Salesforce WRITE
Update SObject Updates data for an existing business object in Salesforce WRITE
Delete SObject Removes a business object from Salesforce WRITE
SOQL Query Allows querying a Salesforce instance using the Salesforce Object Query Language (SOQL) READ
SOSL Search Allows searching a Salesforce instance using the Salesforce Object Search Language (SOSL) READ
Describe SObject Provides introspection into the metadata of the given Salesforce objects READ
Describe All SObjects Provides introspection into the objects available in the target Salesforce instance READ

Operations

Create SObject

Adds a new business object to Salesforce

Note: Create SObject is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sf_integration_create_sobject.png

Update SObject

Updates data for an existing business object in Salesforce

Note: Update SObject is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sf_integration_update_sobject.png

Delete SObject

Removes a business object from Salesforce

Note: Delete SObject is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sf_integration_delete_sobject.png

SOQL Query

Allows querying a Salesforce instance using the Salesforce Object Query Language (SOQL)

sf_integration_soql_query.png

Allows searching a Salesforce instance using the Salesforce Object Search Language (SOSL)

sf_integration_sosl_search.png

Describe SObject

Provides introspection into the metadata of the given Salesforce objects

sf_integration_describe_sobject.png

Describe All SObjects

Provides introspection into the objects available in the target Salesforce instance

sf_integration_describe_all_objects.png

SharePoint

Manage documents and folders in your SharePoint instance.

Two connected systems are available for SharePoint. Each has a different form of authentication available.

Connected System Description SharePoint Documentation
Authorization Code Each Appian user will be required to log in to their SharePoint account to authenticate. SharePoint OAuth 2.0 Code Grant Flow
Client Credentials All integrations will use a shared SharePoint service account. Individual Appian users do not need their own SharePoint accounts. SharePoint OAuth 2.0 Client Credentials Flow

Both SharePoint connected systems have the same operations available. However, any integration created under one connected system cannot be migrated to the other. For example, if you create an Add Document integration under Authorization Code connected system, you cannot change it to use a Client Credentials connected system. To resolve, you would recreate the integration from the Client Credentials connected system.

SharePoint Authorization Code Connected System

Each Appian user will be required to log in to their SharePoint account to authenticate. You must provide users a way to authenticate using OAuth 2.0.

Please see SharePoint OAuth 2.0 Code Grant Flow for more details.

In addition to the common properties, a SharePoint (Authorization Code) connected system has the following properties:

Field Description
Redirect URL Each connected system provides a callback URL that must be added to your SharePoint environment. In the SharePoint Setup portal, navigate to App Manager, and then find your App and select Edit. Add the callback URL in the field Callback URL. See SharePoint set up documentation for more details.
Instance URL Instance URL will be used for authorization. This URL is used to configure your integration object and when executing your operations. e.g. https://yourinstance.sharepoint.com
Application (Client) ID In the Azure portal, navigate to Azure Active Directory, select App Registrations, and then select your application. The Application (client) ID will be listed on this page.
Directory (Tenant) ID In the Azure portal, navigate to Azure Active Directory, select App Registrations, and then select your application. The Directory (tenant) ID will be listed on this page.
Client Secret From your application page in Azure portal, select Certificates & secrets, and then navigate to Client secrets. Add a new client secret and click Add. The generated key value is the Client Secret and must be copied before leaving this page.
AUTHORIZE Uses the provided configuration information to authorize the designer in a new window. See OAuth 2.0: Authorization Code Grant for more details.

sharepoint_authorization_code_cs.png

Operations

Name Description Type
Add Document Upload files from Appian to SharePoint WRITE
Download Document Retrieves the document from SharePoint and places into an Appian WRITE
Get Document Metadata Retrieves metadata for a file READ
Update Document Metadata Updates metadata for the specified file WRITE
Create Folder Creates a new folder in SharePoint WRITE
Get Folder Metadata Updates metadata for the specified folder READ
List Folder Contents Lists a folder's contents READ
Update Folder Metadata Retrieves metadata for a folder READ
Execute Read Request Execute arbitrary read requests to SharePoint READ
Execute Write Request Execute arbitrary write requests to SharePoint WRITE

SharePoint Client Credentials Connected System

Provide a single SharePoint user’s credentials to authenticate. All integrations will use a shared SharePoint service account. Individual Appian users do not need their own SharePoint accounts.

To generate Client Credentials, see Granting access using SharePoint App-Only in the Microsoft docs.

A few notes on the process:

  1. If you only need access to a particular SharePoint site, go to that site’s URL to generate your Client ID and Client Secret. For example: <siteName>.sharepoint.com/sites/<subsite>/_layouts/15/appinv.aspx
  2. If you do not have tenant administrator permissions, you may need to use a different permission XML. For example:
1
2
3
<AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />
</AppPermissionRequests>

In addition to the common properties, a SharePoint (Client Credentials) connected system has the following properties:

Field Description
Instance URL Instance URL will be used for authorization. This URL is used to configure your integration object and when executing your operations. e.g. https://yourinstance.sharepoint.com
Application (Client) ID To generate the Application (Client) ID, see Granting access using SharePoint App-Only in the Microsoft docs.
Client Secret To generate the Client Secret, see Granting access using SharePoint App-Only in the Microsoft docs.
Directory (Tenant) ID In the Azure portal, navigate to Azure Active Directory. Under Manage, select Properties. The tenant ID is shown in the Directory ID field.
TEST CONNECTION Uses the provided configuration information to connect to the target system. Returns success or error with details.

sharepoint_client_credentials_cs.png

Operations

Name Description Type
Add Document Upload files from Appian to SharePoint WRITE
Download Document Retrieves the document from SharePoint and places into an Appian WRITE
Get Document Metadata Retrieves metadata for a file READ
Update Document Metadata Updates metadata for the specified file WRITE
Create Folder Creates a new folder in SharePoint WRITE
Get Folder Metadata Updates metadata for the specified folder READ
List Folder Contents Lists a folder's contents READ
Update Folder Metadata Retrieves metadata for a folder READ
Execute Read Request Execute arbitrary read requests to SharePoint READ
Execute Write Request Execute arbitrary write requests to SharePoint WRITE

Operations

Add Document

Upload a document from Appian to SharePoint.

Note: The Add Document operation modifies data in SharePoint. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sharepoint_add_document.png

Download Document

Retrieves the document from SharePoint and places into an Appian.

Note: The Download Document operation downloads a file to Appian. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sharepoint_download_file.png

Get Document Metadata

Retrieves metadata for a file.

sharepoint_get_document_metadata.png

Update Document Metadata

Updates metadata for the specified file. See Updating Metadata for information on how to get the metadata properties from a Get Document Metadata request.

Note: The Update Document Metadata operation modifies data in SharePoint. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sharepoint_update_document_metadata.png

Create Folder

Creates a new folder in SharePoint.

Note: The Create Folder operation modifies data in SharePoint. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sharepoint_create_folder.png

Get Folder Metadata

Retrieves metadata for a folder.

sharepoint_get_folder_metadata.png

List Folder Contents

Lists a folder's contents.

sharepoint_list_folder_contents.png

Update Folder Metadata

Updates metadata for the specified folder. See Updating Metadata for information on how to get the metadata properties from a Get Folder Metadata request.

Note: The Update Folder Metadata operation modifies data in SharePoint. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sharepoint_update_folder_metadata.png

Execute Read Request

Execute read requests to SharePoint using a relative path.

sharepoint_execute_read_request.png

Execute Write Request

Execute write requests to SharePoint using a relative path and body.

Note: The Execute Write Request operation modifies data in SharePoint. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

sharepoint_execute_write_request.png

Updating Metadata: Identifying Metadata Properties

In order to update metadata for documents or folders, you will need to send the OData type, the name of the metadata field, and the updated value of the field. To get this information, you can send a Get Document Metadata or Get Folder Metadata request.

Getting the OData Type

The OData type is sent in the body as { "type": "<OData Type>" }

Sometimes, you can use SP.ListItem for the OData type. However, if that doesn't work, send a get metadata request. The OData type is listed under ListItemAllFields > __metadata in the response.

In our case, it is SP.Data.Shared_x0020_DocumentsItem.

sharepoint_get_document_metadata.png

Getting the Metadata Field Name

If you send a request to update data and it does not update, but the request says it was successful, send a get metadata request and look for the metadata field in the response. The name of the field might be different than its display name.

For example, in our SharePoint environment, we have a metadata field called "Description."

sharepoint_get_document_metadata.png

However, when we send a Get Document Metadata request, the name of the field is "Description0."

sharepoint_get_document_metadata.png

Creating the Request Body

When we use the information we received from the get metadata request above, our request body looks like this:

1
2
3
4
5
6
=a!toJson(
  { "__metadata":
  { "type": `"SP.Data.Shared_x0020_DocumentsItem"` },
  `"Description0"`:"Quarterly report 2019-Q4"
  }
)

Providing the ETag Value

If you need to prevent lost updates caused by multiple users making a request to update the same file, you should provide the ETag number. If you don't, when two or more requests are made at the same time, the last request to go through will overwrite the earlier requests. This could lead to one or more updates being lost because the last update won't include the information from the previous requests.

To get the ETag value, send a Get Document Metadata request. The body of the response contains the ETag number.

sharepoint_create_folder.png

The dot notation we would use to get the ETag in the above response is .result.d.ListItemAllFields.__metadata.etag.

sharepoint_create_folder.png

FEEDBACK