a!shpInvokeWriter() Function

Invokes the SharePoint 2013 REST endpoint based on the given path parameter for the purpose of writing data to SharePoint.

For transferring files between Appian and SharePoint, use a!shpCopyDocumentFromAppian and a!shpCopyDocumentToAppian.


a!shpInvokeWriter( scsExternalSystemKey, usePerUserCredentials, hostname, port, path, httpMethod, timeout, retries, parameters, subsitePath)

Common Parameters:

scsExternalSystemKey: (Text) The key from the Third Party Credentials admin console page that corresponds to the set of credentials that should be used to authenticate.

usePerUserCredentials: (Boolean) If true the credentials set in the Third-Party Credentials settings page by the current user running the expression will be used. If false the site-wide credential values will be used.

hostname: (Text) The scheme and hostname of the SharePoint server. For example, https://sharepoint.example.com.

port: (Number (Integer)) The port on which to connect to the SharePoint server.

path: (Text) The path portion of the REST API URL to invoke. When referring to the SharePoint REST API Reference, this parameter is the part of the URL after the <site url> or <app web url> shown in the examples.

httpMethod: (Text) The HTTP method to invoke: The HTTP method to use when invoking the REST API. Valid values: "GET", "POST", "PUT", "DELETE", "MERGE"

timeout: (Number (Integer)) The amount of time, in milliseconds, to wait when attempting to connect to the SharePoint server.

retries: (Number (Integer)) The number of times to retry a connection that fails to connect within the given timeout period.

Specific Parameters:

parameters: (Any Type) The data to use in the body of the request, given as a dictionary. The dictionary is converted to its equivalent JSON form before sending to the endpoint.

subsitePath: (Text) Optional. The path portion of the REST API URL that represents the SharePoint subsite. It must start with a forward slash (/). Leave blank if accessing the base site.



This function returns a writer and must be used with the bind() function.

See also:


Delete a Document from SharePoint

Copy and paste the expression into the Interface Designer, save it, then call the interface in a Tempo Report to test.

  local!shpInvokeWriter: bind(
      scsExternalSystemKey: cons!SHAREPOINT_EXTERNAL_SYSTEM_KEY,
      usePerUserCredentials: true,
      hostname: cons!SHAREPOINT_HOSTNAME,
      port: cons!SHAREPOINT_PORT,
      timeout: cons!SHAREPOINT_TIMEOUT,
      retries: cons!SHAREPOINT_NUM_RETRIES,
      path: _,
      httpMethod: "DELETE"
    firstColumnContents: {
        label: "Document To Delete",
        value: local!documentToDelete,
        saveInto: local!documentToDelete
        buttons: {
            label: "Send File",
            value: "/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/" & local!documentToDelete & "')",
            saveInto: local!shpInvokeWriter