Smartsheet

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

OAuth 2.0 authentication connection type

Personal access token authentication connection type

You can create a Smartsheet account using the link Smartsheet Login.

To know more about Smartsheet API, refer to Smartsheet API Reference.

Actions

This section shows how to perform some of the actions in this connector.

DownloadAttachment action

This action downloads an attachment from a sheet.

Input parameters of the DownloadAttachment action

For an example on how to configure the DownloadAttachment action, see Examples.

DeleteAttachment action

This action deletes a specified attachment from a sheet.

Input parameters of the DeleteAttachment action

For example on how to configure the DeleteAttachment action, see Examples.

CopyRowsToAnotherSheet action

This action copies rows from one sheet to another sheet.

Input parameters of the CopyRowsToAnotherSheet action

For example on how to configure the CopyRowsToAnotherSheet action, see Examples.

CopySheet action

This action copies a sheet to a folder, home directory, or workspace.

Input parameters of the CopySheet action

For example on how to configure the CopySheet action, see Examples.

MoveRowsToAnotherSheet action

This action moves rows from one sheet to another sheet.

Input parameters of the MoveRowsToAnotherSheet action

For example on how to configure the MoveRowsToAnotherSheet action, see Examples.

MoveSheet action

This action moves a sheet to a folder, home directory, or workspace.

Input parameters of the MoveSheet action

For example on how to configure the MoveSheet action, see Examples.

Action examples

This section shows how to perform some of the action examples in this connector.

Example - Download an attachment

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadAttachment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "SheetId": "5141926996037508",
     "AttachmentID": "1667587811610500"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

 [
  {
    "Success": "true",
    "URL": "https://s3.amazonaws.com/SmartsheetB1/37540b4438a6466a973d678484c1fac8?response-content-disposition=attachment%3Bfilename%3D%22TestGOOGLE3.txt%22%3Bfilename*%3DUTF-8%27%27TestGOOGLE3.txt&Signature=rVHv4loce%2BrL4lYPlteTgAmkB%2Bk%3D&Expires=1744826533&AWSAccessKeyId=11950YFEZZJFSSKKB3G2",
    "Content": "VGhpcyBpcyBhIHRlc3QgYXR0YWNobWVudC4="
  }
]

Example - Delete an attachment

1. In the Configure connector task dialog, click Actions.
2. Select DeleteAttachment action, and then click Done.
3. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Default Value field:

   {
     "SheetId": "5141926996037508",
     "AttachmentID": "1667587811610500"
   }
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

[
  {
    "Success": "true",
  }
]

Example - Copy rows to another sheet

1. In the Configure connector task dialog, click Actions.
2. Select CopyRowsToAnotherSheet action, and then click Done.
3. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Default Value field:

     {
     "SheetId": "7483321975000964",
     "RowIds": "7935781927128964",
     "DestinationSheetId": "7197099985686404"
   }
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

 [
  {
  "Success": "true",
	"AffectedRows":"1"
  }
]

Example - Copy a sheet

1. In the Configure connector task dialog, click Actions.
2. Select CopySheet action, and then click Done.
3. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Default Value field:

   {
     "SheetId": "5141926996037508",
     "DestinationType": "workspace",
     "DestinationId": "4219254305253252",
     "NewName": "Copied sheet appears",
     "Include": "comments"
   }
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

[
  {
    "Success": "true",
  }
]

Example - Move rows to another sheet

1. In the Configure connector task dialog, click Actions.
2. Select MoveRowsToAnotherSheet action, and then click Done.
3. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Default Value field:

   {
     "SheetId": "7483321975000964",
     "RowIds": "7935781927128964",
     "DestinationSheetId": "7197099985686404"
   }
   

Running this example returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

[
  {
  "Success": "true",
	"AffectedRows":"1"
  }
]

Example - Move a sheet

1. In the Configure connector task dialog, click Actions.
2. Select MoveSheet action, and then click Done.
3. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Default Value field:

   {
     "SheetId": "5141926996037508",
     "DestinationType": "workspace",
     "DestinationId": "4219254305253252"
   }
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

[
  {
    "Success": "true",
  }
]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all the columns of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Info_Columns from the Entity list.
3. Select the List operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause as per the customer requirement.

