Click or drag to resize

HomeResourcesGetHome Method (IEnumerableHomeInclusion, IEnumerableHomeExclusion)

Gets a nested list of all Home objects, including folders, reports, sheets, templates, and workspaces as shown on the Home tab.

Mirrors to the following Smartsheet REST API method: GET /home

Namespace:  Smartsheet.Api
Assemblies:   smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
  smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
Syntax
Copy
Home GetHome(
	IEnumerable<HomeInclusion> includes,
	IEnumerable<HomeExclusion> excludes
)

Parameters

includes
Type: System.Collections.GenericIEnumerableHomeInclusion
used to specify the optional objects to include, currently TEMPLATES is supported.
excludes
Type: System.Collections.GenericIEnumerableHomeExclusion
used to specify the optional object to exclude

Return Value

Type: Home
the resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).
Exceptions
ExceptionCondition
InvalidRequestExceptionif there is any problem with the REST API request
AuthorizationExceptionif there is any problem with the REST API authorization (access token)
InvalidRequestExceptionif the resource cannot be found
ResourceNotFoundExceptionif the REST API service is not available (possibly due to rate limiting)
ServiceUnavailableExceptionif any other REST API related error occurred during the operation
SmartsheetExceptionif any other error occurred during the operation
See Also