Package com.smartsheet.api

Core interfaces and classes for the Smartsheet Java SDK.

This package contains the main entry points for interacting with the Smartsheet API, including the Smartsheet client interface and its factory classes, resource interfaces for accessing different Smartsheet objects (sheets, workspaces, reports, etc.), and exception classes for handling API errors.

To get started, use SmartsheetFactory to create a client instance:

 Smartsheet smartsheet = SmartsheetFactory.createDefaultClient(accessToken);
 

See Also:

Smartsheet, SmartsheetFactory, SmartsheetBuilder

Interface Summary

Interface	Description
AssetShareResources	This interface provides methods to access Asset Share resources.
AssociatedAttachmentResources	Deprecated, for removal: This API element is subject to removal in a future version. As of release 2.0.
AssociatedDiscussionResources	Deprecated, for removal: This API element is subject to removal in a future version. As of release 2.0.
AttachmentResources	Deprecated, for removal: This API element is subject to removal in a future version. As of release 2.0.
AttachmentVersioningResources	This interface provides methods to access AttachmentVersioning resources.
ColumnResources	Deprecated, for removal: This API element is subject to removal in a future version. As of release 2.0.
CommentAttachmentResources	This interface provides methods to access CommentAttachment resources.
CommentResources	Deprecated, for removal: This API element is subject to removal in a future version. As of release 2.0.
ContactResources
DiscussionAttachmentResources
DiscussionCommentResources
DiscussionResources	This interface provides methods to access Discussion resources.
EventResources
FavoriteResources
FolderResources	This interface provides methods to access Folder resources.
GroupMemberResources	This interface provides methods to access Share resources.
GroupResources	This interface provides methods to access Group resources
HomeFolderResources	Deprecated, for removal: This API element is subject to removal in a future version. Home resources have been deprecated and will be removed in a future version.
HomeResources	Deprecated, for removal: This API element is subject to removal in a future version. Home resources have been deprecated and will be removed in a future version.
ImageUrlResources
PassthroughResources	This interface provides methods to access Passthrough resources.
ReportResources	This interface provides methods to access Report resources.
RowAttachmentResources	This interface provides methods to access RowAttachment resources.
RowColumnResources	This interface provides methods to access row column resources that are associated to a sheet object.
RowDiscussionResources	This interface provides methods to access Row Discussion resources.
SearchResources	This interface provides methods to access search resources.
ServerInfoResources	This interface provides methods to server information resources.
ShareResources	Deprecated, for removal: This API element is subject to removal in a future version. As of release 2.0.
SheetAttachmentResources
SheetAutomationRuleResources
SheetColumnResources	This interface provides methods to access column resources that are associated to a sheet object.
SheetCommentResources	This interface provides methods to access Sheet Comment resources.
SheetCrossSheetReferenceResources
SheetDiscussionResources
SheetFilterResources
SheetResources	This interface provides methods to access Sheet resources.
SheetRowResources	This interface provides methods to access row resources that are associated to a sheet object.
SheetSummaryResources
SheetUpdateRequestResources
SightResources
Smartsheet	This interface is the entry point of the Smartsheet SDK, it provides convenient methods to get XXXResources instances for accessing different types of resources.
TemplateResources	This interface provides methods to access Template resources.
TokenResources
UserResources	This interface provides methods to access User resources.
WebhookResources
WorkspaceFolderResources	T
WorkspaceResources	This interface provides methods to access Workspace resources.

Class Summary

Class	Description
SmartsheetBuilder	A convenience class to help create a Smartsheet instance with the appropriate fields.
SmartsheetFactory

Enum Summary

Enum	Description
Trace	this enum is used to control what from the HTTP request and response is logged

Exception Summary

Exception	Description
AccessTokenExpiredException	This is the exception to indicate that an access token expired error returned from Smartsheet REST API.
AuthorizationException	This is the exception to indicate authorization (access token) related errors returned from Smartsheet REST API.
InvalidRequestException	This is the exception to indicate invalid request error returned from Smartsheet REST API.
ResourceNotFoundException	This is the exception to indicate a resource can not be found.
ServiceUnavailableException	This is the exception to indicate a service unavailable error (possibly due to rate limiting) returned from the Smartsheet REST API.
SmartsheetException	This is the base class for all exceptions thrown from the Smartsheet SDK.
SmartsheetRestException	This is the exception to indicate errors (Error objects of Smartsheet REST API) returned from Smartsheet REST API.