Namespace Smartsheet.Api.Models

Classes

AbstractRow<TColumn, TCell>: Represents the Row object.

AbstractSheet<TRow, TColumn, TCell>: Represents the Sheet object.

Account: Represents the Account object.

AlternateEmail: The AlternateEmail object.

AlternateEmail.AlternateEmailBuilder: A convenience class to help generate AlternateEmail object with the appropriate fields.

Attachment: Represents the Attachment object.

Attachment.CreateAttachmentBuilder: A convenience class for quickly creating an Attachment to a URL.

AutoNumberFormat: Represents the AutoNumberFormat object. It describes how the the System Column Type of "AUTO_NUMBER" is auto-generated

AutomationAction: Class to encapsulate an automation action

AutomationRule: Class encapsulating one automation rule

BooleanObjectValue: Object value for the boolean primitive value.

BulkItemFailure: Represents the BulkItemFailure object.

BulkItemResult<T>: Represents the BulkItemResult object.

BulkItemRowResult: Represents the BulkItemRowResult object.

Cell: Represents the Cell object that holds data in a sheet.

Cell.AddCellBuilder: A convenience class for adding a cell with the necessary fields for inserting into a list of cells.

Cell.UpdateCellBuilder: A convenience class for updating a cell with the necessary fields for inserting into a list of cells.

CellDataItem: Represents the widget object.

CellHistory: Represents CellHistory object.

CellLink

Represents a link to a cell in a different sheet. If status is not “OK” (i.e., there is a problem with the link), any or all of the following attributes may be null: sheetId, rowId, columnId

You can create and modify cell links by using any API operation that creates or updates cell data. Creating or updating cell links via the cell.linkInFromCell attribute is a special operation. A given row or cell update operation may contain only link updates, or no link updates. Attempting to mix row/cell updates with cell link updates will result in error code 1115.

When creating a cell link, cell.value must be null (the data will be pulled from the linked cell).

A cell may not contain both a hyperlink and a cell link, so hyperlink and linkInFromCell may never both be non-null at the same time.

A cell link can only be added to an existing cell, so the cell.linkInFromCell attribute is not allowed when POSTing a new row to a sheet.

CellLinkWidgetContent: Represents the CellLinkWidgetContent object.

ChartWidgetContent: Represents the ChartWidgetContent object.

Column: Represents the Column object.

Column.AddColumnBuilder: A convenience class to help create a column object with the appropriate fields for adding to a sheet.

Column.CreateSheetColumnBuilder: A convenience class to help create a column object with the appropriate fields for adding to a sheet being created.

Column.UpdateColumnBuilder: The convenience class UpdateColumnBuilder to build a Column object to be updated, moved, and/or renamed. The column's index and title properties must be set.

Comment: Represents the Comment object.

Comment.AddCommentBuilder: A convenience class to generate a Comment with the appropriate fields for adding it to a sheet.

Contact: Represents a user’s personal in Smartsheet Managing contacts

ContactObjectValue: Class for implmentation of a contact object value

ContainerDestination: Object that describes the destination container when a Sheet or Folder is moved, or when a Sheet, Folder, or Workspace is copied.

CopyOrMoveRowDestination: Information on the destination of the rows that were copied or moved.

CopyOrMoveRowDirective: A CopyOrMoveRowDirective object that holds information on the direction of the rows being copied or moved to.

CopyOrMoveRowResult: Result of rows moved or copies.

Criteria: Represents the Criteria object.

CrossSheetReference: Class encapsulating a cross sheet reference

Currency: The Currency info

DateObjectValue: Class encapsulating the date object value.

Discussion: Represents the Discussion object.

Discussion.CreateDiscussionBuilder: A convenience class to help generate discussion object with the appropriate fields for adding a discussion to a sheet or row.

Duration: Class encapsulating a duration object value.

Email: Represents an Email object.

Error: Represents Error object.

Event: Class encapsulating an event.

EventResult: Class encapsulating the result of an event.

ExplicitNull: Object value for the explicit null value.

Favorite: Represents a Favorite object.

Favorite.AddFavoriteBuilder: A convenience class for making a Favorite object with the appropriate fields for adding the user.

FeatureInfo: Information on server information.

