Smartsheet Connector for SSIS

In this article you will learn how to quickly and efficiently integrate Smartsheet data in SSIS without coding. We will use high-performance Smartsheet Connector to easily connect to Smartsheet and then access the data inside SSIS.

Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Connect to Smartsheet in other apps
Smartsheet Connector Connect Smartsheet in SQL Server SQL Server
Connect to Smartsheet in SQL Server
Smartsheet Connector Connect Smartsheet in Power BI Power BI
Connect to Smartsheet in Power BI
Smartsheet Connector Connect Smartsheet in SSRS SSRS
Connect to Smartsheet in SSRS
Smartsheet Connector Connect Smartsheet in Informatica Informatica
Connect to Smartsheet in Informatica
Smartsheet Connector Connect Smartsheet in MS Access MS Access
Connect to Smartsheet in MS Access
Smartsheet Connector Connect Smartsheet in MS Excel MS Excel
Connect to Smartsheet in MS Excel
Smartsheet Connector Connect Smartsheet in SSAS SSAS
Connect to Smartsheet in SSAS
Smartsheet Connector Connect Smartsheet in C# C#
Connect to Smartsheet in C#
Smartsheet Connector Connect Smartsheet in Python Python
Connect to Smartsheet in Python
Smartsheet Connector Connect Smartsheet in JAVA JAVA
Connect to Smartsheet in JAVA
Smartsheet Connector Connect Smartsheet in Tableau Tableau
Connect to Smartsheet in Tableau
Smartsheet Connector Connect Smartsheet in SAP Crystal Reports SAP Crystal Reports
Connect to Smartsheet in SAP Crystal Reports
Smartsheet Connector Connect Smartsheet in Azure Data Factory (Pipeline) Azure Data Factory (Pipeline)
Connect to Smartsheet in Azure Data Factory (Pipeline)
Smartsheet Connector Connect Smartsheet in Azure Data Factory (SSIS) Azure Data Factory (SSIS)
Connect to Smartsheet in Azure Data Factory (SSIS)
Smartsheet Connector Connect Smartsheet in Talend Studio Talend Studio
Connect to Smartsheet in Talend Studio
Smartsheet Connector Connect Smartsheet in UiPath UiPath
Connect to Smartsheet in UiPath
Smartsheet Connector Connect Smartsheet in PowerShell PowerShell
Connect to Smartsheet in PowerShell
Smartsheet Connector Connect Smartsheet in ODBC ODBC
Connect to Smartsheet in ODBC

Video Tutorial - Integrate Smartsheet data in SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for Smartsheet integration in SSIS
  • How to configure connection for Smartsheet
  • Features about API Source (Authentication / Query Language / Examples / Driver UI)
  • Using Smartsheet Connection in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Smartsheet in SSIS (Export data)

