Procedures

Automation procedures in the Smartsheet book.

The following documentation is for Smartsheet v1.3.3 (BDK).

to add some content to a sheet

Append the contents of a table into an existing sheet.

Input Concepts

Concept
Description
Type
Required
Default Value

The sheet to add the content to.

smartsheet sheet

Yes

(no default)

content

The table object to append.

table

Yes

(no default)

Output Concepts

Concept
Description
Type

the sheet the content was appended to

smartsheet sheet

Examples

Append the contents of a table in a sheet

get a sheet whose name is "Invoices"
>>>
create a table where
the column names are "Product Id", "Price"
insert a row in the table where
    the Product Id is "00003"
    the Price is 313
use the table as the content
>>>
add the content to the sheet

to get some (sheet's columns)

Get a sheet's columns.

Input Concepts

Concept
Description
Type
Required
Default Value

The sheet to get columns for

smartsheet sheet

Yes

(no default)

Output Concepts

Concept
Description
Type

a list of columns

smartsheet column

Examples

Get the sheet's columns

get a sheet whose name is "Invoices"
get the sheet's columns

to get some (sheet's rows)

FILTER - CAPABLE

Get a sheet's rows.

Input Concepts

Concept
Description
Type
Required
Default Value

The sheet to get rows for

smartsheet sheet

Yes

(no default)

Output Concepts

Concept
Description
Type

a list of rows

smartsheet row

Examples

Get the sheet's rows

get a sheet whose name is "Invoices"
get the sheet's rows

to get some (sheets)

FILTER - CAPABLE

Gets all sheets.

Output Concepts

Concept
Description
Type

A list of sheets

smartsheet sheet

Examples

Get all sheets

get some sheets

Get a sheet by name

get the sheet whose name is "Products"

to get some (workspaces)

FILTER - CAPABLE

Gets all workspaces.

Output Concepts

Concept
Description
Type

A list of workspaces

smartsheet workspace

Examples

Get all workspaces

get some workspaces

Get a workspace by name

get a workspace whose name is "Workspace Name"

to insert a (new column) in a sheet

Inserts a column in a sheet.

Input Concepts

Concept
Description
Type
Required
Default Value

The sheet to add the column to

smartsheet sheet

Yes

(no default)

name

Name of column to add

text

Yes

(no default)

column type

Type of column to add

enum[abstract_datetime, checkbox, contact_list, date, datetime, multi_contact_list, multi_picklist, picklist, predecessor, text_number]

Yes

(no default)

index

Index of column to add (First index is 1)

number

Yes

(no default)

Output Concepts

Concept
Description
Type

the created column

smartsheet column

Examples

Insert a new column at index

get a sheet whose name is "Products"
>>>
insert a new column in the sheet where
    the name is "Product Type"
    the column type is "TEXT_NUMBER"
    the index is 2

to insert a (new row) in a sheet

Append a row in a sheet.

Input Concepts

Concept
Description
Type
Required
Default Value

The sheet to add the row to

smartsheet sheet

Yes

(no default)

values

List of values to insert

boolean or number or text

Yes

(no default)

An existing row under which the new row will be indented

smartsheet row

No

(no default)

Output Concepts

Concept
Description
Type

the created row

smartsheet row

Examples

Append a new row to a sheet

get a sheet whose name is "Documents"
insert a new row in the sheet where
    the values are 384230, "Invoice", "Completed"

to write the content in a workspace

Set the contents of a table to a new sheet.

Input Concepts

Concept
Description
Type
Required
Default Value

Workspace to create the sheet in.

smartsheet workspace

Yes

(no default)

sheet name

The name of the new sheet.

text

Yes

(no default)

content

The table object to set in the sheet.

table

Yes

(no default)

Output Concepts

Concept
Description
Type

the created sheet

smartsheet sheet

Examples

Set the contents of a table into a new sheet

get a workspace whose name is "Workspace Name"
>>>
create a table where
the column names are "Product Id", "Price"
insert a row in the table where
    the Product Id is "00003"
    the Price is 313
use the table as the content
>>>
write the content in the workspace
      the sheet name is "Product Sheet"

Last updated

Was this helpful?