appmixer.smartsheet.core.UpdateColumn

Component Details

v1.0.0

Basic Information

appmixer.smartsheet.core.UpdateColumn

1.0.0

Public

Modifies column properties, moves, or renames it. Note: You cannot change the type of a Primary column. With dependencies enabled, special calendar/Gantt columns cannot have their type changed. Changing the column type converts all cells and clears validation. Type is optional for moving or renaming but required when changing type or dropdown values.

Input Ports

in

FieldTypeDescription
Sheet Id number

Sheet Id of the sheet being accessed.
Column Id number

Column Id in the sheet being accessed.
Title text

Column title.
Type select -
Formula text

The formula for a column, if set, for instance =data@row.
Hidden toggle

Indicates whether the column is hidden.
Index number

Column index or position. This number is zero-based.
Description text

Column description.
Format text

The format descriptor (see Formatting). Only returned if the include query string parameter contains format and this column has a non-default format applied to it.
Locked toggle

Indicates whether the column is locked. In a response, a value of true indicates that the column has been locked by the sheet owner or the admin.
Locked For User toggle

Indicates whether the column is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request.
Options textarea JSON array. Example: ["irure enim culpa"].
Symbol text

When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns.
System Column Type select

See System Columns
Validation toggle

Indicates whether validation has been enabled for the column (value = true)
Version number

Read only. The level of the column type. Each element in the array is set to one of the following values:

  • 0: TEXTNUMBER, CONTACTLIST, or PICKLIST
  • 1: MULTICONTACTLIST
  • 2: MULTI_PICKLIST

See Versioning and Changes.
Width number

Display width of the column in pixels.
Auto Number Format Fill text

Indicates zero-padding. Must be between 0 and 10 "0" (zero) characters.
Auto Number Format Prefix text

The prefix. Can include the date tokens:

  • {DD}
  • {MM}
  • {YY}
  • {YYYY}
Auto Number Format Starting Number number

The starting number for the auto-id.
Auto Number Format Suffix text

The suffix. Can include the date tokens:

  • {DD}
  • {MM}
  • {YY}
  • {YYYY}
Contact Options Email text

A parsable email address.
Contact Options Name text

Can be a user's name, display name, or free text.

Output Ports

out

FieldTypeDescription
Message -
Result Code -
Result -
Result Id -
Result Index -
Result Options -
Result Title -
Result Type -
Result Validation -

Full Metadata