In this section we will learn how to configure and use Smartsheet Connector in API Source to extract data from Smartsheet.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom

    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Smartsheet Connector from Popular Connector List or press Search Online radio button to download Smartsheet Connector. Once downloaded simply use it in the configuration:

    Smartsheet
    Smartsheet Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

     OAuth (Dynamic Token) [OAuth]

    Steps how to get and use Smartsheet credentials

    OAuth Walkthrough

    Apps connect to Smartsheet using OAuth 2.0 to authenticate and authorize users. If you are building an app, this documentation will walk you through the steps you need to authenticate your users. The Smartsheet SDKs contain APIs for OAuth 2.0.

    NOTE: For users of apps like AWS AppFabric, you will need a Tenant ID. You can find your Tenant ID in Admin Center under Security & Controls. There is a Smartsheet Tenant ID pane.

    First Steps

    Before you can start using OAuth 2.0 with your app, Smartsheet needs the following information:

    1. You must register with Smartsheet to get a developer account*. The developer account gives you access to "Developer Tools", which is where you manage your app.
    2. In "Developer Tools", complete any required fields in your developer profile.
    3. In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
    4. Review the list of access scopes. You'll need to choose which ones your app needs to get to a user's Smartsheet data, and then ask the user to consent to that access.
    5. After you've worked through these steps, you'll be ready to implement the OAuth Flow.

    Open Developer Tools

    1. Log in to Smartsheet with your developer account.
    2. Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
    3. Do one of the following:
      • If you need to register an app, click "Create New App".
      • If you need to manage an app, click "view/edit" for the app.

    Register Your App Using Developer Tools

    1. Log in to Smartsheet with your developer account.
    2. Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
    3. In the "Create New App" form, provide the following information:
      • Name: the name the user sees to identify your app
      • Description: a brief description intended for the user
      • URL: the URL to launch your app, or the landing page if not a web app
      • Contact/support: support information for the user
      • Redirect URL: also known as a callback URL. The URL within your application that will receive the OAuth 2.0 credentials After you click "Save", Smartsheet assigns a client Id and secret to your app. Make a note of these Ids for the next steps; however, you can always look them up again in "Developer Tools".

    Configuring authentication parameters
    Smartsheet
    OAuth (Dynamic Token) [OAuth]
    https://api.smartsheet.com/2.0
    Required Parameters
    ClientId Fill-in the parameter...
    ClientSecret Fill-in the parameter...
    Scope Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429|503
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

     Static Token [Http]

    Steps how to get and use Smartsheet credentials

    Raw Token Requests

    If you want to get started quickly, or are developing a standalone application that can run with your credentials, follow these instructions:

    1. Click the "Account" button in the lower-left corner of the Smartsheet screen, and then click "Personal Settings".
    2. Click the "API Access" tab.
    3. Click the "Generate new access token" button to obtain an access token.

    The access token must be sent with every API call in an HTTP authorization header (except for therequests to Get Access Token or Refresh Access Token). Once you have an access token, include it in the Authorization header for every request you make:

    Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

    The header name is Authorization and the value of the header is Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789. Since the access token is being transmitted in clear text, all API calls are done over HTTPS.

    NOTE: A best practice is to use a shared account, such as ticket-processor@example.com, rather than your individual work account.


    Configuring authentication parameters
    Smartsheet
    Static Token [Http]
    https://api.smartsheet.com/2.0
    Required Parameters
    Access Token Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429|503
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Smartsheet
    Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Smartsheet using Smartsheet Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Smartsheet and load into target

Write data to Smartsheet using SSIS (Import data)

In this section we will learn how to configure and use Smartsheet Connector in the API Destination to write data to Smartsheet.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Smartsheet integration in SSIS
  • How to configure connection for Smartsheet
  • How to write or lookup data to Smartsheet
  • Features about SSIS API Destination
  • Using Smartsheet Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Smartsheet in the API Source to POST data to the Smartsheet.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - Smartsheet
    Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
    API Destination - New Connection

  4. Use a preinstalled Smartsheet Connector from Popular Connector List or press Search Online radio button to download Smartsheet Connector. Once downloaded simply use it in the configuration:

    Smartsheet
    Smartsheet Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

     OAuth (Dynamic Token) [OAuth]

    Steps how to get and use Smartsheet credentials

    OAuth Walkthrough

    Apps connect to Smartsheet using OAuth 2.0 to authenticate and authorize users. If you are building an app, this documentation will walk you through the steps you need to authenticate your users. The Smartsheet SDKs contain APIs for OAuth 2.0.

    NOTE: For users of apps like AWS AppFabric, you will need a Tenant ID. You can find your Tenant ID in Admin Center under Security & Controls. There is a Smartsheet Tenant ID pane.

    First Steps

    Before you can start using OAuth 2.0 with your app, Smartsheet needs the following information:

    1. You must register with Smartsheet to get a developer account*. The developer account gives you access to "Developer Tools", which is where you manage your app.
    2. In "Developer Tools", complete any required fields in your developer profile.
    3. In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
    4. Review the list of access scopes. You'll need to choose which ones your app needs to get to a user's Smartsheet data, and then ask the user to consent to that access.
    5. After you've worked through these steps, you'll be ready to implement the OAuth Flow.

    Open Developer Tools

    1. Log in to Smartsheet with your developer account.
    2. Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
    3. Do one of the following:
      • If you need to register an app, click "Create New App".
      • If you need to manage an app, click "view/edit" for the app.

    Register Your App Using Developer Tools

    1. Log in to Smartsheet with your developer account.
    2. Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
    3. In the "Create New App" form, provide the following information:
      • Name: the name the user sees to identify your app
      • Description: a brief description intended for the user
      • URL: the URL to launch your app, or the landing page if not a web app
      • Contact/support: support information for the user
      • Redirect URL: also known as a callback URL. The URL within your application that will receive the OAuth 2.0 credentials After you click "Save", Smartsheet assigns a client Id and secret to your app. Make a note of these Ids for the next steps; however, you can always look them up again in "Developer Tools".

    Configuring authentication parameters
    Smartsheet
    OAuth (Dynamic Token) [OAuth]
    https://api.smartsheet.com/2.0
    Required Parameters
    ClientId Fill-in the parameter...
    ClientSecret Fill-in the parameter...
    Scope Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429|503
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

     Static Token [Http]

    Steps how to get and use Smartsheet credentials

    Raw Token Requests

    If you want to get started quickly, or are developing a standalone application that can run with your credentials, follow these instructions:

    1. Click the "Account" button in the lower-left corner of the Smartsheet screen, and then click "Personal Settings".
    2. Click the "API Access" tab.
    3. Click the "Generate new access token" button to obtain an access token.

    The access token must be sent with every API call in an HTTP authorization header (except for therequests to Get Access Token or Refresh Access Token). Once you have an access token, include it in the Authorization header for every request you make:

    Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

    The header name is Authorization and the value of the header is Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789. Since the access token is being transmitted in clear text, all API calls are done over HTTPS.

    NOTE: A best practice is to use a shared account, such as ticket-processor@example.com, rather than your individual work account.


    Configuring authentication parameters
    Smartsheet
    Static Token [Http]
    https://api.smartsheet.com/2.0
    Required Parameters
    Access Token Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429|503
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Smartsheet
    Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - Smartsheet
    Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Smartsheet API call using ZappySys Smartsheet Connector

    Execute Package - Reading data from API Source and load into target

