com.smartsheet.api

Interface PassthroughResources

public interface PassthroughResources

This interface provides methods to access Passthrough resources.

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

Method Summary

Modifier and Type	Method and Description
String	deleteRequest(String endpoint) Issue an HTTP DELETE request.
String	getRequest(String endpoint, HashMap<String,Object> parameters) Issue an HTTP GET request.
String	postRequest(String endpoint, String payload, HashMap<String,Object> parameters) Issue an HTTP POST request.
String	putRequest(String endpoint, String payload, HashMap<String,Object> parameters) Issue an HTTP PUT request.

Method Detail

getRequest

String getRequest(String endpoint,
                  HashMap<String,Object> parameters)
           throws SmartsheetException

Issue an HTTP GET request.

Parameters:

endpoint - the API endpoint

parameters - optional list of resource parameters

Returns:

a JSON response string

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

postRequest

String postRequest(String endpoint,
                   String payload,
                   HashMap<String,Object> parameters)
            throws SmartsheetException

Issue an HTTP POST request.

Parameters:

endpoint - the API endpoint

payload - a JSON payload string

parameters - optional list of resource parameters

Returns:

a JSON response string

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

putRequest

String putRequest(String endpoint,
                  String payload,
                  HashMap<String,Object> parameters)
           throws SmartsheetException

Issue an HTTP PUT request.

Parameters:

endpoint - the API endpoint

payload - a JSON payload string

parameters - optional list of resource parameters

Returns:

a JSON response string

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

deleteRequest

String deleteRequest(String endpoint)
              throws SmartsheetException

Issue an HTTP DELETE request.

Parameters:

endpoint - the API endpoint

Returns:

a JSON response string

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation