Click or drag to resize

Smartsheet.Api Namespace

 
Classes
  ClassDescription
Public classAccessTokenExpiredException

This is the exception to indicate that an access token expired error returned from Smartsheet REST API. This exception will be thrown when the Smartsheet REST API generates a "1003 Your Access Token has expired" error.

Thread safety: Exceptions are not thread safe.

Public classAuthorizationException

This is the exception to indicate authorization (access token) related errors returned from Smartsheet REST API.

Basically this exception will be thrown when the Smartsheet REST API responds with "401 NOT AUTHORIZED" / "403 FORBIDDEN"

Thread safety: Exceptions are not thread safe.

Public classInvalidRequestException

This is the exception to indicate invalid request error returned from Smartsheet REST API.

Basically this exception will be thrown when the Smartsheet REST API responds with "400 BAD REQUEST".

Thread safety: Exceptions are not thread safe.

Public classResourceNotFoundException
This is the exception to indicate a resource can not be found. Basically this exception will be thrown when the Smartsheet REST API responds with "404 NOT FOUND". Thread safety: Exceptions are not thread safe.
Public classServiceUnavailableException

This is the exception to indicate a service unavailable error (possibly due to rate limiting) returned from the Smartsheet REST API.

Basically this exception will be thrown when the Smartsheet REST API responds with "503 SERVICE UNAVAILABLE".

Thread safety: Exceptions are not thread safe.

Public classSmartsheetBuilder

A convenience class to help create a instance with the appropriate fields.

Thread Safety: This class is not thread safe since it's mutable, one builder instance is NOT expected to be used in multiple threads.

Public classSmartsheetException

This is the base class for all exceptions thrown from the Smartsheet SDK.

Thread safety: Exceptions are not thread safe.

Public classSmartsheetRestException

This is the exception to indicate errors (Error objects of Smartsheet REST API) returned from Smartsheet REST API.

Thread safety: Exceptions are not thread safe.

Interfaces
  InterfaceDescription
Public interfaceAttachmentVersioningResources

This interface provides methods to access Versioning resources that are associated to an Attachment resource.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceCommentAttachmentResources

This interface provides methods to access Attachment resources that are associated to Comment resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceContactResources

This interface provides methods to access Contact resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceDiscussionAttachmentResources

This interface provides methods to access Attachment resources that are associated to Discussion resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceDiscussionCommentResources

This interface provides methods to access Comment resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceEventResources
Public interfaceFavoriteResources

This interface provides methods to access Favorite resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceFolderResources

This interface provides methods to access Folder resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceFolderSheetResources

This interface provides methods to access sheet resources that are associated to a Folder object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceGroupResources

This interface provides methods to access Group resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceHomeFolderResources

This interface provides methods to access Folder resources under home.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceHomeResources

This interface provides methods to access Home resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceImageUrlsResources
This interface provides methods to access image URLs. Thread Safety: Implementation of this interface must be thread safe.
Public interfacePassthroughResources
Public interfaceReportResources

This interface provides methods to access Report resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceRowAttachmentResources

This interface provides methods to access Attachment resources associated to a row resource.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceRowColumnResources
This interface provides methods to access cell resources that are associated to a row and column. Thread Safety: Implementation of this interface must be thread safe.
Public interfaceRowDiscussionResources

This interface provides methods to access Discussion resources associated to a row resource.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSearchResources
This interface provides methods to access search resources. Thread Safety: Implementation of this interface must be thread safe.
Public interfaceServerInfoResources

This interface provides methods to access Sheet resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceShareResources

This interface provides methods to access Share resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetAttachmentResources

This interface provides methods to access Attachment resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetAutomationRuleResources

This interface provides methods to access AutomationRule resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetColumnResources

This interface provides methods to access column resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetCommentResources

This interface provides methods to access Comment resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetCrossSheetReferenceResources
Public interfaceSheetDiscussionResources

This interface provides methods to access discussion resources that are associated to a Sheet object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetFilterResources

This interface provides methods to access sheet filter resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetResources

This interface provides methods to access sheet resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceSheetRowResources
This interface provides methods to access row resources that are associated to a sheet object. Thread Safety: Implementation of this interface must be thread safe.
Public interfaceSheetSummaryResources
This interface provides methods to access sheet summary resources that are associated to a sheet object. Thread Safety: Implementation of this interface must be thread safe.
Public interfaceSheetUpdateRequestResources
Public interfaceSightResources
Public interfaceSmartsheetClient

This interface is the entry point of the Smartsheet SDK, it provides convenient methods to get XXXResources instances for accessing different types of resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceTemplateResources

This interface provides methods to access Template resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceTokenResources

This interface provides methods to access Token resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceUserResources

This interface provides methods to access User resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceUserSheetResources

This interface provides methods to access Sheet resources of User.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceWebhookResources
Public interfaceWorkspaceFolderResources

This interface provides methods to access Folder resources that are associated to a workspace object.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceWorkspaceResources

This interface provides methods to access Workspace resources.

Thread Safety: Implementation of this interface must be thread safe.

Public interfaceWorkspaceSheetResources

This interface provides methods to access sheet resources that are associated to a Workspace object.

Thread Safety: Implementation of this interface must be thread safe.