com.smartsheet.api

Interface TemplateResources

public interface TemplateResources

This interface provides methods to access Template resources.

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

Method Summary

Modifier and Type	Method and Description
PagedResult<Template>	listPublicTemplates(PaginationParameters parameters) List public templates.
PagedResult<Template>	listUserCreatedTemplates(PaginationParameters parameters) List user-created templates.

Method Detail

listUserCreatedTemplates

PagedResult<Template> listUserCreatedTemplates(PaginationParameters parameters)
                                        throws SmartsheetException

List user-created templates. It mirrors to the following Smartsheet REST API method: GET /templates

Parameters:

parameters - the pagination parameters Exceptions: - 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

Returns:

all templates (note that empty list will be returned if there is none)

Throws:

SmartsheetException - the smartsheet exception

listPublicTemplates

PagedResult<Template> listPublicTemplates(PaginationParameters parameters)
                                   throws SmartsheetException

List public templates. It mirrors to the following Smartsheet REST API method: GET /templates/public

Parameters:

parameters - the pagination parameters Exceptions: - 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

Returns:

all templates (note that empty list will be returned if there is none)

Throws:

SmartsheetException - the smartsheet exception