| Package | Description |
|---|---|
| com.smartsheet.api | |
| com.smartsheet.api.models |
| Modifier and Type | Method and Description |
|---|---|
PagedResult<Attachment> |
RowAttachmentResources.getAttachments(long sheetId,
long rowId,
PaginationParameters parameters)
Get row attachment.
|
PagedResult<Attachment> |
DiscussionAttachmentResources.getAttachments(long sheetId,
long discussionId,
PaginationParameters parameters)
Get discussion attachment.
|
PagedResult<CellHistory> |
RowColumnResources.getCellHistory(long sheetId,
long rowId,
long columnId,
PaginationParameters parameters)
Get the cell modification history.
|
PagedResult<Attachment> |
AttachmentVersioningResources.listAllVersions(long sheetId,
long attachmentId,
PaginationParameters parameters)
Get all versions of an attachment.
|
PagedResult<AlternateEmail> |
UserResources.listAlternateEmails(long userId,
PaginationParameters pagination) |
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<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<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
It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/discussions/{discussionId}
Exceptions:
IllegalArgumentException : if any argument is null
InvalidRequestException : if there is any problem with the REST API request
AuthorizationException : if there is any problem with the REST API authorization(access token)
ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting)
SmartsheetRestException : if there is any other REST API related error occurred during the operation
SmartsheetException : if there is any other error occurred during the operation
|
PagedResult<Favorite> |
FavoriteResources.listFavorites(PaginationParameters parameters)
Gets a list of all of the user’s Favorite items.
|
PagedResult<Folder> |
WorkspaceFolderResources.listFolders(long workspaceId,
PaginationParameters parameters)
List folders of a given workspace.
|
PagedResult<Folder> |
FolderResources.listFolders(long parentFolderId,
PaginationParameters parameters)
List child folders of a given folder.
|
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(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.
|
| Modifier and Type | Method and Description |
|---|---|
PaginationParameters |
PaginationParameters.PaginationParametersBuilder.build()
Builds the PaginationParameters object
|
PaginationParameters |
PaginationParameters.setIncludeAll(boolean includeAll)
Sets includeAll
|
PaginationParameters |
PaginationParameters.setPage(Integer page)
Sets the page
|
PaginationParameters |
PaginationParameters.setPageSize(Integer pageSize)
Sets the page size
|
Copyright © 2014–2017 Smartsheet. All rights reserved.