Objects

Row Object

id	number Row Id.
sheetId	number Parent sheet Id.
siblingId	number Sibling Id.
accessLevel	string Enum: "ADMIN" "COMMENTER" "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 Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval.
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,
"siblingId": 0,
"accessLevel": "ADMIN",
"attachments": [{"id": 0,
"parentId": 0,
"attachmentType": "BOX_COM",
"attachmentSubType": "DOCUMENT",
"mimeType": "PNG",
"parentType": "COMMENT",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"sizeInKb": 0,
"url": "string",
"urlExpiresInMillis": 0
}
],
"cells": [{"columnId": 0,
"columnType": "string",
"conditionalFormat": "string",
"displayValue": "string",
"format": "string",
"formula": "string",
"hyperlink": {"reportId": 0,
"sheetId": 0,
"sightId": 0,
"url": "string"
},
"image": {"altText": "string",
"height": 0,
"id": "string",
"width": 0
},
"linkInFromCell": {"columnId": 0,
"rowId": 0,
"sheetId": 0,
"sheetName": "string",
"status": "BLOCKED"
},
"linksOutToCells": [{"columnId": 0,
"rowId": 0,
"sheetId": 0,
"sheetName": "string",
"status": "BLOCKED"
}
],
"objectValue": {"objectType": "ABSTRACT_DATETIME"
},
"overrideValidation": true,
"strict": true,
"value": "string"
}
],
"columns": [{"autoNumberFormat": {"fill": "string",
"prefix": "string",
"startingNumber": 0,
"suffix": "string"
},
"contactOptions": [{"email": "string",
"name": "string"
}
],
"description": "string",
"format": "string",
"formula": "string",
"hidden": true,
"id": 0,
"index": 0,
"locked": true,
"lockedForUser": true,
"options": ["string"
],
"primary": true,
"symbol": "string",
"systemColumnType": "AUTO_NUMBER",
"tags": ["CALENDAR_END_DATE"
],
"title": "string",
"type": "ABSTRACT_DATETIME",
"validation": true,
"version": 0,
"width": 0
}
],
"conditionalFormat": ",,1,1,,,,,,,,,,,,,",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"discussions": [{"accessLevel": "ADMIN",
"id": 0,
"comments": [{"attachments": [{"id": 0,
"parentId": 0,
"attachmentType": "BOX_COM",
"attachmentSubType": "DOCUMENT",
"mimeType": "PNG",
"parentType": "COMMENT",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": null,
"name": null
},
"name": "string",
"sizeInKb": 0,
"url": "string",
"urlExpiresInMillis": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"discussionId": 0,
"id": 0,
"modifiedAt": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"commentAttachments": [{"id": 0,
"parentId": 0,
"attachmentType": "BOX_COM",
"attachmentSubType": "DOCUMENT",
"mimeType": "PNG",
"parentType": "COMMENT",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"sizeInKb": 0,
"url": "string",
"urlExpiresInMillis": 0
}
],
"commentCount": 0,
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"lastCommentedAt": "2019-08-24T14:15:22Z",
"lastCommentedUser": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"parentId": 0,
"parentType": "ROW",
"readOnly": true,
"title": "string"
}
],
"proof": {"id": 0,
"originalId": 0,
"name": "string",
"proofType": "DOCUMENT",
"proofRequestUrl": "string",
"version": 0,
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"lastUpdatedBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"isCompleted": true,
"attachments": [{"id": 0,
"parentId": 0,
"attachmentType": "BOX_COM",
"attachmentSubType": "DOCUMENT",
"mimeType": "PNG",
"parentType": "COMMENT",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"sizeInKb": 0,
"url": "string",
"urlExpiresInMillis": 0
}
],
"discussions": [{"accessLevel": "ADMIN",
"id": 0,
"comments": [{"attachments": [{"id": null,
"parentId": null,
"attachmentType": null,
"attachmentSubType": null,
"mimeType": null,
"parentType": null,
"createdAt": null,
"createdBy": null,
"name": null,
"sizeInKb": null,
"url": null,
"urlExpiresInMillis": null
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"discussionId": 0,
"id": 0,
"modifiedAt": "2019-08-24T14:15:22Z",
"text": "string"
}
],
"commentAttachments": [{"id": 0,
"parentId": 0,
"attachmentType": "BOX_COM",
"attachmentSubType": "DOCUMENT",
"mimeType": "PNG",
"parentType": "COMMENT",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"sizeInKb": 0,
"url": "string",
"urlExpiresInMillis": 0
}
],
"commentCount": 0,
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"lastCommentedAt": "2019-08-24T14:15:22Z",
"lastCommentedUser": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"parentId": 0,
"parentType": "ROW",
"readOnly": true,
"title": "string"
}
]
},
"expanded": true,
"filteredOut": true,
"format": ",,1,1,,,,,,,,,,,,,",
"inCriticalPath": true,
"locked": true,
"lockedForUser": true,
"modifiedAt": "2019-08-24T14:15:22Z",
"modifiedBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"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": [0
],
"to": {"sheetId": 0
}
}

CopyOrMoveRowResult object

destinationSheetId	number The Id of the destination sheet.
	Array of objects Array of rowMapping objects.

{"destinationSheetId": 0,
"rowMappings": [{"from": 0,
"to": 0
}
]
}

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