Load Smartsheet data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Smartsheet data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table

  9. Click OK to save the configuration.

  10. Run the package and Smartsheet data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target

  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Advanced topics

Actions supported by Smartsheet Connector

Smartsheet Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Search (cell data or other object types)
Get a list of search result object.    [ Read more... ]
Parameter Description
Search Query (use double quotes for exact search)
SheetId
Scope
Option Value
cellData cellData
attachments attachments
comments comments
folderNames folderNames
reportNames reportNames
sheetNames sheetNames
sightNames sightNames
summaryFields summaryFields
templateNames templateNames
workspaceNames workspaceNames
Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
 List Sheets
Get a list of Sheets.    [ Read more... ]
Parameter Description
Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
Include
Option Value
sheetVersion sheetVersion
source source
 Get Sheet Fields
Get Sheet fields by Sheet ID.    [ Read more... ]
Parameter Description
SheetId
Column Ids (Default=All Columns) A comma-separated list of column ids. The response contains only the specified columns in the columns array, and individual rows' cells array only contains cells in the specified columns.
 Get Sheet Rows
Get Sheet rows by Sheet ID.    [ Read more... ]
 Get Sheet Row by ID(s)
Get a Sheet by ID(s).    [ Read more... ]
Parameter Description
Row Id(s) - Comma separated (Blank=All Rows) Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in Pagination template)
Row Number(s) - Comma separated list (Blank=All Rows) A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored.
 Delete Sheet Rows
Delete rows from a Sheet by row IDs.    [ Read more... ]
Parameter Description
SheetId
Row Id(s) - Comma separated Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in Pagination template)
Ignore If Rows Not Found If set to false and any of the specified row Ids are not found, no rows are deleted, and the 'not found' error is returned.
Option Value
true true
false false
 Add Sheet Rows
Add rows to a Sheet.    [ Read more... ]
Parameter Description
Add Row at Specific Location (Default=toBottom)
Option Value
"toBottom": true "toBottom": true
"toTop": true "toTop": true
"parentId": 1231234567 "parentId": 1231234567
"siblingId": 1231234567 "siblingId": 1231234567
Allow Partial Success (Default=False) When specified with a value of true, enables partial success for this bulk operation. See Partial Success for more information.
Option Value
false false
true true
Override Validation (Default=False) You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking.
Option Value
false false
true true
 update_sheet_rows
   [ Read more... ]
Parameter Description
Allow Partial Success (Default=False) When specified with a value of true, enables partial success for this bulk operation. See Partial Success for more information.
Option Value
false false
true true
Override Validation (Default=False) You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking.
Option Value
false false
true true
 Export Sheet (to PDF, Excel, CSV file)
