Objects

Cell Object

columnId
number

The Id of the column that the cell is located in.

columnType
string

Only returned if the include query string parameter contains columnType.

conditionalFormat
string

The format descriptor describing this cell's conditional format. Only returned if the include query string parameter contains format and this cell has a conditional format applied.

displayValue
string

Visual representation of cell contents, as presented to the user in the UI.

format
string

The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied.

formula
string

The formula for a cell, if set, for instance =COUNTM([Assigned To]3). Note that calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as cell.value = "#CIRCULAR REFERENCE".

object
object
object
Array of objects
object

The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly.

overrideValidation
boolean

(Admin only) Indicates whether the cell value can contain a value outside of the validation limits (value = true). When using this parameter, you must also set strict to false to bypass value type checking. This property is honored for POST or PUT actions that update rows.

strict
boolean

Set to false to enable lenient parsing. Defaults to true. You can specify this attribute in a request, but it is never present in a response.

string or number or boolean

A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value.

{
  • "columnId": 0,
  • "columnType": "string",
  • "conditionalFormat": "string",
  • "displayValue": "string",
  • "format": "string",
  • "formula": "string",
  • "hyperlink": {
    },
  • "image": {
    },
  • "linkInFromCell": {
    },
  • "linksOutToCells": [
    ],
  • "objectValue": {
    },
  • "overrideValidation": true,
  • "strict": true,
  • "value": "string"
}

CellHistory Object

string or number
object

User object containing the name and email of the user that made the change.

columnId
number

The Id of the column that the cell is located in.

columnType
string

Only returned if the include query string parameter contains columnType.

conditionalFormat
string

The format descriptor describing this cell's conditional format. Only returned if the include query string parameter contains format and this cell has a conditional format applied.

displayValue
string

Visual representation of cell contents, as presented to the user in the UI.

format
string

The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied.

formula
string

The formula for a cell, if set, for instance =COUNTM([Assigned To]3). Note that calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as cell.value = "#CIRCULAR REFERENCE".

object
object
object
Array of objects
object

The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly.

overrideValidation
boolean

(Admin only) Indicates whether the cell value can contain a value outside of the validation limits (value = true). When using this parameter, you must also set strict to false to bypass value type checking. This property is honored for POST or PUT actions that update rows.

strict
boolean

Set to false to enable lenient parsing. Defaults to true. You can specify this attribute in a request, but it is never present in a response.

string or number or boolean

A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value.

{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "columnId": 0,
  • "columnType": "string",
  • "conditionalFormat": "string",
  • "displayValue": "string",
  • "format": "string",
  • "formula": "string",
  • "hyperlink": {
    },
  • "image": {
    },
  • "linkInFromCell": {
    },
  • "linksOutToCells": [
    ],
  • "objectValue": {
    },
  • "overrideValidation": true,
  • "strict": true,
  • "value": "string"
}

Duration Object

days
number

The number of days for this duration.

elapsed
boolean

If true, indicates this duration represents elapsed time, which ignores non-working time.

hours
number

The number of hours for this duration.

milliseconds
number

The number of milliseconds for this duration.

minutes
number

The number of minutes for this duration.

negative
boolean

When used as a predecessor's lag value, indicates whether the lag is negative (if true), or positive (false). The individual duration values themselves (for example, days, hours, or minutes) is always positive.

objectType
string
Value: "DURATION"
seconds
number

The number of seconds for this duration.

weeks
number

The number of weeks for this duration.

{
  • "days": 0,
  • "elapsed": true,
  • "hours": 0,
  • "milliseconds": 0,
  • "minutes": 0,
  • "negative": true,
  • "objectType": "DURATION",
  • "seconds": 0,
  • "weeks": 0
}

ObjectValue Object

objectType
string
Enum: "ABSTRACT_DATETIME" "CONTACT" "DATE" "DATETIME" "DURATION" "MULTI_CONTACT" "MULTI_PICKLIST" "PREDECESSOR_LIST"
{
  • "objectType": "ABSTRACT_DATETIME"
}

Predecessor Object

rowId
number

The Id of the predecessor row.

type
string
Enum: "FF" "FS" "SF" "SS"

Type of the predecessor:

  • FF (Finish-to-Finish) - finish at the same time the predecessor finishes.
  • FS (Finish-to-Start) - start after the predecessor finishes.
  • SF (Start-to-Finish) - finish before the predecessor starts.
  • SS (Start-to-Start) - start at the same time the predecessor starts.
inCriticalPath
boolean

True if this predecessor is in the critical path.

invalid
boolean

True if the row referenced by rowId is not a valid row in this sheet, or there is a circular reference (displayed in the Smartsheet app as "#REF") Omitted if false.

object

In a project sheet, represents a value in a duration cell, or a lag value of a predecessor.

rowNumber
number

The row number of the predecessor row. Omitted if invalid is true.

{
  • "rowId": 0,
  • "type": "FF",
  • "inCriticalPath": true,
  • "invalid": true,
  • "lag": {
    },
  • "rowNumber": 0
}

PredecessorList Object

objectType
string
Value: "PREDECESSOR_LIST"
Array of objects
{
  • "objectType": "ABSTRACT_DATETIME",
  • "predecessors": [
    ]
}
➔ Next to Methods