HomeResourcesGetHome Method (IEnumerableHomeInclusion)

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

C++

Copy

Home GetHome(
	IEnumerable<HomeInclusion> includes
)

Function GetHome ( 
	includes As IEnumerable(Of HomeInclusion)
) As Home

Home^ GetHome(
	IEnumerable<HomeInclusion>^ includes
)

abstract GetHome : 
        includes : IEnumerable<HomeInclusion> -> Home

Parameters

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

Return Value

Type: Home
the resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).

Exceptions

Exception	Condition
InvalidRequestException	if there is any problem with the REST API request
AuthorizationException	if there is any problem with the REST API authorization (access token)
InvalidRequestException	if the resource cannot be found
ResourceNotFoundException	if the REST API service is not available (possibly due to rate limiting)
ServiceUnavailableException	if any other REST API related error occurred during the operation
SmartsheetException	if any other error occurred during the operation

Reference

HomeResources Interface

GetHome Overload

Smartsheet.Api Namespace

HomeResourcesAddLanguageSpecificTextSet("LST4B9F8659_0?cpp=::|nu=.");GetHome Method (IEnumerableAddLanguageSpecificTextSet("LST4B9F8659_1?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");HomeInclusionAddLanguageSpecificTextSet("LST4B9F8659_2?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)");)

Parameters

Return Value

Reference

HomeResourcesGetHome Method (IEnumerableHomeInclusion)