Export Sheet to CSV, Excel or PDF file.    [ Read more... ]
Parameter Description
SheetId
 Export Report (to PDF, Excel, CSV file)
Export Report to CSV, Excel or PDF file.    [ Read more... ]
Parameter Description
ReportId
 Send Report via Email (EXCEL, PDF, or PDF_GANTT format)
Sends the report as a Excel / PDF attachment via email to the designated recipients.    [ Read more... ]
Parameter Description
ReportId
 Send Sheet via Email (EXCEL, PDF, or PDF_GANTT format)
Sends the sheet as a Excel / PDF attachment via email to the designated recipients.    [ Read more... ]
Parameter Description
SheetId
 List Reports
Get a list of reports.    [ Read more... ]
Parameter Description
Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
 List Contacts
Get a list of contacts.    [ Read more... ]
Parameter Description
Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
 List Groups
Get a list of groups.    [ Read more... ]
Parameter Description
Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
 Get Contacts
Gets the specified contact.    [ Read more... ]
Parameter Description
ContactId
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [ Read more... ]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Option Value
No filter
Example1 $.store.books[*]
Example2 (Sections Under Books) $.store.books[*].sections[*]
Example3 (Equals) $.store.books[?(@author=='sam')]
Example4 (Equals - Any Section) $..[?(@author=='sam')]
Example5 (Not Equals - Any Section) $..[?(@author!='sam')]
Example6 (Number less than) $.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )]
Example8 (Regular Expression - Does Not Contain Pattern) $.store.books[?(@author=~ /^((?!sam|bob).)*$/ )]
Example9 (Regular Expression - Exact Pattern Match) $.store.books[?(@author=~ /^sam|bob$/ )]
Example10 (Regular Expression - Starts With) $.store.books[?(@author=~ /^sam/ )]
Example11 (Regular Expression - Ends With) $.store.books[?(@author=~ /sam$/ )]
Example12 (Between) $.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )]
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
 Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [ Read more... ]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair

Conclusion

In this article we showed you how to connect to Smartsheet in SSIS and integrate data without any coding, saving you time and effort. We encourage you to download Smartsheet Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Smartsheet Connector for SSIS Documentation

More integrations

Other connectors for SSIS

Other application integration scenarios for Smartsheet

Smartsheet for SQL Server
SQL Server
Smartsheet for Power BI
Power BI
Smartsheet for SSRS
SSRS
Smartsheet for Informatica
Informatica
Smartsheet for MS Access
MS Access
Smartsheet for MS Excel
MS Excel
Smartsheet for SSAS
SSAS
Smartsheet for C#
C#
Smartsheet for Python
Python
Smartsheet for JAVA
JAVA
Smartsheet for Tableau
Tableau
Smartsheet for SAP Crystal Reports
SAP Crystal Reports
Smartsheet for Azure Data Factory (Pipeline)
Azure Data Factory (Pipeline)
Smartsheet for Azure Data Factory (SSIS)
Azure Data Factory (SSIS)
Smartsheet for Talend Studio
Talend Studio
Smartsheet for UiPath
UiPath
Smartsheet for PowerShell
PowerShell
Smartsheet for ODBC
ODBC
Download Smartsheet Connector for SSIS Documentation

  • How to connect Smartsheet in SSIS?

  • How to get Smartsheet data in SSIS?

  • How to read Smartsheet data in SSIS?

  • How to load Smartsheet data in SSIS?

  • How to import Smartsheet data in SSIS?

  • How to pull Smartsheet data in SSIS?

  • How to push data to Smartsheet in SSIS?

  • How to write data to Smartsheet in SSIS?

  • How to POST data to Smartsheet in SSIS?

  • Call Smartsheet API in SSIS

  • Consume Smartsheet API in SSIS

  • Smartsheet SSIS Automate

  • Smartsheet SSIS Integration

  • Integration Smartsheet in SSIS

  • Consume real-time Smartsheet data in SSIS

  • Consume real-time Smartsheet API data in SSIS

  • Smartsheet ODBC Driver | ODBC Driver for Smartsheet | ODBC Smartsheet Driver | SSIS Smartsheet Source | SSIS Smartsheet Destination

  • Connect Smartsheet in SSIS

  • Load Smartsheet in SSIS

  • Load Smartsheet data in SSIS

  • Read Smartsheet data in SSIS

  • Smartsheet API Call in SSIS