다음을 통해 공유

Smartsheet

  • Reference

Smartsheet is a powerful work management and collaboration tool that lets you easily track and manage your work so you and your team can be more productive than ever. Use it to collaborate with others, track progress on any project, automate processes, and better structure your work.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://www.smartsheet.com/
Privacy policy https://www.smartsheet.com/legal/privacy

To use this integration, you will need access to a Smartsheet account. To make a connection, select Sign In. You will be prompted to provide your Smartsheet account information, follow the remainder of the screens to create a connection.

You're now ready to start using this integration.

Throttling Limits

Name Calls Renewal Period
Frequency of trigger polls 1 15 seconds

Actions

Add a comment to a discussion

Add a comment to an existing discussion.
Add a discussion to a row

Add a discussion to a specific row in a sheet.
Add a discussion to a sheet

Add a discussion to a sheet
Get a discussion

Get a specific discussion.
Get a sheet

Get a specific sheet.
Get a sheet data (dynamic schema)

Get a specific sheet data.
Get discussions for a sheet

Get the discussions for a specific sheet.
Get subfolders of a folder

Get subfolders of a specific folder.
Get the columns of a sheet

Get the columns of a specific sheet.
Get the columns of a sheet (dynamic schema)

Get the columns of a specific sheet in dynamic schema format.
Insert row

Insert a row into a specific sheet.
List the sheets

Get a list of the sheets.

Add a comment to a discussion

Operation ID:
AddCommentToDiscussion

Add a comment to an existing discussion.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Discussion
 discussionId True string

The discussion to add the comment to.
Text
 text string

The text of the comment.

Returns

Response object for Creating a Comment.

Body
CreateCommentResponse

Add a discussion to a row

Operation ID:
AddDiscussionToRow

Add a discussion to a specific row in a sheet.

Parameters

Name Key Required Type Description
Sheet
 sheetId True string

The unique id of the sheet.
Row Id
 rowId True string

The unique id of the row.
Title
 title string

The title for the discussion.
Text
 text string

The text of the comment.

Returns

Response object for Create Discussion.

Body
DiscussionResponse

Add a discussion to a sheet

Operation ID:
AddDiscussionToSheet

Add a discussion to a sheet

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

Sheet to add a discussion to
Title
 title string

The title for the discussion.
Text
 text string

The text of the comment.

Returns

Response object for Create Discussion.

Body
DiscussionResponse

Get a discussion

Operation ID:
GetDiscussion

Get a specific discussion.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Discussion Id
 discussionId True string

The unique id of the discussion on the specified sheet.

Returns

Data relevant to the discussion created.

Body
DiscussionData

Get a sheet

Operation ID:
GetSheet

Get a specific sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Comma separated columns to return
 columns string

The list of columns to return

Returns

A Smartsheet sheet with rows.

Body
SheetWithRows

Get a sheet data (dynamic schema)

Operation ID:
GetSheetData

Get a specific sheet data.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Comma separated columns to return
 columns string

The list of columns to return

Returns

The outputs of this operation are dynamic.

Get discussions for a sheet

Operation ID:
GetDiscussionsForSheet

Get the discussions for a specific sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[GetDiscussionResponse]

Get subfolders of a folder

Operation ID:
ListSubFolders

Get subfolders of a specific folder.

Parameters

Name Key Required Type Description
Folder Id
 id True string

The id of the folder.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[Folder]

Get the columns of a sheet

Operation ID:
GetColumns

Get the columns of a specific sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[Column]

Get the columns of a sheet (dynamic schema)

Operation ID:
GetColumnsSchema

Get the columns of a specific sheet in dynamic schema format.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.

Returns

Insert row

Operation ID:
InsertRow

Insert a row into a specific sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Row
 row True dynamic

The row to insert.

Returns

Response to InsertRow operation.

Body
InsertRowResponse

List the sheets

Operation ID:
ListSheets

Get a list of the sheets.

Parameters

Name Key Required Type Description
Folder Id (defaults to all)
 optionalFolderId string

The unique id of the folder containing the sheets. If not specified, will default to all.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[Sheet]

Triggers

