Objects

Row Object

id
number

Row Id.

sheetId
number

Parent sheet Id.

accessLevel
string
Enum: "ADMIN" "EDITOR" "EDITOR_SHARE" "OWNER" "VIEWER"
Array of objects

Attachments on row. Only returned if the include query string parameter contains attachments.

Array of objects

Cells belonging to the row.

Array of objects

Columns of row. Only returned if the include query string parameter contains columns.

conditionalFormat
string

Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.

string or number
object

User object containing name and email of the creator of this row.

Array of objects

Discussions on the row. Only returned if the include query string parameter contains discussions.

object

Proof Object

expanded
boolean

Indicates whether the row is expanded or collapsed.

filteredOut
boolean

Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.

format
string

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

inCriticalPath
boolean

Only returned, with a value of true, if the sheet is a project sheet with dependencies enabled and this row is in the critical path.

locked
boolean

Indicates whether the row is locked.

lockedForUser
boolean

Indicates whether the row is locked for the requesting user.

string or number
object

User object containing name and email of the last person to modify this row.

permaLink
string

URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.

rowNumber
number >= 1

Row number within the sheet.

version
number

Sheet version number that is incremented every time a sheet is modified.

{
  • "id": 0,
  • "sheetId": 0,
  • "accessLevel": "ADMIN",
  • "attachments": [
    ],
  • "cells": [
    ],
  • "columns": [
    ],
  • "conditionalFormat": ",,1,1,,,,,,,,,,,,,",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "discussions": [
    ],
  • "proofs": {
    },
  • "expanded": true,
  • "filteredOut": true,
  • "format": ",,1,1,,,,,,,,,,,,,",
  • "inCriticalPath": true,
  • "locked": true,
  • "lockedForUser": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "permaLink": "string",
  • "rowNumber": 1,
  • "version": 0
}

CopyOrMoveRowDestination Object

sheetId
number

The Id of the destination sheet.

{
  • "sheetId": 0
}

CopyOrMoveRowDirective Object

rowIds
Array of numbers

The Ids of the rows to move or copy from the source sheet.

object
{
  • "rowIds": [
    ],
  • "to": {
    }
}

CopyOrMoveRowResult object

destinationSheetId
number

The Id of the destination sheet.

Array of objects

Array of rowMapping objects.

{
  • "destinationSheetId": 0,
  • "rowMappings": [
    ]
}

RowMapping Object

from
number

Row Id in the source sheet.

to
number

Row Id in the destination sheet.

{
  • "from": 0,
  • "to": 0
}
➔ Next to Methods