| Package | Description |
|---|---|
| com.smartsheet.api | |
| com.smartsheet.api.oauth |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessTokenExpiredException
This is the exception to indicate that an access token expired error returned from Smartsheet REST API.
|
class |
AuthorizationException
This is the exception to indicate authorization (access token) related errors returned from Smartsheet REST API.
|
class |
InvalidRequestException
This is the exception to indicate invalid request error returned from Smartsheet REST API.
|
class |
ResourceNotFoundException
This is the exception to indicate a resource can not be found.
|
class |
ServiceUnavailableException
This is the exception to indicate a service unavailable error (possibly due to rate limiting) returned from the
Smartsheet REST API.
|
class |
SmartsheetRestException
This is the exception to indicate errors (Error objects of Smartsheet REST API) returned from Smartsheet REST API.
|
| Modifier and Type | Method and Description |
|---|---|
List<AlternateEmail> |
UserResources.addAlternateEmail(long userId,
List<AlternateEmail> altEmails)
Add an alternate email.
|
List<Column> |
SheetColumnResources.addColumns(long sheetId,
List<Column> columns)
Add column to a sheet.
|
Comment |
DiscussionCommentResources.addComment(long sheetId,
long discussionId,
Comment comment)
Add a comment to a discussion.
|
Comment |
DiscussionCommentResources.addCommentWithAttachment(long sheetId,
long discussionId,
Comment comment,
File file,
String contentType)
Add a comment to a discussion with an attachment.
|
Comment |
DiscussionResources.addDiscussionComment(long id,
Comment comment)
Add a comment to a discussion.
|
List<Favorite> |
FavoriteResources.addFavorites(List<Favorite> favorites)
Adds one or more items to the user’s list of Favorite items.
|
List<GroupMember> |
GroupMemberResources.addGroupMembers(long groupId,
List<GroupMember> members)
Add members to a group.
|
void |
RowColumnResources.addImageToCell(long sheetId,
long rowId,
long columnId,
String file,
String fileType)
Uploads an image to the specified cell within a sheet.
|
void |
RowColumnResources.addImageToCell(long sheetId,
long rowId,
long columnId,
String file,
String fileType,
boolean overrideValidation,
String altText)
Uploads an image to the specified cell within a sheet.
|
User |
UserResources.addProfileImage(long userId,
String file,
String fileType)
Uploads a profile image for the specified user.
|
List<Row> |
SheetRowResources.addRows(long sheetId,
List<Row> rows)
Insert rows to a sheet.
|
List<Row> |
SheetRowResources.addRows(long sheetId,
List<Row> rows,
EnumSet<RowInclusion> includes,
EnumSet<ObjectExclusion> excludes)
Insert rows to a sheet.
|
PartialRowUpdateResult |
SheetRowResources.addRowsAllowPartialSuccess(long sheetId,
List<Row> rows)
Insert rows to a sheet, allowing partial success.
|
PartialRowUpdateResult |
SheetRowResources.addRowsAllowPartialSuccess(long sheetId,
List<Row> rows,
EnumSet<RowInclusion> includes,
EnumSet<ObjectExclusion> excludes)
Insert rows to a sheet, allowing partial success.
|
Result<SummaryField> |
SheetSummaryResources.addSheetSummaryFieldImage(long sheetId,
long fieldId,
String file,
String contentType,
String altText)
Adds an image to the sheet summary field.
|
List<SummaryField> |
SheetSummaryResources.addSheetSummaryFields(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Insert fields into a sheet summary.
|
BulkItemResult<SummaryField> |
SheetSummaryResources.addSheetSummaryFieldsWithPartialSuccess(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Insert fields into a sheet summary.
|
User |
UserResources.addUser(User user)
Add a user to the organization, without sending email.
|
User |
UserResources.addUser(User user,
boolean sendEmail)
Add a user to the organization, without sending email.
|
Attachment |
SheetAttachmentResources.attachFile(long sheetId,
File file,
String contentType)
Attach a file to a sheet with simple upload.
|
Attachment |
SheetAttachmentResources.attachFile(long sheetId,
InputStream inputStream,
String contentType,
long contentLength,
String attachmentName)
Attach file for simple upload.
|
Attachment |
CommentAttachmentResources.attachFile(long sheetId,
long commentId,
File file,
String contentType)
Attach a file to a comment.
|
Attachment |
RowAttachmentResources.attachFile(long sheetId,
long rowId,
File file,
String contentType)
Attach a file to a row with simple upload.
|
Attachment |
CommentAttachmentResources.attachFile(long sheetId,
long commentId,
InputStream inputStream,
String contentType,
long contentLength,
String attachmentName)
Attach file for simple upload.
|
Attachment |
RowAttachmentResources.attachFile(long sheetId,
long rowId,
InputStream inputStream,
String contentType,
long contentLength,
String attachmentName)
Attach file for simple upload.
|
CommentAttachmentResources |
SheetCommentResources.attachmentResources()
Creates an object of CommentAttachmentResources.
|
DiscussionAttachmentResources |
SheetDiscussionResources.attachmentResources()
Creates an object of DiscussionAttachmentResources for access to discussion attachments through SheetDiscussionResources.
|
Attachment |
AttachmentVersioningResources.attachNewVersion(long sheetId,
long attachmentId,
File file,
String contentType)
Attach a new version of an attachment.
|
Attachment |
SheetAttachmentResources.attachUrl(long sheetId,
Attachment attachment)
Attach a URL to a sheet.
|
Attachment |
CommentAttachmentResources.attachUrl(long sheetId,
long commentId,
Attachment attachment)
Attach a URL to a comment.
|
Attachment |
RowAttachmentResources.attachUrl(long sheetId,
long rowId,
Attachment attachment)
Attach a URL to a comment.
|
DiscussionCommentResources |
SheetDiscussionResources.commentResources()
Creates an object of DiscussionCommentResources for access to discussion comments through SheetDiscussionResources.
|
Folder |
FolderResources.copyFolder(long folderId,
ContainerDestination containerDestination,
EnumSet<FolderCopyInclusion> includes,
EnumSet<FolderRemapExclusion> skipRemap)
Creates a copy of the specified Folder.
|
Folder |
FolderResources.copyFolder(long folderId,
ContainerDestination containerDestination,
EnumSet<FolderCopyInclusion> includes,
EnumSet<FolderRemapExclusion> skipRemap,
EnumSet<CopyExclusion> excludes)
Deprecated.
|
CopyOrMoveRowResult |
SheetRowResources.copyRows(Long sheetId,
EnumSet<RowCopyInclusion> includes,
Boolean ignoreRowsNotFound,
CopyOrMoveRowDirective copyParameters)
Copies Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.
|
Sheet |
SheetResources.copySheet(long sheetId,
ContainerDestination containerDestination,
EnumSet<SheetCopyInclusion> includes)
Creates a copy of the specified sheet.
|
Sheet |
SheetResources.copySheet(long sheetId,
ContainerDestination containerDestination,
EnumSet<SheetCopyInclusion> includes,
EnumSet<CopyExclusion> excludes)
Creates a copy of the specified sheet.
|
Sight |
SightResources.copySight(long sightId,
ContainerDestination destination)
Creates s copy of the specified Sight.
|
Workspace |
WorkspaceResources.copyWorkspace(long workspaceId,
ContainerDestination containerDestination,
EnumSet<WorkspaceCopyInclusion> includes,
EnumSet<WorkspaceRemapExclusion> skipRemap)
Creates a copy of the specified workspace.
|
Workspace |
WorkspaceResources.copyWorkspace(long workspaceId,
ContainerDestination containerDestination,
EnumSet<WorkspaceCopyInclusion> includes,
EnumSet<WorkspaceRemapExclusion> skipRemap,
EnumSet<CopyExclusion> excludes)
Deprecated.
|
CrossSheetReference |
SheetCrossSheetReferenceResources.createCrossSheetReference(long sheetId,
CrossSheetReference crossSheetReference)
Create a cross sheet reference in the given sheet.
|
Discussion |
AssociatedDiscussionResources.createDiscussion(long objectId,
Discussion discussion)
Deprecated.
As of release 2.0
|
Discussion |
SheetDiscussionResources.createDiscussion(long sheetId,
Discussion discussion)
Create a discussion on a sheet.
|
Discussion |
RowDiscussionResources.createDiscussion(long sheetId,
long rowId,
Discussion discussion)
Create discussion on a row.
|
Discussion |
SheetDiscussionResources.createDiscussionWithAttachment(long sheetId,
Discussion discussion,
File file,
String contentType)
Create a discussion with attachments on a sheet.
|
Discussion |
RowDiscussionResources.createDiscussionWithAttachment(long sheetId,
long rowId,
Discussion discussion,
File file,
String contentType)
Create discussion on a row.
|
Folder |
HomeFolderResources.createFolder(Folder folder)
Create a folder in home.
|
Folder |
FolderResources.createFolder(long parentFolderId,
Folder folder)
Create a folder.
|
Folder |
WorkspaceFolderResources.createFolder(long workspaceId,
Folder folder)
Create a folder in the workspace.
|
Group |
GroupResources.createGroup(Group group)
Create a
Group. |
Sheet |
SheetResources.createSheet(Sheet sheet)
Create a sheet in default "Sheets" collection.
|
Sheet |
SheetResources.createSheetFromTemplate(Sheet sheet,
EnumSet<SheetTemplateInclusion> includes)
Create a sheet (from existing sheet or template) in default "Sheets" collection.
|
Sheet |
SheetResources.createSheetInFolder(long folderId,
Sheet sheet)
Create a sheet in given folder.
|
Sheet |
SheetResources.createSheetInFolderFromTemplate(long folderID,
Sheet sheet,
EnumSet<SheetTemplateInclusion> includes)
Create a sheet (from existing sheet or template) in given folder.
|
Sheet |
SheetResources.createSheetInWorkspace(long workspaceId,
Sheet sheet)
Create a sheet in given workspace.
|
Sheet |
SheetResources.createSheetInWorkspaceFromTemplate(long workspaceId,
Sheet sheet,
EnumSet<SheetTemplateInclusion> includes)
Create a sheet (from existing sheet or template) in given workspace.
|
UpdateRequest |
SheetResources.createUpdateRequest(long sheetId,
MultiRowEmail email)
Deprecated.
|
UpdateRequest |
SheetUpdateRequestResources.createUpdateRequest(long sheetId,
UpdateRequest updateRequest)
Creates an Update Request for the specified Row(s) within the Sheet.
|
Webhook |
WebhookResources.createWebhook(Webhook webhook)
Creates a new Webhook.
|
Workspace |
WorkspaceResources.createWorkspace(Workspace workspace)
Create a workspace.
|
void |
AttachmentVersioningResources.deleteAllVersions(long sheetId,
long attachentId)
Deletes an attachment, including all of its versions.
|
void |
UserResources.deleteAlternateEmail(long userId,
long altEmailId)
Delete an alternate email.
|
void |
SheetAttachmentResources.deleteAttachment(long sheetId,
long attachmentId)
Delete an attachment.
|
void |
SheetAutomationRuleResources.deleteAutomationRule(long sheetId,
long automationRuleId)
Delete an automation rule.
|
void |
SheetColumnResources.deleteColumn(long sheetId,
long columnId)
Delete column.
|
void |
SheetCommentResources.deleteComment(long sheetId,
long commentId)
Delete a comment.
|
void |
SheetDiscussionResources.deleteDiscussion(long sheetId,
long discussionId)
Delete discussion.
|
void |
SheetFilterResources.deleteFilter(long sheetId,
long filterId)
Delete filter.
|
void |
FolderResources.deleteFolder(long folderId)
Delete a folder.
|
void |
GroupResources.deleteGroup(long groupId)
Delete a
Group. |
void |
GroupMemberResources.deleteGroupMember(long groupId,
long userId)
Remove a member from a group.
|
String |
PassthroughResources.deleteRequest(String endpoint)
Issue an HTTP DELETE request.
|
void |
RowResources.deleteRow(long id)
Delete a row.
|
void |
SheetRowResources.deleteRow(long sheetId,
long rowId)
Deprecated.
|
List<Long> |
SheetRowResources.deleteRows(long sheetId,
Set<Long> rowIds,
boolean ignoreRowsNotFound)
Deletes one or more row(s) from the Sheet specified in the URL.
|
void |
SheetUpdateRequestResources.deleteSentUpdateRequest(long sheetId,
long sentUpdateRequestId)
Deletes the specified sent update request.
|
void |
ShareResources.deleteShare(long objectId,
String shareId)
Delete a share.
|
void |
SheetResources.deleteSheet(long id)
Delete a sheet.
|
List<Long> |
SheetSummaryResources.deleteSheetSummaryFields(long sheetId,
Set<Long> fieldIds,
Boolean ignoreSummaryFieldsNotFound)
Delete fields in a sheet summary.
|
void |
SightResources.deleteSight(long sightId)
Delete a specified Sight.
|
void |
SheetUpdateRequestResources.deleteUpdateRequest(long sheetId,
long updateRequestId)
Terminates the future scheduled delivery of the Update Request specified in the URL.
|
void |
UserResources.deleteUser(long id,
DeleteUserParameters parameters)
Delete a user in the organization.
|
void |
WebhookResources.deleteWebhook(long webhookId)
Delete a webhook.
|
void |
WorkspaceResources.deleteWorkspace(long id)
Delete a workspace.
|
AlternateEmail |
UserResources.getAlternateEmail(long userId,
long altEmailId)
Get alternate email.
|
Attachment |
SheetAttachmentResources.getAttachment(long sheetId,
long attachmentId)
Get an attachment.
|
PagedResult<Attachment> |
DiscussionAttachmentResources.getAttachments(long sheetId,
long discussionId,
PaginationParameters parameters)
Get discussion attachment.
|
PagedResult<Attachment> |
RowAttachmentResources.getAttachments(long sheetId,
long rowId,
PaginationParameters parameters)
Get row attachment.
|
AutomationRule |
SheetAutomationRuleResources.getAutomationRule(long sheetId,
long automationRuleId)
Get a automation rule.
|
List<CellHistory> |
RowResources.getCellHistory(long rowId,
long columnId)
Get the cell modification history.
|
PagedResult<CellHistory> |
RowColumnResources.getCellHistory(long sheetId,
long rowId,
long columnId,
PaginationParameters pagination)
Get the cell modification history.
|
PagedResult<CellHistory> |
RowColumnResources.getCellHistory(long sheetId,
long rowId,
long columnId,
PaginationParameters pagination,
EnumSet<CellHistoryInclusion> includes,
Integer level)
Get the cell modification history.
|
Column |
SheetColumnResources.getColumn(long sheetId,
long columnId,
EnumSet<ColumnInclusion> includes)
Gets the Column specified in the URL.
|
Comment |
SheetCommentResources.getComment(long sheetId,
long commentId)
Get a comment.
|
Contact |
ContactResources.getContact(String contactId)
Gets the specified Contact.
|
CrossSheetReference |
SheetCrossSheetReferenceResources.getCrossSheetReference(long sheetId,
long crossSheetReferenceId)
Get a cross sheet reference.
|
UserProfile |
UserResources.getCurrentUser()
Get the current user.
|
UserProfile |
UserResources.getCurrentUser(EnumSet<UserInclusion> includes)
Get the current user.
|
Discussion |
SheetDiscussionResources.getDiscussion(long sheetId,
long discussionId)
Get a discussion.
|
SheetFilter |
SheetFilterResources.getFilter(long sheetId,
long filterId)
Get a filter.
|
Folder |
FolderResources.getFolder(long folderId,
EnumSet<SourceInclusion> includes)
Get a folder.
|
Group |
GroupResources.getGroup(long groupId)
Get a
Group. |
Home |
HomeResources.getHome(EnumSet<SourceInclusion> includes)
Get a nested list of all Home objects, including sheets, workspaces and folders, and optionally reports and/or
templates, as shown on the Home tab.
|
Home |
HomeResources.getHome(EnumSet<SourceInclusion> includes,
EnumSet<SourceExclusion> excludes)
Get a nested list of all Home objects, including sheets, workspaces and folders, and optionally reports and/or
templates, as shown on the Home tab.
|
ImageUrlMap |
ImageUrlResources.getImageUrls(List<ImageUrl> requestUrls)
Gets URLS that can be used to retrieve the specified cell images.
|
SheetPublish |
SheetResources.getPublishStatus(long id)
Get the status of the Publish settings of the sheet, including the URLs of any enabled publishings.
|
SightPublish |
SightResources.getPublishStatus(long sightId)
Get the publish status of a Sight.
|
ReportPublish |
ReportResources.getPublishStatus(long id)
Get the publish status of a report.
|
Report |
ReportResources.getReport(long reportId,
EnumSet<ReportInclusion> includes,
Integer pageSize,
Integer page)
Get a report.
|
Report |
ReportResources.getReport(long reportId,
EnumSet<ReportInclusion> includes,
Integer pageSize,
Integer page,
Integer level)
Get a report.
|
void |
ReportResources.getReportAsCsv(long id,
OutputStream outputStream)
Get a Report as an csv file.
|
void |
ReportResources.getReportAsExcel(long id,
OutputStream outputStream)
Get a Report as an excel file.
|
String |
PassthroughResources.getRequest(String endpoint,
HashMap<String,Object> parameters)
Issue an HTTP GET request.
|
Row |
RowResources.getRow(long id,
EnumSet<ObjectInclusion> includes)
Get a row.
|
Row |
SheetRowResources.getRow(long sheetId,
long rowId,
EnumSet<RowInclusion> includes,
EnumSet<ObjectExclusion> excludes)
Get a row.
|
SentUpdateRequest |
SheetUpdateRequestResources.getSentUpdateRequest(long sheetId,
long sentUpdateRequestId)
Gets the specified sent update request on the Sheet.
|
ServerInfo |
ServerInfoResources.getServerInfo()
Gets application constants.
|
Share |
ShareResources.getShare(long objectId,
String shareId)
Get a Share.
|
Sheet |
SheetResources.getSheet(long id,
EnumSet<SheetInclusion> includes,
EnumSet<ObjectExclusion> excludes,
Set<Long> rowIds,
Set<Integer> rowNumbers,
Set<Long> columnIds,
Integer pageSize,
Integer page)
Get a sheet.
|
Sheet |
SheetResources.getSheet(long id,
EnumSet<SheetInclusion> includes,
EnumSet<ObjectExclusion> excludes,
Set<Long> rowIds,
Set<Integer> rowNumbers,
Set<Long> columnIds,
Integer pageSize,
Integer page,
Integer ifVersionAfter)
Get a sheet.
|
Sheet |
SheetResources.getSheet(long id,
EnumSet<SheetInclusion> includes,
EnumSet<ObjectExclusion> excludes,
Set<Long> rowIds,
Set<Integer> rowNumbers,
Set<Long> columnIds,
Integer pageSize,
Integer page,
Integer ifVersionAfter,
Integer level)
Get a sheet.
|
void |
SheetResources.getSheetAsCSV(long id,
OutputStream outputStream)
Get a sheet as an Excel file.
|
void |
SheetResources.getSheetAsExcel(long id,
OutputStream outputStream)
Get a sheet as an Excel file.
|
void |
SheetResources.getSheetAsPDF(long id,
OutputStream outputStream,
PaperSize paperSize)
Get a sheet as a PDF file.
|
SheetSummary |
SheetSummaryResources.getSheetSummary(long sheetId,
EnumSet<SummaryFieldInclusion> includes,
EnumSet<SummaryFieldExclusion> excludes)
Gets the sheet summary
|
PagedResult<SummaryField> |
SheetSummaryResources.getSheetSummaryFields(long sheetId,
EnumSet<SummaryFieldInclusion> includes,
EnumSet<SummaryFieldExclusion> excludes,
PaginationParameters pagination)
Gets the sheet summary fields
|
int |
SheetResources.getSheetVersion(long id)
Get a sheet version.
|
Sight |
SightResources.getSight(long sightId)
Get a specified Sight.
|
Sight |
SightResources.getSight(long sightId,
EnumSet<SightInclusion> includes,
Integer level)
Get a specified Sight.
|
Sight |
SightResources.getSight(long sightId,
Integer level)
Get a specified Sight.
|
UpdateRequest |
SheetUpdateRequestResources.getUpdateRequest(long sheetId,
long updateRequestId)
Gets the specified Update Request for the Sheet that has a future schedule.
|
UserProfile |
UserResources.getUser(long userId)
Get the current user.
|
Webhook |
WebhookResources.getWebhook(long webhookId)
Gets the Webhook specified in the URL.
|
Workspace |
WorkspaceResources.getWorkspace(long id,
Boolean loadAll,
EnumSet<SourceInclusion> includes)
Get a workspace.
|
Sheet |
SheetResources.importCsv(String file,
String sheetName,
Integer headerRowIndex,
Integer primaryRowIndex)
Imports a sheet.
|
Sheet |
SheetResources.importCsvInFolder(long folderID,
String file,
String sheetName,
Integer headerRowIndex,
Integer primaryRowIndex)
Imports a sheet in given folder.
|
Sheet |
SheetResources.importCsvInWorkspace(long workspaceId,
String file,
String sheetName,
Integer headerRowIndex,
Integer primaryRowIndex)
Imports a sheet in given workspace.
|
Sheet |
SheetResources.importXlsx(String file,
String sheetName,
Integer headerRowIndex,
Integer primaryRowIndex)
Imports a sheet.
|
Sheet |
SheetResources.importXlsxInFolder(long folderID,
String file,
String sheetName,
Integer headerRowIndex,
Integer primaryRowIndex)
Imports a sheet in given folder.
|
Sheet |
SheetResources.importXlsxInWorkspace(long workspaceId,
String file,
String sheetName,
Integer headerRowIndex,
Integer primaryRowIndex)
Imports a sheet in given workspace.
|
PagedResult<Attachment> |
AttachmentVersioningResources.listAllVersions(long sheetId,
long attachmentId,
PaginationParameters parameters)
Get all versions of an attachment.
|
PagedResult<AlternateEmail> |
UserResources.listAlternateEmails(long userId,
PaginationParameters pagination)
List all user alternate email(s).
|
PagedResult<Attachment> |
SheetAttachmentResources.listAttachments(long sheetId,
PaginationParameters parameters)
Gets a list of all Attachments that are on the Sheet, including Sheet, Row, and Discussion level Attachments.
|
PagedResult<AutomationRule> |
SheetAutomationRuleResources.listAutomationRules(long sheetId,
PaginationParameters pagination)
Get all automation rules for this sheet
|
PagedResult<Column> |
SheetColumnResources.listColumns(long sheetId,
EnumSet<ColumnInclusion> includes,
PaginationParameters pagination)
List columns of a given sheet.
|
PagedResult<Contact> |
ContactResources.listContacts(PaginationParameters parameters)
Gets a list of the user’s Smartsheet Contacts.
|
PagedResult<CrossSheetReference> |
SheetCrossSheetReferenceResources.listCrossSheetReferences(long sheetId,
PaginationParameters pagination)
Get all cross sheet references for this sheet
|
PagedResult<Discussion> |
RowDiscussionResources.listDiscussions(long sheetId,
long rowId,
PaginationParameters pagination,
EnumSet<DiscussionInclusion> includes)
Gets a list of all Discussions associated with the specified Row.
|
PagedResult<Discussion> |
SheetDiscussionResources.listDiscussions(long sheetId,
PaginationParameters pagination,
EnumSet<DiscussionInclusion> includes)
Get all discussions
|
EventResult |
EventResources.listEvents(Object since,
String streamPosition,
Integer maxCount,
Boolean numericDates)
List all events.
|
PagedResult<Favorite> |
FavoriteResources.listFavorites(PaginationParameters parameters)
Gets a list of all of the user’s Favorite items.
|
PagedResult<SheetFilter> |
SheetFilterResources.listFilters(long sheetId,
PaginationParameters pagination)
Get all filters
|
PagedResult<Folder> |
FolderResources.listFolders(long parentFolderId,
PaginationParameters parameters)
List child folders of a given folder.
|
PagedResult<Folder> |
WorkspaceFolderResources.listFolders(long workspaceId,
PaginationParameters parameters)
List folders of a given workspace.
|
PagedResult<Folder> |
HomeFolderResources.listFolders(PaginationParameters parameters)
List folders under home.
|
PagedResult<Group> |
GroupResources.listGroups(PaginationParameters parameters)
List all group.
|
PagedResult<Sheet> |
SheetResources.listOrganizationSheets(PaginationParameters parameters)
Deprecated.
|
PagedResult<Sheet> |
UserResources.listOrgSheets(PaginationParameters pagination)
Deprecated.
|
PagedResult<Sheet> |
UserResources.listOrgSheets(PaginationParameters pagination,
Date modifiedSince)
List all organisation sheets.
|
PagedResult<Template> |
TemplateResources.listPublicTemplates(PaginationParameters parameters)
List public templates.
|
PagedResult<Report> |
ReportResources.listReports(PaginationParameters parameters)
Deprecated.
|
PagedResult<Report> |
ReportResources.listReports(PaginationParameters parameters,
Date modifiedSince)
List all reports.
|
PagedResult<SentUpdateRequest> |
SheetUpdateRequestResources.listSentUpdateRequests(long sheetId,
PaginationParameters paging)
Gets a list of all Sent Update Requests that have future schedules associated with the specified Sheet.
|
PagedResult<Share> |
ShareResources.listShares(long objectId,
PaginationParameters parameters)
Deprecated.
|
PagedResult<Share> |
ShareResources.listShares(long objectId,
PaginationParameters parameters,
Boolean includeWorkspaceShares)
List shares of a given object.
|
PagedResult<Sheet> |
SheetResources.listSheets(EnumSet<SourceInclusion> includes,
PaginationParameters pagination)
Deprecated.
|
PagedResult<Sheet> |
SheetResources.listSheets(EnumSet<SourceInclusion> includes,
PaginationParameters pagination,
Date modifiedSince)
List all sheets.
|
PagedResult<Sight> |
SightResources.listSights(PaginationParameters paging,
Date modifiedSince)
Gets the list of all Sights where the User has access.
|
PagedResult<UpdateRequest> |
SheetUpdateRequestResources.listUpdateRequests(long sheetId,
PaginationParameters paging)
Gets a list of all Update Requests that have future schedules associated with the specified Sheet.
|
PagedResult<Template> |
TemplateResources.listUserCreatedTemplates(PaginationParameters parameters)
List user-created templates.
|
PagedResult<User> |
UserResources.listUsers()
List all users.
|
PagedResult<User> |
UserResources.listUsers(Set<String> email,
EnumSet<ListUserInclusion> includes,
PaginationParameters pagination)
List all users.
|
PagedResult<User> |
UserResources.listUsers(Set<String> email,
PaginationParameters pagination)
List all users.
|
PagedResult<Webhook> |
WebhookResources.listWebhooks(PaginationParameters paging)
Gets the list of all Webhooks that the user owns (if a user generated token was used to make the request)
or the list of all Webhooks associated with the third-party app (if a third-party app made the request).
|
PagedResult<Workspace> |
WorkspaceResources.listWorkspaces(PaginationParameters parameters)
List all workspaces.
|
GroupMemberResources |
GroupResources.memberResources()
Represents the GroupMemberResources.
|
Folder |
FolderResources.moveFolder(long folderId,
ContainerDestination containerDestination)
Moves the specified Folder to another location.
|
List<Row> |
RowResources.moveRow(long id,
RowWrapper rowWrapper)
Move a row.
|
CopyOrMoveRowResult |
SheetRowResources.moveRows(Long sheetId,
EnumSet<RowMoveInclusion> includes,
Boolean ignoreRowsNotFound,
CopyOrMoveRowDirective moveParameters)
Moves Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.
|
Sheet |
SheetResources.moveSheet(long sheetId,
ContainerDestination containerDestination)
Moves the specified Sheet to another location.
|
Sight |
SightResources.moveSight(long sightId,
ContainerDestination destination)
Creates s copy of the specified Sight.
|
String |
PassthroughResources.postRequest(String endpoint,
String payload,
HashMap<String,Object> parameters)
Issue an HTTP POST request.
|
AlternateEmail |
UserResources.promoteAlternateEmail(long userId,
long altEmailId)
Promote and alternate email to primary.
|
String |
PassthroughResources.putRequest(String endpoint,
String payload,
HashMap<String,Object> parameters)
Issue an HTTP PUT request.
|
void |
FavoriteResources.removeFavorites(FavoriteType favoriteType,
Set<Long> objectIds)
Deletes a list of favorites (all of the same type)
|
WebhookSharedSecret |
WebhookResources.resetSharedSecret(long webhookId)
Resets the shared secret for the specified Webhook.
|
void |
TokenResources.revokeAccessToken()
Revoke access token.
|
SearchResult |
SearchResources.search(String query)
Performs a search across all Sheets to which user has access.
|
SearchResult |
SearchResources.search(String query,
EnumSet<SearchInclusion> includes,
SearchLocation location,
Date modifiedSince,
EnumSet<SearchScope> scopes)
Performs a search across all Sheets to which user has access.
|
SearchResult |
SearchResources.searchSheet(long sheetId,
String query)
Performs a search within a sheet.
|
void |
ReportResources.sendReport(long reportId,
SheetEmail email)
Send a sheet as a PDF attachment via Email To the designated recipients.
|
void |
SheetRowResources.sendRow(long sheetId,
long rowId,
RowEmail email)
Deprecated.
|
void |
RowResources.sendRow(long id,
RowEmail email)
Send a row via email to the designated recipients.
|
void |
SheetRowResources.sendRows(long sheetId,
MultiRowEmail email)
Send a row via email to the designated recipients.
|
void |
SheetResources.sendSheet(long id,
SheetEmail email)
Send a sheet as a PDF attachment via email to the designated recipients.
|
SightPublish |
SightResources.setPublishStatus(long sightId,
SightPublish sightPublish)
Sets the publish status of a Sight and returns the new status, including the URLs of any enabled publishing.
|
List<Share> |
ShareResources.shareTo(long objectId,
List<Share> shares,
Boolean sendEmail)
Shares the object with the specified Users and Groups.
|
Sheet |
SheetResources.sortSheet(long sheetId,
SortSpecifier sortSpecifier)
Sort a sheet according to the sort criteria.
|
Sheet |
SheetResources.sortSheet(long sheetId,
SortSpecifier sortSpecifier,
Integer level)
Sort a sheet according to the sort criteria.
|
AutomationRule |
SheetAutomationRuleResources.updateAutomationRule(long sheetId,
AutomationRule automationRule)
Updates an automation rule.
|
List<Cell> |
RowResources.updateCells(long rowId,
List<Cell> cells)
Update the values of the Cells in a Row.
|
Column |
SheetColumnResources.updateColumn(long sheetId,
Column column)
Update a column.
|
Comment |
DiscussionCommentResources.updateComment(long sheetId,
Comment comment)
Update the specified comment
|
Folder |
FolderResources.updateFolder(Folder folder)
Update a folder.
|
Group |
GroupResources.updateGroup(Group group)
Update a
Group. |
ReportPublish |
ReportResources.updatePublishStatus(long id,
ReportPublish reportPublish)
Sets the publish status of a report and returns the new status, including the URLs of any
enabled publishing.
|
SheetPublish |
SheetResources.updatePublishStatus(long id,
SheetPublish publish)
Sets the publish status of a sheet and returns the new status, including the URLs of any enabled publishings.
|
List<Row> |
SheetRowResources.updateRows(long sheetId,
List<Row> rows)
Update rows.
|
List<Row> |
SheetRowResources.updateRows(long sheetId,
List<Row> rows,
EnumSet<RowInclusion> includes,
EnumSet<ObjectExclusion> excludes)
Update rows.
|
PartialRowUpdateResult |
SheetRowResources.updateRowsAllowPartialSuccess(long sheetId,
List<Row> rows)
Update rows, but allow partial success.
|
PartialRowUpdateResult |
SheetRowResources.updateRowsAllowPartialSuccess(long sheetId,
List<Row> rows,
EnumSet<RowInclusion> includes,
EnumSet<ObjectExclusion> excludes)
Update rows, but allow partial success.
|
Share |
ShareResources.updateShare(long objectId,
Share share)
Update a share.
|
Sheet |
SheetResources.updateSheet(Sheet sheet)
Update a sheet.
|
List<SummaryField> |
SheetSummaryResources.updateSheetSummaryFields(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Update fields in a sheet summary.
|
BulkItemResult<SummaryField> |
SheetSummaryResources.updateSheetSummaryFieldsWithPartialSuccess(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Update fields in a sheet summary.
|
Sight |
SightResources.updateSight(Sight sight)
Get a specified Sight.
|
UpdateRequest |
SheetUpdateRequestResources.updateUpdateRequest(long sheetId,
UpdateRequest updateRequest)
Changes the specified Update Request for the Sheet.
|
User |
UserResources.updateUser(User user)
Update a user.
|
Webhook |
WebhookResources.updateWebhook(Webhook webhook)
Updates the webhooks specified in the URL.
|
Workspace |
WorkspaceResources.updateWorkspace(Workspace workspace)
Update a workspace.
|
AttachmentVersioningResources |
SheetAttachmentResources.versioningResources()
Creates an object of AttachmentVersioningResources for access to versioning through SheetAttachmentResources.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccessDeniedException
This is the exception thrown by
OAuthFlow to indicate "access_denied" error when obtaining an authorization code. |
class |
InvalidOAuthClientException
This is the exception thrown by
OAuthFlow to indicate an "invalid_client" error occurred when obtaining
OAuth tokens. |
class |
InvalidOAuthGrantException
This is the exception thrown by
OAuthFlow to indicate an "invalid_grant" error occurred when obtaining
OAuth tokens. |
class |
InvalidScopeException
This is the exception thrown by
OAuthFlow to indicate an "invalid_scope" error occurred when obtaining an
authorization code. |
class |
InvalidTokenRequestException
This is the exception thrown by
OAuthFlow to indicate an "invalid_request" error occurred when obtaining OAuth
tokens. |
class |
OAuthAuthorizationCodeException
This is the exception thrown by
OAuthFlow to indicate errors occurred when obtaining authorization code. |
class |
OAuthTokenException
This is the exception thrown by
OAuthFlow to indicate errors occurred during obtaining OAuth tokens. |
class |
UnsupportedOAuthGrantTypeException
This is the exception thrown by
OAuthFlow to indicate "unsupported_grant_type" error occurred during obtaining OAuth
tokens. |
class |
UnsupportedResponseTypeException
This is the exception thrown by
OAuthFlow to indicate "unsupported_response_type" error occurred when obtaining
an authorization code. |
Copyright © 2014–2019 Smartsheet. All rights reserved.