You must use single quotes (') to enclose the value for a filter clause. You can use the filterClause to filter records based on the columns.

Example - Get column details of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Info_Columns from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the entityId to "849633317179268" which is the key to be passed. To set the entityId, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "849633317179268" in the Input Value field and choose the entityId as local variable.

The value for entityId should be passed directly, such as "849633317179268". Here, "849633317179268" is the unique primary key value, which must be passed

In some cases, passing entityId may throw an error because of two composite keys. In such cases, you can use the filterClause and pass the value, such as id='849633317179268'.

Example - Delete a row from a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Team_Task_List_by_Priority from the Entity list.
3. Select the Delete operation, and then click Done.
4. Set the entityId to "849633317179268" which is the key to be passed. To set the entityId, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "849633317179268" in the Input Value field and choose the entityId as local variable.

If the entity has two composite business or primary keys instead of specifying the entityId, you can also set the filterClause to id='849633317179268'.

Example - Create an attachment to a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Info_Attachments from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {
     "SheetId": "5141926996037508",
     "RowId": "8196592918597508",
     "Name": "Random.txt",
     "ContentEncoded": "VGhpcyBpcyBhIHRlc3QgYXR0YWNobWVudC4="
   }
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"Id": "7144235189178244" }
   

Example - Create a project in a row with fixed deadlines using a Gantt-style layout

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Gantt_Project_with_Hard_Deadline from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "Created from googlecloud"}
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"RowId": "7860088629366660"}
   

Example - Create a team task in a row of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Team_Task_List_by_Priority from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "Created from googlecloud"}
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"RowId": "7860088629366660"}
   

Example - Create a sales activity in a row of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Sales_Activity_Tracking_by_Rep_Month from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "Created from googlecloud"}
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"RowId": "7860088629366660"}
   

Example - Create a sales opportunity in a row of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Simple_Sales_Pipeline from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "Created from googlecloud"}
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"RowId": "7860088629366660" }
   

Example - Create a sales report in a row of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Report_Sales_Activity_And_Team_Objectives from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "Created from googlecloud"}
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"RowId": "7860088629366660" }
   

Example - Create an order in a row of a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Customer_Order_Tracking_History from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "Created from googlecloud"}
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {"RowId": "7860088629366660" }
   

Example - Create a new column in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Info_Columns from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {
     "SheetId": "3315287605596036",
     "Title": "newexposedcolumn",
     "Index": 2,
     "Type": "DATE"
   }
   

   Running this example returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
     "Id": "550917885349764"
   }
   

Example - Create a new folder in a workspace

1. In the Configure connector task dialog, click Entities.
2. Select Info_Folders from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {
     "ParentFolderId": "8716915511191428",
     "Name": "sub-folder-p2"
   }
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "550917885349764"
   }
   

Example - Create a new workspace in an account

1. In the Configure connector task dialog, click Entities.
2. Select Info_Workspaces from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {
     "Name": "new workspace (newly exposed)"
   }
   

   Running this example returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
     "Id": "550917885349764"
   }
   

Example - Create a new user in an account

1. In the Configure connector task dialog, click Entities.
2. Select Info_Users from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {
     "FirstName": "charlie",
     "Email": "charlie@altostrat.com",
     "LastName": "c",
     "Admin": true,
     "LicensedSheetCreator": true
   }
   

   Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "550917885349764"
   }
   

Example - Update project details in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Gantt_Project_with_Hard_Deadline from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entityId in the Data mapper section of the Tasks, click entityId and then enter 849633317179268 in the given field.
5. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

    {"Task Name": "updated from googlecloud"}
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
  "RowId": null
}

Example - Update a team task in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Team_Task_List_by_Priority from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entityId in the Data mapper section of the Tasks, click entityId and then enter 849633317179268 in the given field.
5. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "updated from googlecloud"}
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
  "RowId": null
}

Example - Update a sales activity in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Sales_Activity_Tracking_by_Rep_Month from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entityId in the Data mapper section of the Tasks, click entityId and then enter 849633317179268 in the given field.
5. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

    {"Task Name": "updated from googlecloud"}
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
  "RowId": null
}

Example - Update a sales opportunity in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Simple_Sales_Pipeline from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entityId in the Data mapper section of the Tasks, click entityId and then enter 849633317179268 in the given field.
5. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "updated from googlecloud"}
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
  "RowId": null
}

Example - Update a sales report in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Report_Sales_Activity_And_Team_Objectives from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entityId in the Data mapper section of the Tasks, click entityId and then enter 849633317179268 in the given field.
5. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "updated from googlecloud"}
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
  "RowId": null
}

Example - Update an order in a sheet

1. In the Configure connector task dialog, click Entities.
2. Select Sheet_Customer_Order_Tracking_History from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entityId in the Data mapper section of the Tasks, click entityId and then enter 849633317179268 in the given field.
5. In the Data mapper section of the Task click Open Data Mapping editor and then enter a value similar to the following in the Input Value field:

   {"Task Name": "updated from googlecloud"}
   

Running this example returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
  "RowId": null
}