When a comment is added to a discussion

Triggers when a comment is added to a specific discussion.
When a comment is added to a sheet

Triggers when a comment is added to a specific sheet.
When a discussion is added to a sheet

Triggers when a discussion is added to a sheet.
When a new row is created

Triggers when a new row is created in a specific sheet.
When a new sheet is created

Triggers when a new sheet is created.
When a sheet is updated

Triggers when a specific sheet is updated.
When any sheet is updated

Triggers when any sheet is updated.

When a comment is added to a discussion

Operation ID:
OnCommentAdded

Triggers when a comment is added to a specific discussion.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Discussion Id
 discussionId True string

The unique id of the discussion.

Returns

Response object for Comment.

Body
CommentResponse

When a comment is added to a sheet

Operation ID:
OnNewComment

Triggers when a comment is added to a specific sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[DiscussionComment]

When a discussion is added to a sheet

Operation ID:
OnDiscussionCreated

Triggers when a discussion is added to a sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[GetDiscussionResponse]

When a new row is created

Operation ID:
OnRowCreated

Triggers when a new row is created in a specific sheet.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Columns
 columns string

The comma separated list of columns.

Returns

Response object for OnRowCreated.

Body
RowResponse

When a new sheet is created

Operation ID:
OnNewSheet

Triggers when a new sheet is created.

Parameters

Name Key Required Type Description
Folder Id (defaults to all)
 optionalFolderId string

The unique id of the folder containing the sheets. If not specified, will default to all.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[Sheet]

When a sheet is updated

Operation ID:
OnUpdatedSpecificSheet

Triggers when a specific sheet is updated.

Parameters

Name Key Required Type Description
Sheet Id
 sheetId True string

The unique id of the sheet.
Columns to Return
 columns string

The comma separateed list of columns to return.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[SheetWithRows]

When any sheet is updated

Operation ID:
OnUpdatedSheet

Triggers when any sheet is updated.

Parameters

Name Key Required Type Description
Folder (defaults to all)
 optionalFolderId string

The unique id of the folder containing the sheets. If not specified, will default to all.

Returns

A common pattern for requesting collections from Smartsheet.

Body
SmartsheetCollection[Sheet]

Definitions

SmartsheetCollection[Sheet]

A common pattern for requesting collections from Smartsheet.

Name Path Type Description
Data
 data array of Sheet

Collection of Smartsheet models.

Sheet

A Smartsheet sheet.

Name Path Type Description
Access Level
 accessLevel string

The access level of the sheet.
Id
 id integer

The unique identifier for the sheet.
Name
 name string

The name of the sheet.
Url
 permalink string

The url for the sheet.
Created At
 createdAt date-time

The datetime when the sheet was created.
Modified At
 modifiedAt date-time

The datetime the sheet was modified.

SmartsheetCollection[DiscussionComment]

A common pattern for requesting collections from Smartsheet.

Name Path Type Description
Data
 data array of DiscussionComment

Collection of Smartsheet models.

DiscussionComment

A comment on a discussion.

Name Path Type Description
Comment Text
 text string

The text of the comment.
Comment Id
 id integer

The id for the comment.
createdBy
 createdBy DiscussionCommentUser

The user who created the comment.
Created At
 createdAt date-time

The datetime the comment was created.
Modified At
 modifiedAt date-time

The datetime the comment was modified.

DiscussionCommentUser

The user who created the comment.

Name Path Type Description
Created By (Name)
 name string

The name of the user who created a comment.
Created By (Email)
 email string

The email of the user who created a comment.

SheetWithRows

A Smartsheet sheet with rows.

Name Path Type Description
Sheet HTML
 rowHTML string

An HTML table representation of the sheet.
Access Level
 accessLevel string

The access level of the sheet.
Id
 id integer

The unique identifier for the sheet.
Name
 name string

The name of the sheet.
Url
 permalink string

The url for the sheet.
Created At
 createdAt date-time

The datetime the sheet was created.
Modified At
 modifiedAt date-time

The datetime the sheet was modified.
Columns
 columns array of Column

Array of columns.
Rows
 rows array of RowData

Array of rows.

