Component Details
appmixer.smartsheet.core.ListHomeContents
1.0.0
Public
{ "version": "1.0.0", "name": "appmixer.smartsheet.core.ListHomeContents", "author": "Appmixer <info@appmixer.com>", "description": "Gets a nested list of all Home objects, including dashboards, folders, reports, sheets, templates, and workspaces, as shown on the \"Home\" tab.", "private": false, "inPorts": [ { "name": "in" } ], "outPorts": [ { "name": "out", "options": [ { "label": "Folders", "value": "folders", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder/properties/folders/items" } } }, { "label": "Reports", "value": "reports", "schema": { "type": "array", "items": { "type": "object", "properties": { "scope": { "type": "object", "properties": { "sheets": { "description": "Array of Sheet objects (containing just the sheet Id) of any sheets that the requester has access to that make up the report.\n", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Sheet Id.", "type": "number" }, "fromId": { "description": "The Id of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response.", "type": "number" }, "ownerId": { "description": "User Id of the sheet owner.", "type": "number" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "attachments": { "description": "Array of Attachment objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **attachments**.\n", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "crossSheetReferences": { "description": "Array of CrossSheetReference objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **crossSheetReferences**.\n", "type": "array", "items": { "type": "object", "properties": { "endColumnId": { "description": "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "endRowId": { "description": "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "id": { "description": "Cross-sheet reference Id, guaranteed unique within referencing sheet.", "type": "number" }, "name": { "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.", "type": "string" }, "startColumnId": { "description": "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "startRowId": { "description": "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "status": { "description": "Status of request:\n * 'BLOCKED' - A reference is downstream of a circular issue.\n * 'BROKEN' - The data source location (column, row or sheet) was\ndeleted.\n * 'CIRCULAR' - The formula reference is self referencing and cannot\nbe resolved.\n * 'DISABLED' - Updating the reference is temporarily disabled due\nto maintenance.\n * 'INVALID/UNKNOWN' - The reference is new and had not been validated.\n * 'NOT_SHARED' - No common shared users.\n * 'OK' - The reference is in a good state.\n", "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INVALID/UNKNOWN", "NOT-SHARED", "OK" ] }, "sourceSheetId": { "description": "Sheet Id of source sheet.", "type": "number" } } } }, "dependenciesEnabled": { "description": "Indicates whether dependencies are enabled.", "type": "boolean" }, "discussions": { "description": "Array of Discussion objects\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **discussions**.\n", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "effectiveAttachmentOptions": { "description": "Array of enum strings (see [Attachment.attachmentType](../../tag/attachmentsDescription) indicating the allowable attachment options for the current user and sheet.\n", "type": "array", "items": { "type": "string" } }, "favorite": { "description": "Returned only if the user has marked this sheet as a favorite in their Home tab (value = **true**).", "type": "boolean" }, "ganttEnabled": { "description": "Indicates whether \"Gantt View\" is enabled.", "type": "boolean" }, "hasSummaryFields": { "description": "Indicates whether a sheet summary is present.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "name": { "description": "Sheet name.", "type": "string" }, "owner": { "description": "Email address of the sheet owner.", "type": "string" }, "permalink": { "description": "URL that represents a direct link to the sheet in Smartsheet.", "type": "string" }, "projectSettings": { "description": "Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.", "type": "object", "properties": { "lengthOfDay": { "description": "Length of a workday for a project sheet.", "type": "number", "minimum": 1, "maximum": 24 }, "nonWorkingDays": { "description": "Non-working days for a project sheet.", "type": "array", "items": { "type": "string", "format": "date" } }, "workingDays": { "type": "array", "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } } } }, "readOnly": { "description": "Returned only if the sheet belongs to an expired trial (value = **true**).", "type": "boolean" }, "resourceManagementEnabled": { "description": "Indicates that resource management is enabled.", "type": "boolean" }, "resourceManagementType": { "description": "Resource Management type. Indicates the type of RM that is enabled.", "type": "string", "enum": [ "NONE", "LEGACY_RESOURCE_MANAGEMENT", "RESOURCE_MANAGEMENT_BY_SMARTSHEET" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Row Id.", "type": "number" }, "sheetId": { "description": "Parent sheet Id.", "type": "number" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "attachments": { "description": "Attachments on row. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "cells": { "description": "Cells belonging to the row.", "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "The Id of the column that the cell is located in." }, "columnType": { "type": "string", "description": "Only returned if the include query string parameter contains **columnType**." }, "conditionalFormat": { "type": "string", "description": "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": { "type": "string", "description": "Visual representation of cell contents, as presented to the user in the UI." }, "format": { "type": "string", "description": "The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied." }, "formula": { "type": "string", "description": "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\"**." }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "linkInFromCell": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } }, "linksOutToCells": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "overrideValidation": { "type": "boolean", "description": "(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": { "type": "boolean", "description": "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." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "description": "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." } } } }, "columns": { "description": "Columns of row. Only returned if the include query string parameter contains columns.", "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "conditionalFormat": { "description": "Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussions": { "description": "Discussions on the row. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "proofs": { "description": "Proof on row. Only returned if the include query string parameter contains proofs.", "type": "object", "properties": { "id": { "description": "Proof Id of the proof version.", "type": "number" }, "originalId": { "description": "Proof Id of the original proof version.", "type": "number" }, "name": { "description": "Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.", "type": "string" }, "proofType": { "description": "File type for the proof version.", "type": "string", "enum": [ "DOCUMENT", "IMAGE", "MIXED", "NONE", "VIDEO" ] }, "proofRequestUrl": { "description": "URL to review a proofing request.", "type": "string" }, "version": { "description": "The version number of the proof.", "type": "number" }, "lastUpdatedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastUpdatedBy": { "description": "`User` object containing `name` and `email` of the user who last updated the proof.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "isCompleted": { "description": "Indicates whether the proof is completed.", "type": "boolean" }, "attachments": { "description": "Array of Attachment objects. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "discussions": { "description": "Array of Discussion objects. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } } } }, "expanded": { "description": "Indicates whether the row is expanded or collapsed.", "type": "boolean" }, "filteredOut": { "description": "Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.", "type": "boolean" }, "format": { "description": "Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "inCriticalPath": { "description": "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.", "type": "boolean" }, "locked": { "description": "Indicates whether the row is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the row is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the last person to modify this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "permaLink": { "description": "URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.", "type": "string" }, "rowNumber": { "description": "Row number within the sheet.", "type": "number", "minimum": 1 }, "version": { "description": "Sheet version number that is incremented every time a sheet is modified.", "type": "number" } } } }, "showParentRowsForFilters": { "description": "Returned only if there are column filters on the sheet. Value = **true** if \"show parent rows\" is enabled for the filters.", "type": "boolean" }, "source": { "type": "object", "properties": { "id": { "description": "The Id of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.\n", "type": "number" }, "type": { "description": "**report**, **sheet**, **sight** (aka dashboard), or **template**.\n", "type": "string" } } }, "summary": { "type": "object", "description": "Represents the entire summary, or a list of defined fields and values, for a specific sheet.", "properties": { "fields": { "description": "Array of summary (or metadata) fields defined on the sheet.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "SummaryField Id.", "type": "number" }, "contactOptions": { "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.", "type": "array", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "displayValue": { "description": "Visual representation of cell contents, as presented to the user in the UI.", "type": "string" }, "format": { "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.", "type": "string" }, "formula": { "description": "The formula for a cell, if set.", "type": "string" }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "index": { "description": "Field index or position. This number is zero-based.", "type": "number" }, "locked": { "description": "Indicates whether the field is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the field is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the user who most recently modified this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "options": { "description": "When applicable for PICKLIST column type. Array of the options available for the field.", "type": "array", "items": { "type": "string" } }, "symbol": { "description": "When applicable for PICKLIST column type.", "type": "string" }, "title": { "description": "Arbitrary name, must be unique within summary.", "type": "string" }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] }, "validation": { "description": "Indicates whether summary field values are restricted to the type.", "type": "boolean" } } } } } }, "totalRowCount": { "description": "The total number of rows in the sheet.", "type": "number" }, "userPermissions": { "type": "object", "description": "Describes the current user's editing permissions for a specific sheet.", "properties": { "summaryPermissions": { "description": "One of:\n * ADMIN: full control over fields.\n * READ_DELETE: sheet is owned by an individual account that doesn't\nhave summary capabilities. If a summary exists, the only possible operations are GET and DELETE fields.\n * READ_ONLY.\n * READ_WRITE: can edit values of existing fields, but not create\nor delete fields, nor modify field type.\n", "type": "string", "enum": [ "ADMIN", "READ_DELETE", "READ_ONLY", "READ_WRITE" ] } } }, "userSettings": { "type": "object", "description": "Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet).", "properties": { "criticalPathEnabled": { "description": "Does this user have \"Show Critical Path\" turned on for this sheet? **NOTE**: This setting only has an effect on project sheets with dependencies enabled.\n", "type": "boolean" }, "displaySummaryTasks": { "description": "Does this user have \"Display Summary Tasks\" turned on for this sheet? Applies only to sheets where \"Calendar View\" has been configured.", "type": "boolean" } } }, "version": { "description": "A number that is incremented every time a sheet is modified.", "type": "number" }, "workspace": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number" }, "name": { "description": "Workspace name.", "type": "string" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string" } } } } } }, "workspaces": { "description": "Array of Workspace objects (containing just the workspace Id) that the requester has access to that make up the report.\n", "type": "array", "items": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number" }, "name": { "description": "Workspace name.", "type": "string" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string" } } } } } }, "sourceSheets": { "type": "array", "description": "An array of Sheet objects (without rows), representing the sheets that rows in the report originated from. Only included in the Get Report response if the include parameter specifies sourceSheets.", "items": { "type": "object", "properties": { "id": { "description": "Sheet Id.", "type": "number" }, "fromId": { "description": "The Id of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response.", "type": "number" }, "ownerId": { "description": "User Id of the sheet owner.", "type": "number" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "attachments": { "description": "Array of Attachment objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **attachments**.\n", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "crossSheetReferences": { "description": "Array of CrossSheetReference objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **crossSheetReferences**.\n", "type": "array", "items": { "type": "object", "properties": { "endColumnId": { "description": "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "endRowId": { "description": "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "id": { "description": "Cross-sheet reference Id, guaranteed unique within referencing sheet.", "type": "number" }, "name": { "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.", "type": "string" }, "startColumnId": { "description": "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "startRowId": { "description": "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "status": { "description": "Status of request:\n * 'BLOCKED' - A reference is downstream of a circular issue.\n * 'BROKEN' - The data source location (column, row or sheet) was\ndeleted.\n * 'CIRCULAR' - The formula reference is self referencing and cannot\nbe resolved.\n * 'DISABLED' - Updating the reference is temporarily disabled due\nto maintenance.\n * 'INVALID/UNKNOWN' - The reference is new and had not been validated.\n * 'NOT_SHARED' - No common shared users.\n * 'OK' - The reference is in a good state.\n", "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INVALID/UNKNOWN", "NOT-SHARED", "OK" ] }, "sourceSheetId": { "description": "Sheet Id of source sheet.", "type": "number" } } } }, "dependenciesEnabled": { "description": "Indicates whether dependencies are enabled.", "type": "boolean" }, "discussions": { "description": "Array of Discussion objects\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **discussions**.\n", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "effectiveAttachmentOptions": { "description": "Array of enum strings (see [Attachment.attachmentType](../../tag/attachmentsDescription) indicating the allowable attachment options for the current user and sheet.\n", "type": "array", "items": { "type": "string" } }, "favorite": { "description": "Returned only if the user has marked this sheet as a favorite in their Home tab (value = **true**).", "type": "boolean" }, "ganttEnabled": { "description": "Indicates whether \"Gantt View\" is enabled.", "type": "boolean" }, "hasSummaryFields": { "description": "Indicates whether a sheet summary is present.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "name": { "description": "Sheet name.", "type": "string" }, "owner": { "description": "Email address of the sheet owner.", "type": "string" }, "permalink": { "description": "URL that represents a direct link to the sheet in Smartsheet.", "type": "string" }, "projectSettings": { "description": "Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.", "type": "object", "properties": { "lengthOfDay": { "description": "Length of a workday for a project sheet.", "type": "number", "minimum": 1, "maximum": 24 }, "nonWorkingDays": { "description": "Non-working days for a project sheet.", "type": "array", "items": { "type": "string", "format": "date" } }, "workingDays": { "type": "array", "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } } } }, "readOnly": { "description": "Returned only if the sheet belongs to an expired trial (value = **true**).", "type": "boolean" }, "resourceManagementEnabled": { "description": "Indicates that resource management is enabled.", "type": "boolean" }, "resourceManagementType": { "description": "Resource Management type. Indicates the type of RM that is enabled.", "type": "string", "enum": [ "NONE", "LEGACY_RESOURCE_MANAGEMENT", "RESOURCE_MANAGEMENT_BY_SMARTSHEET" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Row Id.", "type": "number" }, "sheetId": { "description": "Parent sheet Id.", "type": "number" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "attachments": { "description": "Attachments on row. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "cells": { "description": "Cells belonging to the row.", "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "The Id of the column that the cell is located in." }, "columnType": { "type": "string", "description": "Only returned if the include query string parameter contains **columnType**." }, "conditionalFormat": { "type": "string", "description": "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": { "type": "string", "description": "Visual representation of cell contents, as presented to the user in the UI." }, "format": { "type": "string", "description": "The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied." }, "formula": { "type": "string", "description": "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\"**." }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "linkInFromCell": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } }, "linksOutToCells": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "overrideValidation": { "type": "boolean", "description": "(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": { "type": "boolean", "description": "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." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "description": "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." } } } }, "columns": { "description": "Columns of row. Only returned if the include query string parameter contains columns.", "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "conditionalFormat": { "description": "Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussions": { "description": "Discussions on the row. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "proofs": { "description": "Proof on row. Only returned if the include query string parameter contains proofs.", "type": "object", "properties": { "id": { "description": "Proof Id of the proof version.", "type": "number" }, "originalId": { "description": "Proof Id of the original proof version.", "type": "number" }, "name": { "description": "Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.", "type": "string" }, "proofType": { "description": "File type for the proof version.", "type": "string", "enum": [ "DOCUMENT", "IMAGE", "MIXED", "NONE", "VIDEO" ] }, "proofRequestUrl": { "description": "URL to review a proofing request.", "type": "string" }, "version": { "description": "The version number of the proof.", "type": "number" }, "lastUpdatedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastUpdatedBy": { "description": "`User` object containing `name` and `email` of the user who last updated the proof.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "isCompleted": { "description": "Indicates whether the proof is completed.", "type": "boolean" }, "attachments": { "description": "Array of Attachment objects. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "discussions": { "description": "Array of Discussion objects. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } } } }, "expanded": { "description": "Indicates whether the row is expanded or collapsed.", "type": "boolean" }, "filteredOut": { "description": "Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.", "type": "boolean" }, "format": { "description": "Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "inCriticalPath": { "description": "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.", "type": "boolean" }, "locked": { "description": "Indicates whether the row is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the row is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the last person to modify this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "permaLink": { "description": "URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.", "type": "string" }, "rowNumber": { "description": "Row number within the sheet.", "type": "number", "minimum": 1 }, "version": { "description": "Sheet version number that is incremented every time a sheet is modified.", "type": "number" } } } }, "showParentRowsForFilters": { "description": "Returned only if there are column filters on the sheet. Value = **true** if \"show parent rows\" is enabled for the filters.", "type": "boolean" }, "source": { "type": "object", "properties": { "id": { "description": "The Id of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.\n", "type": "number" }, "type": { "description": "**report**, **sheet**, **sight** (aka dashboard), or **template**.\n", "type": "string" } } }, "summary": { "type": "object", "description": "Represents the entire summary, or a list of defined fields and values, for a specific sheet.", "properties": { "fields": { "description": "Array of summary (or metadata) fields defined on the sheet.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "SummaryField Id.", "type": "number" }, "contactOptions": { "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.", "type": "array", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "displayValue": { "description": "Visual representation of cell contents, as presented to the user in the UI.", "type": "string" }, "format": { "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.", "type": "string" }, "formula": { "description": "The formula for a cell, if set.", "type": "string" }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "index": { "description": "Field index or position. This number is zero-based.", "type": "number" }, "locked": { "description": "Indicates whether the field is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the field is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the user who most recently modified this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "options": { "description": "When applicable for PICKLIST column type. Array of the options available for the field.", "type": "array", "items": { "type": "string" } }, "symbol": { "description": "When applicable for PICKLIST column type.", "type": "string" }, "title": { "description": "Arbitrary name, must be unique within summary.", "type": "string" }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] }, "validation": { "description": "Indicates whether summary field values are restricted to the type.", "type": "boolean" } } } } } }, "totalRowCount": { "description": "The total number of rows in the sheet.", "type": "number" }, "userPermissions": { "type": "object", "description": "Describes the current user's editing permissions for a specific sheet.", "properties": { "summaryPermissions": { "description": "One of:\n * ADMIN: full control over fields.\n * READ_DELETE: sheet is owned by an individual account that doesn't\nhave summary capabilities. If a summary exists, the only possible operations are GET and DELETE fields.\n * READ_ONLY.\n * READ_WRITE: can edit values of existing fields, but not create\nor delete fields, nor modify field type.\n", "type": "string", "enum": [ "ADMIN", "READ_DELETE", "READ_ONLY", "READ_WRITE" ] } } }, "userSettings": { "type": "object", "description": "Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet).", "properties": { "criticalPathEnabled": { "description": "Does this user have \"Show Critical Path\" turned on for this sheet? **NOTE**: This setting only has an effect on project sheets with dependencies enabled.\n", "type": "boolean" }, "displaySummaryTasks": { "description": "Does this user have \"Display Summary Tasks\" turned on for this sheet? Applies only to sheets where \"Calendar View\" has been configured.", "type": "boolean" } } }, "version": { "description": "A number that is incremented every time a sheet is modified.", "type": "number" }, "workspace": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number" }, "name": { "description": "Workspace name.", "type": "string" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string" } } } } } }, "isSummaryReport": { "type": "boolean", "description": "A boolean to represent whether the report is a sheet summary report or not. If this property is false, it is a row report.", "example": false }, "proofs": { "description": "Report Proof Object", "type": "object", "properties": { "id": { "description": "Proof Id of the proof version.", "type": "number", "example": 12345 }, "originalId": { "description": "Proof Id of the original proof version.", "type": "number", "example": 1 }, "name": { "description": "Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.", "type": "string", "example": "Project Proof v1" }, "type": { "description": "File type for the proof version.", "type": "string", "enum": [ "DOCUMENT", "IMAGE", "MIXED", "NONE", "VIDEO" ], "example": "DOCUMENT" }, "documentType": { "description": "Document type for the proof version.", "type": "string", "enum": [ "PDF", "VIDEO", "WORD", "POWERPOINT", "EXCEL", "IMAGE" ], "example": "PDF" }, "proofRequestUrl": { "description": "URL to review a proofing request.", "type": "string", "example": "https://proof.smartsheet.com/review/abc123" }, "version": { "description": "The version number of the proof.", "type": "number", "example": 1 }, "lastUpdatedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "lastUpdatedBy": { "description": "`User` object containing `name` and `email` of the user who last updated the proof.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "isCompleted": { "description": "Indicates whether the proof is completed.", "type": "boolean", "example": false } } }, "id": { "description": "Sheet Id.", "type": "number", "example": 12345 }, "fromId": { "description": "The Id of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response.", "type": "number", "example": 1 }, "ownerId": { "description": "User Id of the sheet owner.", "type": "number", "example": 1 }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "attachments": { "description": "Array of Attachment objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **attachments**.\n", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "crossSheetReferences": { "description": "Array of CrossSheetReference objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **crossSheetReferences**.\n", "type": "array", "items": { "type": "object", "properties": { "endColumnId": { "description": "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "endRowId": { "description": "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "id": { "description": "Cross-sheet reference Id, guaranteed unique within referencing sheet.", "type": "number" }, "name": { "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.", "type": "string" }, "startColumnId": { "description": "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "startRowId": { "description": "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "status": { "description": "Status of request:\n * 'BLOCKED' - A reference is downstream of a circular issue.\n * 'BROKEN' - The data source location (column, row or sheet) was\ndeleted.\n * 'CIRCULAR' - The formula reference is self referencing and cannot\nbe resolved.\n * 'DISABLED' - Updating the reference is temporarily disabled due\nto maintenance.\n * 'INVALID/UNKNOWN' - The reference is new and had not been validated.\n * 'NOT_SHARED' - No common shared users.\n * 'OK' - The reference is in a good state.\n", "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INVALID/UNKNOWN", "NOT-SHARED", "OK" ] }, "sourceSheetId": { "description": "Sheet Id of source sheet.", "type": "number" } } } }, "dependenciesEnabled": { "description": "Indicates whether dependencies are enabled.", "type": "boolean", "example": false }, "discussions": { "description": "Array of Discussion objects\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **discussions**.\n", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "effectiveAttachmentOptions": { "description": "Array of enum strings (see [Attachment.attachmentType](../../tag/attachmentsDescription) indicating the allowable attachment options for the current user and sheet.\n", "type": "array", "items": { "type": "string" } }, "favorite": { "description": "Returned only if the user has marked this sheet as a favorite in their Home tab (value = **true**).", "type": "boolean", "example": false }, "ganttEnabled": { "description": "Indicates whether \"Gantt View\" is enabled.", "type": "boolean", "example": false }, "hasSummaryFields": { "description": "Indicates whether a sheet summary is present.", "type": "boolean", "example": false }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "name": { "description": "Sheet name.", "type": "string", "example": "Project Tracker" }, "owner": { "description": "Email address of the sheet owner.", "type": "string", "example": "owner@example.com" }, "permalink": { "description": "URL that represents a direct link to the sheet in Smartsheet.", "type": "string", "example": "https://app.smartsheet.com/sheets/abc123" }, "projectSettings": { "description": "Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.", "type": "object", "properties": { "lengthOfDay": { "description": "Length of a workday for a project sheet.", "type": "number", "minimum": 1, "maximum": 24, "example": 1 }, "nonWorkingDays": { "description": "Non-working days for a project sheet.", "type": "array", "items": { "type": "string", "format": "date" } }, "workingDays": { "type": "array", "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } } } }, "readOnly": { "description": "Returned only if the sheet belongs to an expired trial (value = **true**).", "type": "boolean", "example": false }, "resourceManagementEnabled": { "description": "Indicates that resource management is enabled.", "type": "boolean", "example": false }, "resourceManagementType": { "description": "Resource Management type. Indicates the type of RM that is enabled.", "type": "string", "enum": [ "NONE", "LEGACY_RESOURCE_MANAGEMENT", "RESOURCE_MANAGEMENT_BY_SMARTSHEET" ], "example": "NONE" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Row Id.", "type": "number" }, "sheetId": { "description": "Parent sheet Id.", "type": "number" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "attachments": { "description": "Attachments on row. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "cells": { "description": "Cells belonging to the row.", "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "The Id of the column that the cell is located in." }, "columnType": { "type": "string", "description": "Only returned if the include query string parameter contains **columnType**." }, "conditionalFormat": { "type": "string", "description": "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": { "type": "string", "description": "Visual representation of cell contents, as presented to the user in the UI." }, "format": { "type": "string", "description": "The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied." }, "formula": { "type": "string", "description": "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\"**." }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "linkInFromCell": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } }, "linksOutToCells": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "overrideValidation": { "type": "boolean", "description": "(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": { "type": "boolean", "description": "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." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "description": "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." } } } }, "columns": { "description": "Columns of row. Only returned if the include query string parameter contains columns.", "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "conditionalFormat": { "description": "Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussions": { "description": "Discussions on the row. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "proofs": { "description": "Proof on row. Only returned if the include query string parameter contains proofs.", "type": "object", "properties": { "id": { "description": "Proof Id of the proof version.", "type": "number" }, "originalId": { "description": "Proof Id of the original proof version.", "type": "number" }, "name": { "description": "Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.", "type": "string" }, "proofType": { "description": "File type for the proof version.", "type": "string", "enum": [ "DOCUMENT", "IMAGE", "MIXED", "NONE", "VIDEO" ] }, "proofRequestUrl": { "description": "URL to review a proofing request.", "type": "string" }, "version": { "description": "The version number of the proof.", "type": "number" }, "lastUpdatedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastUpdatedBy": { "description": "`User` object containing `name` and `email` of the user who last updated the proof.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "isCompleted": { "description": "Indicates whether the proof is completed.", "type": "boolean" }, "attachments": { "description": "Array of Attachment objects. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "discussions": { "description": "Array of Discussion objects. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } } } }, "expanded": { "description": "Indicates whether the row is expanded or collapsed.", "type": "boolean" }, "filteredOut": { "description": "Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.", "type": "boolean" }, "format": { "description": "Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "inCriticalPath": { "description": "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.", "type": "boolean" }, "locked": { "description": "Indicates whether the row is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the row is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the last person to modify this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "permaLink": { "description": "URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.", "type": "string" }, "rowNumber": { "description": "Row number within the sheet.", "type": "number", "minimum": 1 }, "version": { "description": "Sheet version number that is incremented every time a sheet is modified.", "type": "number" } } } }, "showParentRowsForFilters": { "description": "Returned only if there are column filters on the sheet. Value = **true** if \"show parent rows\" is enabled for the filters.", "type": "boolean", "example": false }, "source": { "type": "object", "properties": { "id": { "description": "The Id of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.\n", "type": "number", "example": 12345 }, "type": { "description": "**report**, **sheet**, **sight** (aka dashboard), or **template**.\n", "type": "string", "example": "email" } } }, "summary": { "type": "object", "description": "Represents the entire summary, or a list of defined fields and values, for a specific sheet.", "properties": { "fields": { "description": "Array of summary (or metadata) fields defined on the sheet.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "SummaryField Id.", "type": "number" }, "contactOptions": { "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.", "type": "array", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "displayValue": { "description": "Visual representation of cell contents, as presented to the user in the UI.", "type": "string" }, "format": { "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.", "type": "string" }, "formula": { "description": "The formula for a cell, if set.", "type": "string" }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "index": { "description": "Field index or position. This number is zero-based.", "type": "number" }, "locked": { "description": "Indicates whether the field is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the field is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the user who most recently modified this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "options": { "description": "When applicable for PICKLIST column type. Array of the options available for the field.", "type": "array", "items": { "type": "string" } }, "symbol": { "description": "When applicable for PICKLIST column type.", "type": "string" }, "title": { "description": "Arbitrary name, must be unique within summary.", "type": "string" }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] }, "validation": { "description": "Indicates whether summary field values are restricted to the type.", "type": "boolean" } } } } } }, "totalRowCount": { "description": "The total number of rows in the sheet.", "type": "number", "example": 1 }, "userPermissions": { "type": "object", "description": "Describes the current user's editing permissions for a specific sheet.", "properties": { "summaryPermissions": { "description": "One of:\n * ADMIN: full control over fields.\n * READ_DELETE: sheet is owned by an individual account that doesn't\nhave summary capabilities. If a summary exists, the only possible operations are GET and DELETE fields.\n * READ_ONLY.\n * READ_WRITE: can edit values of existing fields, but not create\nor delete fields, nor modify field type.\n", "type": "string", "enum": [ "ADMIN", "READ_DELETE", "READ_ONLY", "READ_WRITE" ], "example": "ADMIN" } } }, "userSettings": { "type": "object", "description": "Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet).", "properties": { "criticalPathEnabled": { "description": "Does this user have \"Show Critical Path\" turned on for this sheet? **NOTE**: This setting only has an effect on project sheets with dependencies enabled.\n", "type": "boolean", "example": false }, "displaySummaryTasks": { "description": "Does this user have \"Display Summary Tasks\" turned on for this sheet? Applies only to sheets where \"Calendar View\" has been configured.", "type": "boolean", "example": false } } }, "version": { "description": "A number that is incremented every time a sheet is modified.", "type": "number", "example": 1 }, "workspace": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number", "example": 12345 }, "name": { "description": "Workspace name.", "type": "string", "example": "Marketing Workspace" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string", "example": "https://app.smartsheet.com/sheets/abc123" } } } } } } }, { "label": "Sheets", "value": "sheets", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Sheet Id.", "type": "number", "example": 12345 }, "fromId": { "description": "The Id of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response.", "type": "number", "example": 1 }, "ownerId": { "description": "User Id of the sheet owner.", "type": "number", "example": 1 }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "attachments": { "description": "Array of Attachment objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **attachments**.\n", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "crossSheetReferences": { "description": "Array of CrossSheetReference objects.\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **crossSheetReferences**.\n", "type": "array", "items": { "type": "object", "properties": { "endColumnId": { "description": "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "endRowId": { "description": "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "id": { "description": "Cross-sheet reference Id, guaranteed unique within referencing sheet.", "type": "number" }, "name": { "description": "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.", "type": "string" }, "startColumnId": { "description": "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.", "type": "number" }, "startRowId": { "description": "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.", "type": "number" }, "status": { "description": "Status of request:\n * 'BLOCKED' - A reference is downstream of a circular issue.\n * 'BROKEN' - The data source location (column, row or sheet) was\ndeleted.\n * 'CIRCULAR' - The formula reference is self referencing and cannot\nbe resolved.\n * 'DISABLED' - Updating the reference is temporarily disabled due\nto maintenance.\n * 'INVALID/UNKNOWN' - The reference is new and had not been validated.\n * 'NOT_SHARED' - No common shared users.\n * 'OK' - The reference is in a good state.\n", "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INVALID/UNKNOWN", "NOT-SHARED", "OK" ] }, "sourceSheetId": { "description": "Sheet Id of source sheet.", "type": "number" } } } }, "dependenciesEnabled": { "description": "Indicates whether dependencies are enabled.", "type": "boolean", "example": false }, "discussions": { "description": "Array of Discussion objects\nOnly returned if the [include](../../tag/sheets#operation/getSheet) query string parameter contains **discussions**.\n", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "effectiveAttachmentOptions": { "description": "Array of enum strings (see [Attachment.attachmentType](../../tag/attachmentsDescription) indicating the allowable attachment options for the current user and sheet.\n", "type": "array", "items": { "type": "string" } }, "favorite": { "description": "Returned only if the user has marked this sheet as a favorite in their Home tab (value = **true**).", "type": "boolean", "example": false }, "ganttEnabled": { "description": "Indicates whether \"Gantt View\" is enabled.", "type": "boolean", "example": false }, "hasSummaryFields": { "description": "Indicates whether a sheet summary is present.", "type": "boolean", "example": false }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "name": { "description": "Sheet name.", "type": "string", "example": "Project Tracker" }, "owner": { "description": "Email address of the sheet owner.", "type": "string", "example": "owner@example.com" }, "permalink": { "description": "URL that represents a direct link to the sheet in Smartsheet.", "type": "string", "example": "https://app.smartsheet.com/sheets/abc123" }, "projectSettings": { "description": "Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.", "type": "object", "properties": { "lengthOfDay": { "description": "Length of a workday for a project sheet.", "type": "number", "minimum": 1, "maximum": 24, "example": 1 }, "nonWorkingDays": { "description": "Non-working days for a project sheet.", "type": "array", "items": { "type": "string", "format": "date" } }, "workingDays": { "type": "array", "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } } } }, "readOnly": { "description": "Returned only if the sheet belongs to an expired trial (value = **true**).", "type": "boolean", "example": false }, "resourceManagementEnabled": { "description": "Indicates that resource management is enabled.", "type": "boolean", "example": false }, "resourceManagementType": { "description": "Resource Management type. Indicates the type of RM that is enabled.", "type": "string", "enum": [ "NONE", "LEGACY_RESOURCE_MANAGEMENT", "RESOURCE_MANAGEMENT_BY_SMARTSHEET" ], "example": "NONE" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Row Id.", "type": "number" }, "sheetId": { "description": "Parent sheet Id.", "type": "number" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "attachments": { "description": "Attachments on row. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "cells": { "description": "Cells belonging to the row.", "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "The Id of the column that the cell is located in." }, "columnType": { "type": "string", "description": "Only returned if the include query string parameter contains **columnType**." }, "conditionalFormat": { "type": "string", "description": "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": { "type": "string", "description": "Visual representation of cell contents, as presented to the user in the UI." }, "format": { "type": "string", "description": "The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied." }, "formula": { "type": "string", "description": "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\"**." }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "linkInFromCell": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } }, "linksOutToCells": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "overrideValidation": { "type": "boolean", "description": "(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": { "type": "boolean", "description": "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." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "description": "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." } } } }, "columns": { "description": "Columns of row. Only returned if the include query string parameter contains columns.", "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "conditionalFormat": { "description": "Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussions": { "description": "Discussions on the row. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } }, "proofs": { "description": "Proof on row. Only returned if the include query string parameter contains proofs.", "type": "object", "properties": { "id": { "description": "Proof Id of the proof version.", "type": "number" }, "originalId": { "description": "Proof Id of the original proof version.", "type": "number" }, "name": { "description": "Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.", "type": "string" }, "proofType": { "description": "File type for the proof version.", "type": "string", "enum": [ "DOCUMENT", "IMAGE", "MIXED", "NONE", "VIDEO" ] }, "proofRequestUrl": { "description": "URL to review a proofing request.", "type": "string" }, "version": { "description": "The version number of the proof.", "type": "number" }, "lastUpdatedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastUpdatedBy": { "description": "`User` object containing `name` and `email` of the user who last updated the proof.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "isCompleted": { "description": "Indicates whether the proof is completed.", "type": "boolean" }, "attachments": { "description": "Array of Attachment objects. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "discussions": { "description": "Array of Discussion objects. Only returned if the include query string parameter contains discussions.", "type": "array", "items": { "type": "object", "properties": { "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ] }, "id": { "description": "Discussion Id.", "type": "number" }, "comments": { "description": "Array of comments in discussion. Only returned if the include query string parameter contains comments.", "type": "array", "items": { "type": "object", "properties": { "attachments": { "description": "Array of attachments on comments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this comment.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "discussionId": { "description": "Discussion Id of discussion that contains comment.", "type": "number" }, "id": { "description": "Comment Id.", "type": "number" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "text": { "description": "Comment body.", "type": "string" } } } }, "commentAttachments": { "description": "Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.", "type": "array", "items": { "description": "Attachment Object", "type": "object", "properties": { "id": { "description": "Attachment Id.", "type": "number" }, "parentId": { "description": "The Id of the parent.", "type": "number" }, "attachmentType": { "description": "Attachment type. * types are not supported for Smartsheet.gov accounts.", "type": "string", "enum": [ "BOX_COM", "DROPBOX*", "EGNYTE*", "EVERNOTE*", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE" ] }, "attachmentSubType": { "description": "Attachment sub type. * type is for EGNYTE values and the rest are GOOGLE_DRIVE values.", "type": "string", "enum": [ "DOCUMENT", "DRAWING", "FOLDER*", "PDF", "PRESENTATION", "SPREADSHEET" ] }, "mimeType": { "description": "Attachment MIME type.", "type": "string", "example": "PNG" }, "parentType": { "description": "The type of object the attachment belongs to.", "type": "string", "enum": [ "COMMENT", "PROOF", "ROW", "SHEET" ] }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created this attachment.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "name": { "description": "Attachment name.", "type": "string" }, "sizeInKb": { "description": "The size of the file, if the attachmentType is FILE.", "type": "number" }, "url": { "description": "Attachment temporary URL (files only).", "type": "string" }, "urlExpiresInMillis": { "description": "Attachment temporary URL time to live (files only).", "type": "number" } } } }, "commentCount": { "description": "Number of comments in the discussion.", "type": "number" }, "createdBy": { "description": "`User` object containing `name` and `email` of the user who created the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "lastCommentedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "lastCommentedUser": { "description": "`User` object containing `name` and `email` of the user who last commented on the discussion.\n", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "parentId": { "description": "The Id of the associated row or sheet.", "type": "number" }, "parentType": { "description": "Type of parent object.", "type": "string", "enum": [ "ROW", "SHEET" ] }, "readOnly": { "description": "Indicates whether the user can modify the discussion.", "type": "boolean" }, "title": { "description": "Title automatically created by duplicating the first 100 characters of top-level comment.", "type": "string", "readOnly": true } } } } } }, "expanded": { "description": "Indicates whether the row is expanded or collapsed.", "type": "boolean" }, "filteredOut": { "description": "Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.", "type": "boolean" }, "format": { "description": "Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "inCriticalPath": { "description": "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.", "type": "boolean" }, "locked": { "description": "Indicates whether the row is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the row is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the last person to modify this row.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "permaLink": { "description": "URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.", "type": "string" }, "rowNumber": { "description": "Row number within the sheet.", "type": "number", "minimum": 1 }, "version": { "description": "Sheet version number that is incremented every time a sheet is modified.", "type": "number" } } } }, "showParentRowsForFilters": { "description": "Returned only if there are column filters on the sheet. Value = **true** if \"show parent rows\" is enabled for the filters.", "type": "boolean", "example": false }, "source": { "type": "object", "properties": { "id": { "description": "The Id of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.\n", "type": "number", "example": 12345 }, "type": { "description": "**report**, **sheet**, **sight** (aka dashboard), or **template**.\n", "type": "string", "example": "email" } } }, "summary": { "type": "object", "description": "Represents the entire summary, or a list of defined fields and values, for a specific sheet.", "properties": { "fields": { "description": "Array of summary (or metadata) fields defined on the sheet.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "SummaryField Id.", "type": "number" }, "contactOptions": { "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.", "type": "array", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "displayValue": { "description": "Visual representation of cell contents, as presented to the user in the UI.", "type": "string" }, "format": { "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.", "type": "string" }, "formula": { "description": "The formula for a cell, if set.", "type": "string" }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "index": { "description": "Field index or position. This number is zero-based.", "type": "number" }, "locked": { "description": "Indicates whether the field is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the field is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the user who most recently modified this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "options": { "description": "When applicable for PICKLIST column type. Array of the options available for the field.", "type": "array", "items": { "type": "string" } }, "symbol": { "description": "When applicable for PICKLIST column type.", "type": "string" }, "title": { "description": "Arbitrary name, must be unique within summary.", "type": "string" }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] }, "validation": { "description": "Indicates whether summary field values are restricted to the type.", "type": "boolean" } } } } } }, "totalRowCount": { "description": "The total number of rows in the sheet.", "type": "number", "example": 1 }, "userPermissions": { "type": "object", "description": "Describes the current user's editing permissions for a specific sheet.", "properties": { "summaryPermissions": { "description": "One of:\n * ADMIN: full control over fields.\n * READ_DELETE: sheet is owned by an individual account that doesn't\nhave summary capabilities. If a summary exists, the only possible operations are GET and DELETE fields.\n * READ_ONLY.\n * READ_WRITE: can edit values of existing fields, but not create\nor delete fields, nor modify field type.\n", "type": "string", "enum": [ "ADMIN", "READ_DELETE", "READ_ONLY", "READ_WRITE" ], "example": "ADMIN" } } }, "userSettings": { "type": "object", "description": "Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet).", "properties": { "criticalPathEnabled": { "description": "Does this user have \"Show Critical Path\" turned on for this sheet? **NOTE**: This setting only has an effect on project sheets with dependencies enabled.\n", "type": "boolean", "example": false }, "displaySummaryTasks": { "description": "Does this user have \"Display Summary Tasks\" turned on for this sheet? Applies only to sheets where \"Calendar View\" has been configured.", "type": "boolean", "example": false } } }, "version": { "description": "A number that is incremented every time a sheet is modified.", "type": "number", "example": 1 }, "workspace": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number", "example": 12345 }, "name": { "description": "Workspace name.", "type": "string", "example": "Marketing Workspace" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string", "example": "https://app.smartsheet.com/sheets/abc123" } } } } } } }, { "label": "Sights", "value": "sights", "schema": { "type": "array", "items": { "type": "object", "properties": { "backgroundColor": { "description": "The hex color, for instance `#E6F5FE`.", "type": "string", "readOnly": true, "example": "#FFFFFF" }, "defaultWidgetBackgroundColor": { "description": "The hex color of the background color for all widgets except for title widgets on the dashboard, for instance `#E6F5FEF4` or `#E6F5FE`.", "type": "string", "readOnly": true, "example": "#F0F0F0" }, "columnCount": { "description": "Number of columns that the dashboard contains.", "type": "number", "readOnly": true, "example": 1 }, "favorite": { "description": "Indicates whether the user has marked the dashboard as a favorite.", "type": "boolean", "readOnly": true, "example": false }, "source": { "type": "object", "properties": { "id": { "description": "The Id of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.\n", "type": "number", "example": 12345 }, "type": { "description": "**report**, **sheet**, **sight** (aka dashboard), or **template**.\n", "type": "string", "example": "email" } } }, "widgets": { "readOnly": true, "type": "array", "items": { "type": "object", "readOnly": true, "properties": { "id": { "description": "Widget Id.", "type": "number" }, "type": { "description": "Type of widget.", "type": "string", "enum": [ "CHART", "GRIDGANTT", "IMAGE", "METRIC", "RICHTEXT", "SHEETSUMMARY", "SHORTCUT", "SHORTCUTICON", "SHORTCUTLIST", "TITLE", "WEBCONTENT" ] }, "contents": { "description": "The type of widget content depends on the value of widget.type.", "oneOf": [ { "type": "object", "title": "Chart", "properties": { "type": { "type": "string", "enum": [ "CHART" ] }, "reportId": { "description": "Report Id denoting container source, if applicable.", "type": "number" }, "sheetId": { "description": "Sheet Id denoting container source, if applicable.", "type": "number" }, "axes": { "type": "array", "items": { "type": "object", "properties": { "location": { "description": "Describes location of the axis.", "type": "string", "enum": [ "BOTTOM", "LEFT", "NONE", "RIGHT", "TOP" ] }, "title": { "description": "Axis title.", "type": "string" }, "titleInfo": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ABSTRACT_DATE_TIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATE_TIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] } } }, "axisTitleFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] }, "axisLabelFormat": { "description": "Describes the axis format (see [Formatting](/section/Formatting)).", "type": "string", "example": ",,,,,,,,36,,,,,,,," }, "axisLabelFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] }, "includeZero": { "description": "Includes 0 in the axis.", "type": "boolean" } } } }, "hyperlink": { "type": "object", "properties": { "interactionType": { "description": "Specifies what happens when a user clicks the widget. The type will determine what other properties are needed.\n * DISTI_COPY - a distribution link, only available if org has distribution\nlinks enabled.\n * NONE - do nothing, no other attribute required.\n * SMARTSHEET_ITEM - open a Smartsheet item that is not the SOURCE_SHEET,\nmust also have one of the following attributes:\n * dashboardId\n * folderId\n * reportId\n * sheetId\n * workspaceId\n * SOURCE_SHEET - open the container where the widget data comes from,\nno other attribute required.\n * WEB - launch the URL, must also have url attribute.\n", "type": "string", "enum": [ "DISTI_COPY", "NONE", "SMARTSHEET_ITEM", "SOURCE_SHEET", "WEB" ] }, "folderId": { "description": "If interactionType = SMARTSHEET_ITEM this is the folder to open.", "type": "number" }, "reportId": { "description": "If interactionType = SMARTSHEET_ITEM this is the report to open.", "type": "number" }, "sheetId": { "description": "If interactionType = SMARTSHEET_ITEM this is the sheet to open.", "type": "number" }, "sightId": { "description": "If interactionType = SMARTSHEET_ITEM this is the dashboard to open.", "type": "number" }, "url": { "description": "If interactionType = WEB this is the URL to launch.", "type": "string" }, "workspaceId": { "description": "If interactionType = SMARTSHEET_ITEM this is the workspace to open.", "type": "number" } } }, "includedColumnIds": { "description": "Array of column Ids if the range was selected through the UI.", "type": "array", "items": { "type": "number" } }, "legend": { "type": "object", "properties": { "location": { "type": "string", "enum": [ "BOTTOM", "LEFT", "NONE", "RIGHT", "TOP" ] }, "legendFormat": { "type": "string", "description": "The format descriptor (see [Formatting](/section/Formatting)). Only returned if the legend has a non-default format applied to it.", "example": ",,1,1,,,,,,,,,,,,," }, "legendFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] } } }, "selectionRanges": { "type": "array", "items": { "description": "Defines a block of cells in a sheet.", "type": "object", "properties": { "sourceColumnId1": { "description": "Defines beginning edge of range when specifying one or more columns.", "type": "number" }, "sourceColumnId2": { "description": "Defines ending edge of range when specifying one or more columns.", "type": "number" }, "sourceRowId1": { "description": "Defines beginning edge of range when specifying one or more rows.", "type": "number" }, "sourceRowId2": { "description": "Defines ending edge of range when specifying one or more rows.", "type": "number" } } } }, "series": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "titleInfo": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ABSTRACT_DATE_TIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATE_TIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] } } }, "seriesTitleFormat": { "type": "string", "description": "Series title format (see [Formatting](/section/Formatting))." }, "seriesType": { "type": "string", "enum": [ "AREA", "BAR", "COLUMN", "LINE", "PIE", "SCATTER" ] }, "dataLabels": { "type": "object", "properties": { "labelType": { "type": "string", "enum": [ "NONE", "PERCENT", "VALUE" ] } } }, "tooltips": { "type": "object", "properties": { "labelType": { "type": "string", "enum": [ "NONE", "PERCENT", "X_SERIES_Y", "X_Y_PERCENT", "Y", "Y_PERCENT" ] } } }, "lineType": { "type": "string", "enum": [ "CURVED", "STEPPED", "STRAIGHT" ] }, "holeSize": { "type": "number" }, "isFilled": { "type": "boolean" }, "isHalf": { "type": "boolean" }, "isStacked": { "type": "boolean" }, "xFormat": { "type": "string", "description": "The format descriptor (see [Formatting](/section/Formatting)). Only returned if the series has a non-default format applied to it.", "example": ",,1,1,,,,,,,,,,,,," }, "yFormat": { "type": "string", "description": "The format descriptor (see [Formatting](/section/Formatting)). Only returned if the series has a non-default format applied to it.", "example": ",,1,1,,,,,,,,,,,,," }, "color": { "type": "string" }, "axisLocationX": { "type": "string", "enum": [ "BOTTOM", "LEFT", "NONE", "RIGHT", "TOP" ] }, "axisLocationY": { "type": "string", "enum": [ "BOTTOM", "LEFT", "NONE", "RIGHT", "TOP" ] }, "yColumnInfo": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ABSTRACT_DATE_TIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATE_TIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] } } }, "xColumnInfo": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ABSTRACT_DATE_TIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATE_TIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] } } }, "seriesSelectionOrder": { "type": "string", "enum": [ "COLUMNS", "ROWS" ] }, "seriesData": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "xFormat": { "type": "string", "description": "The format descriptor (see [Formatting](/section/Formatting)). Only returned if the series has a non-default format applied to it.", "example": ",,1,1,,,,,,,,,,,,," }, "yFormat": { "type": "string", "description": "The format descriptor (see [Formatting](/section/Formatting)). Only returned if the series has a non-default format applied to it.", "example": ",,1,1,,,,,,,,,,,,," }, "color": { "type": "string" } } } }, "selectionRanges": { "type": "array", "items": { "description": "Defines a block of cells in a sheet.", "type": "object", "properties": { "sourceColumnId1": { "description": "Defines beginning edge of range when specifying one or more columns.", "type": "number" }, "sourceColumnId2": { "description": "Defines ending edge of range when specifying one or more columns.", "type": "number" }, "sourceRowId1": { "description": "Defines beginning edge of range when specifying one or more rows.", "type": "number" }, "sourceRowId2": { "description": "Defines ending edge of range when specifying one or more rows.", "type": "number" } } } } } } }, "verticalGridLines": { "type": "object", "properties": { "lineStyle": { "type": "string", "enum": [ "SOLID" ] } } }, "horizontalGridLines": { "type": "object", "properties": { "lineStyle": { "type": "string", "enum": [ "SOLID" ] } } } } }, { "type": "object", "title": "Metric", "properties": { "type": { "type": "string", "enum": [ "METRIC", "SHEETSUMMARY" ] }, "sheetId": { "description": "Sheet Id from which the cell data originates.", "type": "number" }, "cellData": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "description": "Column Id for each item.", "type": "number" }, "rowId": { "description": "Row Id for each item.", "type": "number" }, "sheetId": { "description": "Sheet Id for each item.", "type": "number" }, "objectValue": { "description": "The type of data returned depends on the cell type and the data in the cell.", "oneOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" } ] }, "cell": { "type": "object", "properties": { "columnId": { "type": "number", "description": "The Id of the column that the cell is located in." }, "columnType": { "type": "string", "description": "Only returned if the include query string parameter contains **columnType**." }, "conditionalFormat": { "type": "string", "description": "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": { "type": "string", "description": "Visual representation of cell contents, as presented to the user in the UI." }, "format": { "type": "string", "description": "The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied." }, "formula": { "type": "string", "description": "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\"**." }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "linkInFromCell": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } }, "linksOutToCells": { "type": "array", "items": { "type": "object", "properties": { "columnId": { "type": "number", "description": "Column Id of the linked cell." }, "rowId": { "type": "number", "description": "Row Id of the linked cell." }, "sheetId": { "type": "number", "description": "Sheet Id of the sheet that the linked cell belongs to." }, "sheetName": { "type": "string", "description": "Sheet name of the linked cell." }, "status": { "type": "string", "enum": [ "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK" ], "description": "* `BLOCKED` One of several other values indicating unusual error conditions.\n* `BROKEN` The row or sheet linked to was deleted.\n* `CIRCULAR` One of several other values indicating unusual error conditions.\n* `DISABLED` One of several other values indicating unusual error conditions.\n* `INACCESSIBLE` The sheet linked to cannot be viewed by this user.\n* `INVALID` One of several other values indicating unusual error conditions.\n* `NOT_SHARED` One of several other values indicating unusual error conditions.\n* `OK` The link is in a good state.\n" } } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "overrideValidation": { "type": "boolean", "description": "(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": { "type": "boolean", "description": "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." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "description": "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." } } }, "dataSource": { "type": "string", "enum": [ "CELL", "SUMMARY_FIELD" ] }, "inheritCellValue": { "description": "Specifies if valueFormat is inherited from the underlying cell value", "type": "boolean" }, "label": { "description": "Label for the data point. This is either the column name or a user-provided string.", "type": "string" }, "labelFormat": { "description": "Format description for label.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "labelFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] }, "order": { "description": "The display order for the CellDataItem.", "type": "number" }, "profileField": { "type": "object", "properties": { "id": { "description": "SummaryField Id.", "type": "number" }, "contactOptions": { "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.", "type": "array", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "createdBy": { "description": "User object containing name and email of the creator of this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "displayValue": { "description": "Visual representation of cell contents, as presented to the user in the UI.", "type": "string" }, "format": { "description": "The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.", "type": "string" }, "formula": { "description": "The formula for a cell, if set.", "type": "string" }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "image": { "type": "object", "properties": { "altText": { "type": "string", "description": "Alternate text for the image." }, "height": { "type": "number", "description": "Original height (in pixels) of the uploaded image." }, "id": { "type": "string", "description": "Image Id." }, "width": { "type": "number", "description": "Original width (in pixels) of the uploaded image." } } }, "index": { "description": "Field index or position. This number is zero-based.", "type": "number" }, "locked": { "description": "Indicates whether the field is locked.", "type": "boolean" }, "lockedForUser": { "description": "Indicates whether the field is locked for the requesting user.", "type": "boolean" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "modifiedBy": { "description": "User object containing name and email of the user who most recently modified this summary field.", "type": "object", "properties": { "email": { "type": "string", "format": "email", "example": "jane.doe@smartsheet.com" }, "name": { "type": "string", "readOnly": true, "example": "Jane Doe" } } }, "objectValue": { "description": "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.", "type": "object", "properties": { "objectType": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CONTACT", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT", "MULTI_PICKLIST", "PREDECESSOR_LIST" ] } } }, "options": { "description": "When applicable for PICKLIST column type. Array of the options available for the field.", "type": "array", "items": { "type": "string" } }, "symbol": { "description": "When applicable for PICKLIST column type.", "type": "string" }, "title": { "description": "Arbitrary name, must be unique within summary.", "type": "string" }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ] }, "validation": { "description": "Indicates whether summary field values are restricted to the type.", "type": "boolean" } } }, "valueFormat": { "description": "Format description for value.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "valueFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] } } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "autoNumberFormat": { "type": "object", "description": "Object that describes how the the System Column type of \"AUTO_NUMBER\" is auto-generated.", "properties": { "fill": { "description": "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.", "type": "string" }, "prefix": { "description": "The prefix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" }, "startingNumber": { "description": "The starting number for the auto-id.", "type": "number" }, "suffix": { "description": "The suffix. Can include the date tokens:\n * {DD}\n * {MM}\n * {YY}\n * {YYYY}\n", "type": "string" } } }, "contactOptions": { "type": "array", "description": "Array of ContactOption objects to specify a pre-defined list of values for the column. Column **type** must be **CONTACT_LIST**.", "items": { "type": "object", "properties": { "email": { "description": "A parsable email address.", "type": "string" }, "name": { "description": "Can be a user's name, display name, or free text.", "type": "string" } } } }, "description": { "type": "string", "description": "Column description." }, "format": { "type": "string", "description": "The format descriptor (see [Formatting](../../#section/API-Basics/Formatting)). Only returned if the **include** query string parameter contains **format** and this column has a non-default format applied to it." }, "formula": { "description": "The formula for the column, if set.", "type": "string" }, "hidden": { "type": "boolean", "description": "Indicates whether the column is hidden." }, "id": { "type": "number", "description": "Column Id." }, "index": { "type": "number", "description": "Column index or position. This number is zero-based." }, "locked": { "type": "boolean", "description": "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." }, "lockedForUser": { "type": "boolean", "description": "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": { "type": "array", "description": "Array of the options available for the column.", "items": { "type": "string" } }, "primary": { "type": "boolean", "description": "Returned only if the column is the Primary Column (value = **true**)." }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns)." }, "systemColumnType": { "type": "string", "enum": [ "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE" ], "description": "See [System Columns](../../tag/columnsRelated#section/Column-Types)." }, "tags": { "type": "array", "description": "Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.", "items": { "type": "string", "enum": [ "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE" ] } }, "title": { "type": "string", "description": "Column title." }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**)." }, "version": { "type": "number", "enum": [ 0, 1, 2 ], "description": "* `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.\n* `1`: MULTI_CONTACT_LIST.\n* `2`: MULTI_PICKLIST.\n" }, "width": { "type": "number", "description": "Display width of the column in pixels." } } } }, "hyperlink": { "type": "object", "properties": { "interactionType": { "description": "Specifies what happens when a user clicks the widget. The type will determine what other properties are needed.\n * DISTI_COPY - a distribution link, only available if org has distribution\nlinks enabled.\n * NONE - do nothing, no other attribute required.\n * SMARTSHEET_ITEM - open a Smartsheet item that is not the SOURCE_SHEET,\nmust also have one of the following attributes:\n * dashboardId\n * folderId\n * reportId\n * sheetId\n * workspaceId\n * SOURCE_SHEET - open the container where the widget data comes from,\nno other attribute required.\n * WEB - launch the URL, must also have url attribute.\n", "type": "string", "enum": [ "DISTI_COPY", "NONE", "SMARTSHEET_ITEM", "SOURCE_SHEET", "WEB" ] }, "folderId": { "description": "If interactionType = SMARTSHEET_ITEM this is the folder to open.", "type": "number" }, "reportId": { "description": "If interactionType = SMARTSHEET_ITEM this is the report to open.", "type": "number" }, "sheetId": { "description": "If interactionType = SMARTSHEET_ITEM this is the sheet to open.", "type": "number" }, "sightId": { "description": "If interactionType = SMARTSHEET_ITEM this is the dashboard to open.", "type": "number" }, "url": { "description": "If interactionType = WEB this is the URL to launch.", "type": "string" }, "workspaceId": { "description": "If interactionType = SMARTSHEET_ITEM this is the workspace to open.", "type": "number" } } } } }, { "type": "object", "title": "Image", "properties": { "type": { "type": "string", "enum": [ "IMAGE" ] }, "privateId": { "description": "The image private Id.", "type": "string" }, "fileName": { "description": "Name of the image file.", "type": "string" }, "fit": { "description": "Describes how the image occupies the available space of its widget.\n * ACTUAL_SIZE - Uses the original image width and height dimensions.\n * FILL - Scales the image to maintain its aspect ratio while filling\nits entire widget. If the image aspect ratio does not match the aspect ratio of its widget, then the image will be clipped to fit.\n * FIT - Scales the image to maintain its aspect ratio while fitting\nwithin its widget. The image will be \"letterboxed\" if its aspect ratio does not match the aspect ratio of its widget. Default value for new image widgets and for existing image widgets where this property has not been explicitly set.\n", "enum": [ "ACTUAL_SIZE", "FILL", "FIT" ], "type": "string" }, "format": { "description": "Format descriptor. Follows the pattern in FormatTables.", "type": "string", "example": ",7,1,,,,2,2,1,3,,,,,,1," }, "height": { "type": "number" }, "hyperlink": { "type": "object", "properties": { "interactionType": { "description": "Specifies what happens when a user clicks the widget. The type will determine what other properties are needed.\n * DISTI_COPY - a distribution link, only available if org has distribution\nlinks enabled.\n * NONE - do nothing, no other attribute required.\n * SMARTSHEET_ITEM - open a Smartsheet item that is not the SOURCE_SHEET,\nmust also have one of the following attributes:\n * dashboardId\n * folderId\n * reportId\n * sheetId\n * workspaceId\n * SOURCE_SHEET - open the container where the widget data comes from,\nno other attribute required.\n * WEB - launch the URL, must also have url attribute.\n", "type": "string", "enum": [ "DISTI_COPY", "NONE", "SMARTSHEET_ITEM", "SOURCE_SHEET", "WEB" ] }, "folderId": { "description": "If interactionType = SMARTSHEET_ITEM this is the folder to open.", "type": "number" }, "reportId": { "description": "If interactionType = SMARTSHEET_ITEM this is the report to open.", "type": "number" }, "sheetId": { "description": "If interactionType = SMARTSHEET_ITEM this is the sheet to open.", "type": "number" }, "sightId": { "description": "If interactionType = SMARTSHEET_ITEM this is the dashboard to open.", "type": "number" }, "url": { "description": "If interactionType = WEB this is the URL to launch.", "type": "string" }, "workspaceId": { "description": "If interactionType = SMARTSHEET_ITEM this is the workspace to open.", "type": "number" } } }, "margin": { "description": "Indicates whether there is margin between the image and its widget borders.\n * MARGIN - Default value for existing image widgets where this\nproperty has not been explicitly set.\n * NO_MARGIN - Default value for new image widgets.\n", "enum": [ "MARGIN", "NO_MARGIN" ], "type": "string" }, "width": { "description": "Original width of the image in pixels.", "type": "number" } } }, { "type": "object", "title": "Report", "properties": { "type": { "type": "string", "enum": [ "GRIDGANTT" ] }, "reportId": { "description": "Report Id denoting container source.", "type": "number" }, "htmlContent": { "description": "HTMl snippet to render report.", "type": "string" }, "backgroundColor": { "description": "The hex color.", "example": "#E6F5FE", "type": "string" }, "hyperlink": { "type": "object", "properties": { "interactionType": { "description": "Specifies what happens when a user clicks the widget. The type will determine what other properties are needed.\n * DISTI_COPY - a distribution link, only available if org has distribution\nlinks enabled.\n * NONE - do nothing, no other attribute required.\n * SMARTSHEET_ITEM - open a Smartsheet item that is not the SOURCE_SHEET,\nmust also have one of the following attributes:\n * dashboardId\n * folderId\n * reportId\n * sheetId\n * workspaceId\n * SOURCE_SHEET - open the container where the widget data comes from,\nno other attribute required.\n * WEB - launch the URL, must also have url attribute.\n", "type": "string", "enum": [ "DISTI_COPY", "NONE", "SMARTSHEET_ITEM", "SOURCE_SHEET", "WEB" ] }, "folderId": { "description": "If interactionType = SMARTSHEET_ITEM this is the folder to open.", "type": "number" }, "reportId": { "description": "If interactionType = SMARTSHEET_ITEM this is the report to open.", "type": "number" }, "sheetId": { "description": "If interactionType = SMARTSHEET_ITEM this is the sheet to open.", "type": "number" }, "sightId": { "description": "If interactionType = SMARTSHEET_ITEM this is the dashboard to open.", "type": "number" }, "url": { "description": "If interactionType = WEB this is the URL to launch.", "type": "string" }, "workspaceId": { "description": "If interactionType = SMARTSHEET_ITEM this is the workspace to open.", "type": "number" } } } } }, { "type": "object", "title": "Rich Text", "properties": { "type": { "type": "string", "enum": [ "RICHTEXT" ] }, "htmlContent": { "description": "The widget contents as HTML. The Rich Text widget supports the following subset of HTML tags and CSS Styles:\n\nHTML\n * a - hyperlink\n * br - line break\n * li - list item\n * ol - ordered list\n * p - paragraph\n * span - section of the document\n * ul - unordered list\n\nCSS\n * color\n * font-family\n * font-size\n * font-style\n * font-weight\n * text-align\n * text-decoration\n", "type": "string" } } }, { "type": "object", "title": "Shortcut", "properties": { "type": { "type": "string", "enum": [ "SHORTCUT", "SHORTCUTICON", "SHORTCUTLIST" ] }, "shortcutData": { "type": "array", "items": { "type": "object", "properties": { "attachmentType": { "type": "string", "enum": [ "BOX_COM", "DROPBOX", "EGNYTE", "EVERNOTE", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE", "SMARTSHEET" ] }, "hyperlink": { "type": "object", "properties": { "reportId": { "type": "number", "description": "If non-null, this hyperlink is a link to the report with this Id." }, "sheetId": { "type": "number", "description": "If non-null, this hyperlink is a link to the sheet with this Id." }, "sightId": { "type": "number", "description": "If non-null, this hyperlink is a link to the dashboard with this Id." }, "url": { "type": "string", "description": "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet." } } }, "label": { "description": "Label for the data point.", "type": "string" }, "labelFormat": { "description": "Format description of label.", "type": "string", "example": ",,1,1,,,,,,,,,,,,," }, "labelFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] }, "mimeType": { "type": "string" }, "order": { "description": "The display order for the ShortcutWidgetItem object.", "type": "number" } } } } } }, { "type": "object", "title": "Title", "properties": { "type": { "type": "string", "enum": [ "TITLE" ] }, "backgroundColor": { "type": "string" }, "htmlContent": { "type": "string", "description": "The widget contents as HTML. The Title widget supports the following subset of HTML tags and CSS Styles:\n\nHTML\n * br - line break\n * p - paragraph\n * span - section of the document\n\nCSS\n * color\n * font-family\n * font-size\n * font-style\n * font-weight\n * text-align\n * text-decoration\n", "example": "<p style=\"text-align:center\"><span class=\"clsDbFt\">HI!</span></p>" } } }, { "type": "object", "title": "Web Content", "properties": { "type": { "type": "string", "enum": [ "WEBCONTENT" ] }, "url": { "description": "The URL for the web content.", "type": "string", "example": "https://www.youtube.com/embed/quGpnXiCUms" } } } ] }, "height": { "description": "Number of rows that the widget occupies on the dashboard.", "type": "number" }, "showTitle": { "description": "True indicates that the client should display the widget title. This is independent of the title string which may be null or empty.", "type": "boolean" }, "showTitleIcon": { "description": "True indicates that the client should display the sheet icon in the widget title.", "type": "boolean" }, "title": { "description": "Title of the widget.", "type": "string" }, "titleFormat": { "description": "Title format descriptor (see [Formatting](../#section/API-Basics/Formatting)).", "type": "string", "example": ",,1,,,,,,,3,,,,,,1," }, "titleFont": { "description": "List of supported fonts in Dashboards", "type": "string", "enum": [ "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana" ] }, "version": { "description": "Widget version number.", "type": "number" }, "viewMode": { "description": "Indicates the content layout. Must use a query parameter of level=2 to see this information.\n * 1 - centered\n * 2 - left aligned\n", "type": "number", "enum": [ 1, 2 ] }, "width": { "description": "Number of columns that the widget occupies on the dashboard.", "type": "number" }, "xPosition": { "description": "X-coordinate of widget's position on the dashboard.", "type": "number" }, "yPosition": { "description": "Y-coordinate of widget's position on the dashboard.", "type": "number" } } } }, "workspace": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number", "example": 12345 }, "name": { "description": "Workspace name.", "type": "string", "example": "Marketing Workspace" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string", "example": "https://app.smartsheet.com/sheets/abc123" } } }, "createdAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "modifiedAt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true, "example": "2024-01-15T10:30:00Z" }, "id": { "description": "Dashboard Id.", "type": "number", "readOnly": true, "example": 12345 }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "permalink": { "description": "URL that represents a direct link to the dashboard in Smartsheet.", "type": "string", "readOnly": true, "example": "https://app.smartsheet.com/sheets/abc123" }, "name": { "description": "Dashboard name.", "type": "string", "example": "John Doe" } } } } }, { "label": "Templates", "value": "templates", "schema": { "type": "array", "items": { "description": "A template can be used to create a sheet.", "type": "object", "properties": { "id": { "description": "Template Id.", "type": "number", "example": 12345 }, "type": { "description": "Type of template. Only applicable to public templates.", "type": "string", "enum": [ "report", "sheet" ], "example": "report" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "blank": { "description": "Indicates whether the template is blank. Only applicable to public templates.", "type": "boolean", "example": false }, "categories": { "description": "Indicates whether the template is blank. Only applicable to public templates.", "type": "array", "items": { "type": "string" } }, "description": { "description": "Template description.", "type": "string", "example": "A helpful column description" }, "globalTemplate": { "description": "Type of global template. Only applicable to blank public templates.", "type": "string", "enum": [ "BLANK_SHEET", "PROJECT_SHEET", "TASK_LIST" ], "example": "PROJECT_SHEET" }, "image": { "description": "URL to the small preview image for this template. Only applicable to non-blank public templates.", "type": "string", "example": "https://example.com/image.png" }, "largeImage": { "description": "URL to the large preview image for this template. Only applicable to non-blank public templates.", "type": "string", "example": "https://app.smartsheet.com/templateimages/large/project.png" }, "locale": { "description": "Locale of the template. Only applicable to public templates.", "type": "string", "enum": [ "ar_AE", "ar_BH", "ar_DZ", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SD", "ar_SY", "ar_TN", "ar_YE", "be_BY", "bg_BG", "ca_ES", "cs_CZ", "da_DK", "de_AT", "de_CH", "de_DE", "de_LU", "el_CY", "el_GR", "en_AU", "en_CA", "en_GB", "en_IE", "en_IN", "en_MT", "en_NZ", "en_PH", "en_SG", "en_US", "en_ZA", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_ES", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PE", "es_PR", "es_PY", "es_SV", "es_US", "es_UY", "es_VE", "et_EE", "fi_FI", "fr_BE", "fr_CA", "fr_CH", "fr_FR", "fr_LU", "ga_IE", "hi_US", "hr_HR", "hu_HU", "in_ID", "is_IS", "it_CH", "it_IT", "iw_IL", "ja_JP", "ko_KR", "lt_LT", "lv_LV", "mk_MK", "ms_MY", "mt_MT", "nl_BE", "nl_NL", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ro_RO", "ru_RU", "sk_SK", "sl_SI", "sq_AL", "sr_BA", "sr_CS", "sv_SE", "th_US", "tr_TR", "uk_UA", "vi_VN", "zh_CN", "zh_HK", "zh_SG", "zh_TW" ], "example": "en_US" }, "name": { "type": "string", "description": "Type of global template.", "example": "Awesome Project Template" }, "tags": { "description": "List of search tags for this template. Only applicable to non-blank public templates.", "type": "array", "items": { "type": "string" } } } } } }, { "label": "Workspaces", "value": "workspaces", "schema": { "type": "array", "items": { "description": "Can contain dashboards, folders, reports, sheets, and templates.", "type": "object", "properties": { "id": { "description": "Workspace Id.", "type": "number", "example": 12345 }, "name": { "description": "Workspace name.", "type": "string", "example": "Marketing Workspace" }, "accessLevel": { "type": "string", "enum": [ "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER" ], "example": "OWNER" }, "permalink": { "description": "URL that represents a direct link to the workspace in Smartsheet.", "type": "string", "example": "https://app.smartsheet.com/sheets/abc123" } } } } } ] } ], "auth": { "service": "appmixer:smartsheet" }, "icon": "data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDEyMzggMTUxNCIgd2lkdGg9IjEyMzgiIGhlaWdodD0iMTUxNCI+Cgk8dGl0bGU+c21hcnRzaGVldC1sb2dvLWJsdWUtbmV3LXN2ZzwvdGl0bGU+Cgk8c3R5bGU+CgkJLnMwIHsgZmlsbDogIzBlMjk0NyB9IAoJPC9zdHlsZT4KCTxnIGlkPSJMYXllciI+CgkJPGcgaWQ9IkxheWVyIj4KCQkJPHBhdGggaWQ9IkxheWVyIiBjbGFzcz0iczAiIGQ9Im02MTUgMTIwNGMwIDAgMjYzLjQtNjU3LjggNjIyLjktMTA5Ni4zIDAgMTgwLjkgMCA1MzkuOSAwIDgxMS4zIDAgMTUwLjctNS41IDI3NC0xMSAzMjguOC01LjUgNTQuOS0xOS4yIDkwLjUtNDEuMSA5Ni0xNi41IDIuNy00My45LTIuOC05Ni4xLTYzLjEtNDYuNi01NC44LTkzLjMtMTU2LjItOTMuMy0xNTYuMmwtNS41LTExLTguMiA4LjNjLTIuNyAwLTE0NS40IDE0Mi41LTUxNS45IDI3NC0yMDguNSA3NC00MTEuNSAxMDkuNy00NjYuNCAxMTcuOSA1LjUtMjEuOSAxNi40LTc2LjggMTYuNC0xNTAuOCAwLTk1LjkgMC0xMjQ2LjkgMC0xMzYyLjFoMTIxNS42Yy0xOTcuNiAxODYuNC00NDEuOCA0NjYtNTg5LjkgNzk0LjgtMTYuNS0zNS42LTEyMy41LTI3NC0yNTgtMjcxLjMtODUgMi44LTE1MC45IDkzLjItMTUwLjkgOTMuMiAyMDguNi0yLjcgMzgxLjQgNTg2LjUgMzgxLjQgNTg2LjV6Ii8+CgkJPC9nPgoJPC9nPgo8L3N2Zz4=" }