Folder: Represents a folder.

Folder.CreateFolderBuilder: A convenience class for setting up a folder with the appropriate fields for creation.

Folder.UpdateFolderBuilder: A convenience class for setting up a folder with the appropriate fields for updating the folder.

FontFamily: FontFamily object.

FormatDetails: Represents the Format details when generating a digital copy (PDF/EXCEL) of a sheet.

FormatTables: The FormatTables object is retrieved via the GET /serverinfo operation and contains all of the lookup tables that the Format Descriptor indexes refer to, as well as a property called defaults, which is a Format Descriptor that describes which formats the Smartsheet web application displays for unset formats.

Group: Represents the Group object.

Group.CreateGroupBuilder: A convenience class for making a Group object with the appropriate fields for creating the group.

Group.UpdateGroupBuilder: A convenience class for making a Group object with the appropriate fields for updating the group.

GroupMember: Represents the GroupMember object.

GroupMember.AddGroupMemberBuilder: A convenience class for creating a GroupMember object with the appropriate fields to add to a group.

Hyperlink

Represents a hyperlink to a URL, a sheet, or a report. If the sheet or report that is linked to was deleted, this object may be empty (i.e., all values null).

You can create and modify hyperlinks by using any API operation that creates or updates cell data. When creating or updating a hyperlink, cell.value may be set to a string value or null. If null, the cell’s value will be derived from the hyperlink:

If the hyperlink is a URL link, the cell’s value will be set to the URL itself.
If the hyperlink is a sheet or report link, the cell’s value will be set to the sheet or report’s name.

IdentifiableModel: Represents an object with an ID.

Image: Represents the Image object.

ImageUrl: Represents the ImageUrl object.

ImageUrl.ImageUrlBuilder: A convenience class to help generate ImageUrl object with the appropriate fields.

ImageUrlMap: Represents the ImageUrl object.

ImageWidgetContent: Represents the ImageWidgetContent object.

MultiContactObjectValue: Class to encapulate the multi contact object.

MultiPicklistObjectValue: Class to encapulate the multi pick list object.

MultiRowEmail: Represents MultiRowEmail object.

MultiShare: Represents the MultiShare object.

MultiShare.ShareToManyBuilder: A convenience class for creating a MultiShare object with the necessary fields for sharing a sheet with many Users.

NamedModel: Represents an object with a Name and an Id.

NumberObjectValue: Implmentation of the number object value type

PaginatedResult<T>: Object returned for all GET operations against index endpoints.
This object provides metadata which can be used to perform paging on potentially large data sets.

PaginationParameters: Builds optional query string parameters for pagination.

PersonalFolder: Represents the Personal folder object.

Predecessor: Object to handle if rows that have dependencies on a predecessor

PredecessorList: Wrapper to encapsulate a list of Predecessors.

ProfileImage: Represents the Image object.

