Overview
Configuration is provided for establishing connections with the Smartsheet service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
Step 1. Run "Visual Studio" under "Administrator account".
Select "Data Flow task" tab and Click "Add new Data flow task"
Step 2. Right click on "Connection managers tab" and Select New Connection
Step 3. In "Add SSIS Connection Manager" scroll down and Select REST "Connection managers for REST Connection" and Click "Add"
Step 4. From Configuration drop-down menu Select "Smartsheet" and Click New
Step 5. Select Smartsheet scopes and Click Next
Step 6. Provide authentication details for your Smartsheet account and Click "Log in"
Step 7. Click Allow
Step 8. Save your password protected Smatrsheet access token file and Click OK
Step 9. Click "Test" to test your connection.
Step 10. Click OK
Step 1. Open the right side panel and Drag and Drop REST Source component
Step 2. Double click on it and from "General tab" Select Smartsheet Connection".
Next Select from available Smartsheet resources listed in second drop-down menu.
Step 3. Click on "Columns tab" and Select from Smartsheet available columns.
Step 4. Click on "Preview tab" to view the columns data. Next Click OK
Step 5. Drag and drop OLE DB Destination component from the left side panel - SSIS Toolbox
Step 7. Right click "Connection managers Tab" and Select New OLE DB
Step 8. Select your Data connection and click OK
Step 6 Drag the blue arrow to Connect Smartsheet source with OLE DB Destination.
Next Select an Input and an Output to connect the components.
Step 9. Double Click on OLD DB Destination and Select Connection manager and Table name.
Step 10. Click on OLE Destination "Mappings tab" and Map the columns. Click OK
Step 11. Run the package
Step 1. Right click on "Connection managers tab" and Select New OLE DB Connection
Step 2. Select your DB connection and Click OK
Step 3. Drag and drop OLE DB Source component from the left side panel - SSIS Toolbox
Step 4. Double click on OLE DB Source component and Select your OLE DB connection and table name. Next Click Preview to see the data.
Step 5. Click on "Columns tab" on the left menu and Select the Columns you want to map.
Step 6. Drag and drop REST Destination component from the SSIS Toolbox and Rename it to "Smartsheet destination"
Step 7. Drag the blue arrow to Connect OLE DB source with Smartsheet destination
Step 8. Double click on "Smartsheet destination" component, "General tab" and Select Smartsheet connection, Action and Resource from drop down menu.
Step 9. Click on "Mappings tab" and Map the columns
Step 10. Run the package.
Configuration
Base URL address: https://api.smartsheet.com/2.0.
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://smartsheet-platform.github.io/api-docs/#oauth-flow.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/attachments.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
Documentation: https://smartsheet-platform.github.io/api-docs/#list-attachments.
- [Read discussionId] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/discussions/{{=parameters.discussionId}}/attachments.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
- discussionId: Required. Specify discussion identifier.
Documentation: https://smartsheet-platform.github.io/api-docs/#list-discussion-attachments.
- [Read rowId] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows/{{=parameters.rowId}}/attachments.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
- rowId: Required. Specify row identifier.
Documentation: https://smartsheet-platform.github.io/api-docs/#list-row-attachments.
- [Create] action
-
Endpoint URL address:
{{=Smartsheet.getPostAttachmentUrl(item)}}.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/attachments/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-attachment.
The resource includes the fields from the AttachmentT template.
- sheetId
Template: Id.
- rowId
Template: Id.
- commentId
Template: Id.
- versions
-
The value is gathered from
/sheets/{{=Smartsheet.getSheetId(parameters)}}/attachments/{{=item.id}}/versionsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, name, attachmentType, mimeType, createdAt.
Documentation: https://smartsheet-platform.github.io/api-docs/#versioning.
- content
Data type: DT_IMAGE The value is gathered from
{{=item.url}}address. The value is sent to{{=Smartsheet.getPostAttachmentUrl(item)}}address.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/columns.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
Documentation: https://smartsheet-platform.github.io/api-docs/#list-columns.
- [Create] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/columns.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://smartsheet-platform.github.io/api-docs/#add-columns.
- [Update] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/columns/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-column.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/columns/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-column.
The resource includes the fields from the ColumnT template.
- sheetId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/discussions/{{=parameters.discussionId}}.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
- discussionId: Required. Specify discussion identifier.
Documentation: https://smartsheet-platform.github.io/api-docs/#get-discussion.
- [Create] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/discussions/{{=item.discussionId}}/comments.Documentation: https://smartsheet-platform.github.io/api-docs/#add-comment.
- [Update] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/comments/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#edit-comment.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/comments/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-comment.
The resource includes the fields from the CommentT template.
- sheetId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.Documentation: https://smartsheet-platform.github.io/api-docs/#list-contacts.
- id
Template: Id.
- name
Template: ShortText.
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/discussions.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
Documentation: https://smartsheet-platform.github.io/api-docs/#list-discussions.
- [Read rowId] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows/{{=parameters.rowId}}/discussions.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
- rowId: Required. Specify row identifier.
Documentation: https://smartsheet-platform.github.io/api-docs/#list-row-discussions.
- [Create] action
-
Endpoint URL address:
/sheets/{{=item.sheetId + (item.rowId ? '/rows/' + item.rowId : '')}}/discussions.Documentation: https://smartsheet-platform.github.io/api-docs/#create-discussion-on-sheet https://smartsheet-platform.github.io/api-docs/#create-discussion-on-row .
- [Delete] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/discussions/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-discussion.
The resource includes the fields from the DiscussionT template.
- sheetId
Template: Id.
- rowId
Template: Id.
- comment
Template: CommentT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/favorites.Documentation: https://smartsheet-platform.github.io/api-docs/#list-favorites.
- [Create] action
-
Endpoint URL address:
/favorites.Documentation: https://smartsheet-platform.github.io/api-docs/#add-favorites.
- [Delete] action
-
Endpoint URL address:
/favorites/{{=item.type}}/{{=item.objectId}}.Documentation: https://smartsheet-platform.github.io/api-docs/#remove-favorite.
- type
Template: ShortText.
- objectId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/home/folders.Documentation: https://smartsheet-platform.github.io/api-docs/#list-folders.
- [Read folderId] action
-
Endpoint URL address:
/folders/{{=parameters.folderId}}/folders.The action has the following user-defined parameters:
- folderId: Required. Specify folder identifier.
Documentation: https://smartsheet-platform.github.io/api-docs/#list-folders-folder.
- [Read workspaceId] action
-
Endpoint URL address:
/workspaces/{{=Smartsheet.UI.WorkspaceEditor.getValue(parameters)}}/folders.The action has the following user-defined parameters:
- workspaceId: Required. Select workspace.
Documentation: https://smartsheet-platform.github.io/api-docs/#list-folders-workspace.
- [Create] action
-
Endpoint URL address:
{{=item.parentFolderId && '/folders/' + item.parentFolderId + '/folders' || item.workspaceId && '/workspaces/' + item.workspaceId + '/folders' || '/home/folders'}}.Documentation: https://smartsheet-platform.github.io/api-docs/#create-child-folder.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-folder.
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-folder.
The resource includes the fields from the FolderT template.
- parentFolderId
Template: Id.
- workspaceId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.Documentation: https://smartsheet-platform.github.io/api-docs/#list-org-groups.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://smartsheet-platform.github.io/api-docs/#create-group.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-group.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-group.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- owner
Template: ShortText. A read-only field.
- ownerId
Template: Id.
- members
The value is gathered from
/groups/{{=item.id}}address. Field components:- An array.
-
Uses template:
GroupMember.
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=Smartsheet.UI.GroupEditor.getValue(parameters)}}.
The result is extracted from:{{=response.members}}.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://smartsheet-platform.github.io/api-docs/#get-group.
- [Create] action
-
Endpoint URL address:
/groups/{{=Smartsheet.UI.GroupEditor.getValue(parameters)}}/members.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://smartsheet-platform.github.io/api-docs/#add-group-members.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.groupId}}/members/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#remove-group-member.
The resource includes the fields from the GroupMember template.
- groupId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/home.
The result is extracted from:{{=[response]}}.Documentation: https://smartsheet-platform.github.io/api-docs/#list-contents.
- sheets
Field components:
- An array.
-
Uses template:
SheetT.
- folders
Field components:
- An array.
-
Uses template:
FolderT.
- reports
Field components:
- An array.
-
Uses template:
ReportT.
- templates
Field components:
- An array.
-
Uses template:
TemplateT.
- workspaces
Field components:
- An array.
-
Uses template:
WorkspaceT.
- sights
Field components:
- An array.
-
Uses template:
SightT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports.Documentation: https://smartsheet-platform.github.io/api-docs/#list-reports.
The resource includes the fields from the ReportT template.
- export
Data type: DT_IMAGE The value is gathered from
/reports/{{=item.id}}address.- sourceSheets
The value is gathered from
/reports/{{=item.id}}address. Field components:- An array.
-
Uses template:
SheetT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}.
The result is extracted from:{{=response.rows}}.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
Documentation: https://smartsheet-platform.github.io/api-docs/#list-rows.
- [Create] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://smartsheet-platform.github.io/api-docs/#add-rows.
- [Update] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://smartsheet-platform.github.io/api-docs/#update-rows.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://smartsheet-platform.github.io/api-docs/#delete-rows.
The resource includes the fields from the RowT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/search.
The result is extracted from:{{=response.results}}.Documentation: https://smartsheet-platform.github.io/api-docs/#search-everything.
- [Read sheetId] action
-
Endpoint URL address:
/search/sheets/{{=Smartsheet.getSheetId(parameters)}}.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
Documentation: https://smartsheet-platform.github.io/api-docs/#search-sheet.
- text
Template: LongText.
- objectId
Template: Id.
- objectType
Template: ShortText.
- parentObjectId
Template: Id.
- parentObjectType
Template: ShortText.
- parentObjectName
Template: ShortText.
- contextData
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets.Documentation: https://smartsheet-platform.github.io/api-docs/#list-sheets.
- [Read all] action
-
Endpoint URL address:
/users/sheets.Documentation: https://smartsheet-platform.github.io/api-docs/#list-org-sheets.
- [Read workspaceId] action
-
Endpoint URL address:
/workspaces/{{=Smartsheet.UI.WorkspaceEditor.getValue(parameters)}}.
The result is extracted from:{{=response.sheets}}.The action has the following user-defined parameters:
- workspaceId: Required. Select workspace.
Documentation: Specify workspace identifier to get sheets from..
- [Create] action
-
Endpoint URL address:
{{=item.parentFolderId && '/folders/' + item.parentFolderId + '/sheets' || item.workspaceId && '/workspaces/' + item.workspaceId + '/sheets' || '/sheets'}}.Documentation: https://smartsheet-platform.github.io/api-docs/#create-sheet.
- [Update] action
-
Endpoint URL address:
/sheets/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-sheet.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-sheet.
The resource includes the fields from the SheetT template.
- parentFolderId
Template: Id.
- workspaceId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sights.Documentation: https://smartsheet-platform.github.io/api-docs/#list-sights.
- [Update] action
-
Endpoint URL address:
/sights/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-sight.
- [Delete] action
-
Endpoint URL address:
/sights/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-sight.
The resource includes the fields from the SightT template.
- widgets
A read-only field. The value is gathered from
/sights/{{=item.id}}address. The gathered value is processed with{{=response[field.name]}}expression. Field components:- An array.
- Contains the following components: id, type, title, showTitle, showTitleIcon, titleFormat, xPosition, yPosition, height, width, version, contents.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/templates.Documentation: https://smartsheet-platform.github.io/api-docs/#list-user-created-templates.
- [Read public] action
-
Endpoint URL address:
/templates/public.Documentation: https://smartsheet-platform.github.io/api-docs/#list-public-templates.
The resource includes the fields from the TemplateT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/updaterequests.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
Documentation: https://smartsheet-platform.github.io/api-docs/#get-all-update-requests.
- [Create] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/updaterequests.Documentation: https://smartsheet-platform.github.io/api-docs/#create-update-request.
- [Update] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/updaterequests/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#change-update-request.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=item.sheetId}}/updaterequests/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-update-request.
- id
A key field. Template: Id.
- sheetId
A key field. Template: Id.
- sendTo
-
Field components:
- An array.
- Contains the following components: email, groupId.
Documentation: https://smartsheet-platform.github.io/api-docs/#recipient-object.
- subject
Template: ShortText.
- message
Template: LongText.
- ccMe
Data type: DT_BOOL
- columnIds
Template: LongText. A composite field.
- includeAttachments
Data type: DT_BOOL
- includeDiscussions
Data type: DT_BOOL
- layout
Template: ShortText.
- rowIds
Template: LongText. A composite field.
- sentBy
Template: UserT. A read-only field.
- schedule
-
Field components:
-
Uses template:
ShortText. - Contains the following components: type, startAt, endAt, dayOfMonth, dayOrdinal, dayDescriptors, repeatEvery, lastSentAt, nextSendAt.
Documentation: https://smartsheet-platform.github.io/api-docs/#schedule-object.
-
Uses template:
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: https://smartsheet-platform.github.io/api-docs/#list-users.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://smartsheet-platform.github.io/api-docs/#add-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-user.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}.Documentation: https://smartsheet-platform.github.io/api-docs/#remove-user.
The resource includes the fields from the UserT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workspaces.Documentation: https://smartsheet-platform.github.io/api-docs/#list-workspaces.
- [Create] action
-
Endpoint URL address:
/workspaces.Documentation: https://smartsheet-platform.github.io/api-docs/#create-workspace.
- [Update] action
-
Endpoint URL address:
/workspaces/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-workspace.
- [Delete] action
-
Endpoint URL address:
/workspaces/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-workspace.
The resource includes the fields from the WorkspaceT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.Documentation: https://smartsheet-platform.github.io/api-docs/#list-webhooks.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://smartsheet-platform.github.io/api-docs/#create-webhook.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#update-webhook.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://smartsheet-platform.github.io/api-docs/#delete-webhook.
- id
A key field. Template: Id.
- name
Template: ShortText.
- apiClientId
Template: ShortText. A read-only field.
- apiClientName
Template: ShortText. A read-only field.
- scope
Template: ShortText.
- scopeObjectId
Template: Id.
- events
Template: LongText. A composite field.
- callbackUrl
Template: ShortText.
- sharedSecret
Template: ShortText. A read-only field.
- enabled
Data type: DT_BOOL A read-only field.
- status
Template: ShortText. A read-only field.
- disabledDetails
Template: ShortText. A read-only field.
- version
Data type: DT_I4
- stats
A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: lastCallbackAttemptRetryCount, lastCallbackAttempt, lastSuccessfulCallback.
-
Uses template:
- createdAt
Template: DateTime. A read-only field.
- modifiedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}.
The result is extracted from:{{=Smartsheet.readData(parameters, response)}}.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
- startRow: Optional. Specify row to start reading from.
- [Create] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
- location: Specifies row insertion location - toTop, toBottom, parentId, siblingId, above
- clear: Specifies to clear sheet before insert. Specify 1-5 to remove rows between 1-5. Specify 5- to remove all rows starting from row 5. If empty, the entire sheet will be cleared.
The following request parameters will be automatically processed:
-
application/json:
{{=Smartsheet.writeSheetData(parameters, batch)}}
Documentation: https://smartsheet-platform.github.io/api-docs/#add-rows.
- [Update] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
The following request parameters will be automatically processed:
-
application/json:
{{=Smartsheet.writeSheetData(parameters, batch)}}
Documentation: https://smartsheet-platform.github.io/api-docs/#update-rows.
- [Delete] action
-
Endpoint URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}/rows.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- sheetPath: Required. Specifies path to spreadsheet. Use the following syntax: workspace/folder/subFolder/sheetName
The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://smartsheet-platform.github.io/api-docs/#delete-rows.
- id
A key field. Template: Id.
- [External]
-
The external fields URL address:
/sheets/{{=Smartsheet.getSheetId(parameters)}}. The external fields list is extracted from:{{=response.columns}}.- {{=external.title}}
Data type: {{=Smartsheet.getDataType(external.type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports/{{=Smartsheet.getObjectId('report:' + parameters.reportPath)}}.
The result is extracted from:{{=Smartsheet.readData(parameters, response)}}.The action has the following user-defined parameters:
- reportPath: Required. Specify the report identifier or choose from the dropdown idesntifier list.
- startRow: Optional. Specify row to start reading from.
- id
A key field. Template: Id.
- [External]
-
The external fields URL address:
/reports/{{=Smartsheet.getObjectId('report:' + parameters.reportPath)}}. The external fields list is extracted from:{{=response.columns}}.- {{=external.title}}
Data type: {{=Smartsheet.getDataType(external.type)}} ( length 255 )
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
pageSize:
{{=parameters.batchSize}} -
page:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
pageSize:
- [Create] action
-
The result is extracted from:{{=response.result}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.result}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Id
Data type: DT_UI8 The gathered value is processed with
{{=value && value.toString()}}expression.- UserT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, email, name, firstName, lastName, admin, licensedSheetCreator, groupAdmin, resourceViewer, status, alternateEmails, sheetCount, lastLogin, customWelcomeScreenViewed.
Documentation: https://smartsheet-platform.github.io/api-docs/#user-object.
-
Uses template:
- AttachmentT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, name, attachmentType, attachmentSubType, createdAt, createdBy, mimeType, parentType, parentId, sizeInKb.
Documentation: https://smartsheet-platform.github.io/api-docs/#attachment-object.
-
Uses template:
- CommentT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, text, createdBy, createdAt, modifiedAt, attachments, discussionId.
Documentation: https://smartsheet-platform.github.io/api-docs/#comment-object.
-
Uses template:
- GroupMember
-
Field components:
-
Uses template:
Id. - Contains the following components: id, email, firstName, lastName, name.
Documentation: https://smartsheet-platform.github.io/api-docs/#groupmember-object.
-
Uses template:
- CellLink
-
Field components:
-
Uses template:
ShortText. - Contains the following components: status, sheetId, rowId, columnId, sheetName.
Documentation: https://smartsheet-platform.github.io/api-docs/#celllink-object.
-
Uses template:
- CellT
-
Field components:
-
Uses template:
Id. - Contains the following components: columnId, columnType, value, displayValue, objectValue, formula, hyperlink, linkInFromCell, linksOutToCells, overrideValidation, format, conditionalFormat, strict, image.
Documentation: https://smartsheet-platform.github.io/api-docs/#cell-object.
-
Uses template:
- ColumnT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, index, title, primary, type, options, contactOptions, hidden, symbol, systemColumnType, autoNumberFormat, tags, validation, width, format, filter, locked, lockedForUser.
Documentation: https://smartsheet-platform.github.io/api-docs/#column-object.
-
Uses template:
- DiscussionT
Field components:
-
Uses template:
Id. - Contains the following components: id, title, comments, commentCount, commentAttachments, parentId, parentType, lastCommentedAt, lastCommentedUser, createdBy, accessLevel, readOnly.
-
Uses template:
- RowT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, sheetId, rowNumber, version, filteredOut, inCriticalPath, locked, lockedForUser, expanded, accessLevel, format, conditionalFormat, createdAt, createdBy, modifiedAt, modifiedBy, columns, permalink, parentId, siblingId, toTop, toBottom, above.
Documentation: https://smartsheet-platform.github.io/api-docs/#row-object.
-
Uses template:
- SheetT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, name, accessLevel, permalink, createdAt, modifiedAt.
Documentation: https://smartsheet-platform.github.io/api-docs/#sheet-object.
-
Uses template:
- ReportT
-
Template: SheetT.
Documentation: https://smartsheet-platform.github.io/api-docs/#report-object.
- TemplateT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, accessLevel, image, largeImage, locale, type, tags, categories, blank, globalTemplate.
Documentation: https://smartsheet-platform.github.io/api-docs/#template-object.
-
Uses template:
- FolderT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, name, permalink.
Documentation: https://smartsheet-platform.github.io/api-docs/#folder-object.
-
Uses template:
- WorkspaceT
Field components:
-
Uses template:
Id. - Contains the following components: id, name, favorite, accessLevel, permalink.
-
Uses template:
- HyperLinkT
-
Field components:
-
Uses template:
ShortText. - Contains the following components: url, sheetId, reportId, sightId.
Documentation: https://smartsheet-platform.github.io/api-docs/#hyperlink-object.
-
Uses template:
- SightT
-
Field components:
-
Uses template:
Id. - Contains the following components: id, name, columnCount, favorite, accessLevel, permalink, createdAt, modifiedAt, workspace.
Documentation: https://smartsheet-platform.github.io/api-docs/#sight-object.
-
Uses template:
Knowledge Base
- Where can I find the documentation for the Smartsheet Connection?
- Error message: Required object attribute(s) are missing from your request: row.id
What's New
- Fixed: Failed to generate authentication token using Edge browser (Thank you, Gbade).
- New: Improved parameter entry.
- Fixed: Update of Text/Number fields is now handled properly (Thank you, Ken).
- Fixed: Destination sheet was cleared during validation when
clearparameter was set (Thank you, Gbade).
- Fixed:
clearparameter was not handled properly in 'Sheet Data' resource Create/Update action (Thank you, Kwame).
- Fixed: Failed with error "Array attributes may not contain null elements: row.cells[]." when updating sheet data (Thank you, Cesar).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.