Table of Contents

Interface WorkspaceFolderResources

Namespace
Smartsheet.Api
Assembly
smartsheet-csharp-sdk.dll

This interface provides methods to access Folder resources that are associated to a workspace object.

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

public interface WorkspaceFolderResources

Methods

CreateFolder(long, Folder)

Create a folder in the workspace.

It mirrors to the following Smartsheet REST API method: POST /workspaces/{workspaceId}/Folders

Folder CreateFolder(long workspaceId, Folder folder)

Parameters

workspaceId long

the workspace Id

folder Folder

the folder to create

Returns

Folder

the created folder

Exceptions

InvalidOperationException

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

ListFolders(long, PaginationParameters?)

List Folders of a given workspace.

It mirrors to the following Smartsheet REST API method: GET /workspaces/{workspaceId}/Folders

PaginatedResult<Folder> ListFolders(long workspaceId, PaginationParameters? paging = null)

Parameters

workspaceId long

the workspace Id

paging PaginationParameters

the pagination information

Returns

PaginatedResult<Folder>

the list of Folders (note that an empty list will be returned if no child folder is found), limited to the following attributes:

  • id
  • name
  • permalink

Exceptions

InvalidOperationException

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