ProjectSettings: Represents the Sight Publish object (see http://smartsheet-platform.github.io/api-docs/?shell#sightpublish-object

Recipient: Specifies the recipient of an Email.
The recipient may be either an individual or a group.
To specify an individual, set the email attribute; to specify a group, set the groupId attribute.
Either email and groupId may be set, but not both.

Report: Represents the Report object.

ReportCell: The Cell object of a Report.

ReportColumn: A report column is a "virtual" column, in that it appears identical to source sheet column(s), but is in fact a different column belonging to the report.
Cells in the report refer to this column via their virtualColumnId attribute, and their actual column from their source sheet via their columnId attribute.

ReportPublish: Represents the Report Publish object (see http://smartsheet-platform.github.io/api-docs/?shell#reportpublish-object

ReportRow: The Row of a Report.

ReportWidgetContent: Represents the ReportWidgetContent object.

RequestResult<T>: RequestResult object to contain information about a PUT or POST request.

Row: A Row is a component of a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and/or Attachments.

Row.AddRowBuilder: A convenience class for creating a Row with the necessary fields for inserting into a list of Rows.

Row.UpdateRowBuilder: A convenience class for updating a Row with the necessary fields for inserting into a list of Rows.

RowEmail: Represents RowEmail object.

RowMapping: Information between the source and destination sheet of rows that were copied or moved.

RowWrapper: Represents the RowWrapper object that is used to specify the location for a Row or set of Rows.

RowWrapper.InsertRowsBuilder: A convenience class for creating a RowWrapper with the necessary fields for inserting a Row or set of Rows.

RowWrapper.MoveRowBuilder: A convenience class for creating a RowWrapper with the necessary fields for moving a Row or set of Rows.

Schedule: Represents the Schedule object.

Scope: Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (e.g. viewer permissions or a read-only sheet).

SearchResult: Represents the Results of a search.

SearchResultItem: Represents one specific RequestResult of a search.

SelectionRange: Represents the SelectionRange object.

SentUpdateRequest: Represents the SentUpdateRequest object.///

ServerInfo: Represents a Server Infromation Object.

Share: Represents a Share Object.

Share.CreateShareBuilder: A convenience class for creating a Share with the necessary fields for sharing the sheet to one user.

Share.UpdateShareBuilder: A convenience class for creating a Share with the necessary fields to update a specific share.

Sheet: Implementation of a sheet.

Sheet.CreateSheetBuilder: A convenience class to make a Sheet object with the necessary fields to create the sheet by posting it to Smartsheet.

Sheet.CreateSheetFromTemplateBuilder: A class to simplify the creation of a Sheet from another Sheet or another Template.

Sheet.UpdateSheetBuilder: The Class UpdateSheetBuilder.

SheetEmail: Represents Sheet Email object used for sending a sheet by Email.

SheetEmail.CreateSheetEmail: A convenience class for creating a SheetEmail object with the necessary fields.

SheetFilter: Class to encapsulate an entire sheet filter.

SheetFilterDetails: Class encapsulating the sheet filter details.

SheetPublish: Represents the publish Status of a sheet.

SheetPublish.PublishStatusBuilder: A convenience class for making a SheetPublish object with the necessary fields to publish a sheet.

SheetSummary: Represents the SheetSummary object.

SheetUserPermissions: Represents the SheetUserPermissions object.

SheetUserSettings: Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (e.g., viewer permissions or a read-only sheet).

ShortcutDataItem: Represents the widget object.

ShortcutWidgetContent: Represents the ShortcutWidgetContent object.

Sight: Represents the Sight object.

SightPublish: Represents the Sight Publish object (see http://smartsheet-platform.github.io/api-docs/?shell#sightpublish-object

SortCriterion: Class to hold sorting criterion given a columnId and sortDirection.

SortSpecifier: Wrapper class on lists of potential sort criteria.

Source: Represents the source object from which the enclosing report, sheet, sight, or template was created.

StringObjectValue: Wrapper on string object primitive string values.

SummaryField: Represents the SummaryField object.

Template: A template object that is a default layout for future Sheets.

TitleRichTextWidgetContent: Represents the TitleWidgetContent object.

UpdateRequest: Represents the UpdateRequest object.

User: Represents the User object.

User.AddUserBuilder: A convenience class for making a User object with the appropriate fields for adding the user.

User.UpdateUserBuilder: A convenience class for making a User object with the appropriate fields for updating a user.

UserModel: Represents an UserModel.

UserModelWithName: Represents an UserModelWithName.

UserProfile: A user profile object.

WebContentWidgetContent: Represents the WebContentidgetContent object.

Webhook: Represents the webhook object.

WebhookSharedSecret: Represents the webhook shared secret.

WebhookStats: Represents the webhook stats object.

WebhookSubscope: Represents the webhook subscope object.

Widget: Represents the widget object.

WidgetHyperlink: Represents the widget hyperlink object.

Workspace: Represents the Workspace object which is an area in which Sheets, reports, Templates and sub-Folders can be organized, similar to a folder.

Workspace.CreateWorkspaceBuilder: A convenience class for creating a Workspace object with the appropriate fields for creating a workspace.

Workspace.UpdateWorkspaceBuilder: A convenience class for creating a Workspace object with the appropriate fields for updating a workspace.

Structs

ShareScope: Represents the scope of a share. For use with the ShareResources.ListShares(long, PaginationParameters, ShareScope).

Interfaces

IPrimitiveObjectValue<T>: Common interface for primitive types.

IWidgetContent: Interface for widget contents.

ObjectValue: Interface to hold that an objectValue must have a type

Enums

AccessLevel: Represents access levels that Users can have.

AccessScope: Represents the Type of access that is granted on a given sheet.

AttachmentParentType: Represents the attachment parent Type.

AttachmentSubType: Represents the attachment sub Type.

AttachmentType: Represents the Type of attachment.

AutomationActionFrequency: Automation action frequency enumeration

AutomationActionType: Enum holding all types of automation actions.

AutomationRuleDisabledReason: Enum for possible reasons for automation rules to be disabled

CellInclusion: Represents specific elements to include in a response.

ColumnInclusion: Represents specific elements to include in a response.

ColumnTag: Represents the Tags to indicate a special column.

ColumnType: Represents column types.

CopyRowInclusion: Represents the list of row elements to copy in addition to the cell data.

CriteriaOperator: Represents operator.

CriteriaTarget: The target for the filter query

CrossSheetReferenceStatus: Enum to hold status of cross sheet references.

DayDescriptor: Represents the Link types.

DayOrdinal: Represents the Link types.

DestinationType: Represents the type of the destination container (when copying or moving a Sheet or a Folder)..

DiscussionInclusion: Represents specific elements to include in a response.

DiscussionParentType: Represents the discussion parent Type.

EventAction: Enum encapsulating event actions.

EventObjectType: Enum to hold what EventObject is being used in event reporting. See source https://smartsheet-platform.github.io/event-reporting-docs/

EventSource: Enum holding source of an event.

FilterType: Filter Type

FolderCopyInclusion: Represents specific elements to include in a response.

FolderInclusion: Represents specific elements to include in a response.

FolderRemapExclusion: Represents specific references to NOT re-map for the newly created object.

GlobalTemplate: Type of global template.

HomeExclusion: A comma-separated list of optional elements to not include in the response.

HomeInclusion: Represents specific elements to include in a response.

ListUserInclusion: Represents specific elements to include in a response.

MoveRowInclusion: Represents the list of row elements to move in addition to the cell data.

ObjectType: Represents object types.

ObjectValueType: Types of values an object can have.

PaperSize: Represents page dimensions in the Smartsheet REST API. Dimensions pulled from https://community.smartsheet.com/discussion/4116/custom-print-sizes

ReportInclusion: Represents specific elements to include in a response.

RowExclusion: Represents specific elements that can be excluded in a response.

RowInclusion: Represents specific elements to include in a response.

ScheduleType: Represents the Link types.

SearchInclusion: Represents specific elements to include in a response.

SearchLocation: Wrapper over include option for searching inside your personal workspace (sheets folder)

SearchObjectType: Represents object types.

SearchScope: Possible search filters to use to narrow results.

ShareType: The type of the share.

SheetCopyExclusion: A comma-separated list of optional elements to not include in the response.

SheetCopyInclusion: Represents specific elements to include in a response.

SheetEmailFormat: Represents the Sheet Email Format.

SheetFilterOperator: How to combine sheet filter criteria

SheetFilterType: Represents the types of sheet filters

SheetInclusion: Represents specific elements to include in a response.

SheetLevelExclusion: Represents specific elements that can be excluded in a response.

SheetLevelInclusion: Represents specific elements to include in a response.

SightInclusion: Represents specific elements to include in a response.

SortDirection: Enum for sorting direction, ascending or descending.

SummaryFieldExclusion: Represents specific elements to exclude in a response.

SummaryFieldInclusion: Represents specific elements to include in a response.

Symbol: Represents the column symbols.

SystemColumnType: Represents the system column types.

TemplateInclusion: Represents specific elements that can be copied from a Template or Sheet into a new Sheet.

UpdateRequestStatus: Represents the update request status.

UserInclusion: Represents specific elements to include in a response.

UserStatus: Represents the user Status.

WebhookStatus: Represents the user Status.

WidgetType: Represents the contents of the widget.

WorkspaceCopyInclusion: Represents specific elements to include in a response.

WorkspaceInclusion: Represents specific elements to include in a response.

WorkspaceRemapExclusion: Represents specific references to NOT re-map for the newly created object

Table of Contents

Namespace Smartsheet.Api.Models

Classes

Structs

Interfaces

Enums