SmartsheetCollection[Column]

A common pattern for requesting collections from Smartsheet.

Name Path Type Description
Data
 data array of Column

Collection of Smartsheet models

Column

A Smartsheet column.

Name Path Type Description
Column Id
 id integer

The unique id of the column.
Column Index
 index integer

The ordinal position of the column.
Title
 title string

The title of the column.
Data Type
 type string

The data type of the column (such as text_number or datetime).
Is Primary
 primary boolean

A boolean value (true, false) determining whether or not the column is the primary column.
Width
 width integer

The width in pixels of the column,

InsertRowResponse

Response to InsertRow operation.

Name Path Type Description
result
 result InsertRowResponseResult

InsertRowResponseResult

Name Path Type Description
Sheet Id
 sheetId integer

The Id of the sheet that was modified.
Row Number
 rowNumber integer

The row number of the newly inserted row.
Created At
 createdAt date-time

The datetime the sheet was created.
Modified At
 modifiedAt date-time

The datetime the sheet was modified.

SmartsheetCollection[SheetWithRows]

A common pattern for requesting collections from Smartsheet.

Name Path Type Description
Data
 data array of SheetWithRows

Collection of Smartsheet models.

SmartsheetCollection[Folder]

A common pattern for requesting collections from Smartsheet.

Name Path Type Description
Data
 data array of Folder

Collection of Smartsheet models.

Folder

A Smartsheet folder.

Name Path Type Description
Id
 id integer

The unique id of the folder.
Name
 name string

The name of the folder.
Url
 permalink string

The url for the folder.

DiscussionResponse

Response object for Create Discussion.

Name Path Type Description
result
 result DiscussionData

Data relevant to the discussion created.

DiscussionData

Data relevant to the discussion created.

Name Path Type Description
Id of Discussion
 id integer

The id for the discussion.
Discussion title
 title string

The title for the discussion.
Comments
 comments array of DiscussionComment

The comments in the discussion.
createdBy
 createdBy DiscussionUser

The user who created the discussion.

DiscussionUser

The user who created the discussion.

Name Path Type Description
Created By (Name)
 name string

The name of the user who created the discussion.
Created By (Email)
 email string

The email of the user who created the discussion.

SmartsheetCollection[GetDiscussionResponse]

A common pattern for requesting collections from Smartsheet.

Name Path Type Description
Data
 data array of GetDiscussionResponse

Collection of Smartsheet models.

GetDiscussionResponse

Response object for Get Discussions.

Name Path Type Description
Discussion Id
 id integer

The unique id of the discussion.
Discussion Title
 title string

The title for the discussion.
createdBy
 createdBy DiscussionUser

The user who created the discussion.
Access Level
 accessLevel string

The access Level for the discussion.
Parent Type
 parentType string

The parent type for the discussion.
Is Read-Only
 readOnly boolean

A boolean value (true, false) determining whether or not this discussion is read-only.
Last Commented At
 lastCommentedAt date-time

The datetime of the most recent comment

RowResponse

Response object for OnRowCreated.

Name Path Type Description
Rows
 rows array of RowData

The content of the row that was created.

RowData

A row

Name Path Type Description
Row Id
 id integer

The unique id for the row.
Sheet Id
 sheetId integer

The id of the sheet the row was added to.
Url
 permalink string

The url for the sheet the row was added to.
Created At
 createdAt date-time

The datetime the row was created.
Modified At
 modifiedAt date-time

The datetime the row was modified.
Row Number
 rowNumber integer

The number of the row.
Cells
 cells array of RowCell

The cell detail in the row.
Row HTML
 rowHTML string

An HTML table representation of the new row.

RowCell

A cell in a row

Name Path Type Description
Column Id
 columnId integer

The id of column for this cell.
Cell Value
 value

The value of the cell.
Cell Display Value
 displayValue string

The display value of the cell.

CreateCommentResponse

Response object for Creating a Comment.

Name Path Type Description
result
 result DiscussionComment

A comment on a discussion.

CommentResponse

Response object for Comment.

Name Path Type Description
Comments
 comments array of DiscussionComment

Comments in this discussion.