C# Class Smartsheet.Api.Internal.WorkspaceResourcesImpl

This is the implementation of the WorkspaceResources. Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.
Inheritance: AbstractResources, WorkspaceResources
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method Description
CopyWorkspace ( long workspaceId, ContainerDestination destination, IEnumerable include, IEnumerable skipRemap ) : Api.Models.Workspace

Creates a copy of the specified Workspace.

It mirrors To the following Smartsheet REST API method:
POST /workspaces/{workspaceId}/copy
CreateWorkspace ( Api.Models.Workspace workspace ) : Api.Models.Workspace

Create a workspace.

It mirrors To the following Smartsheet REST API method: POST /Workspaces
DeleteWorkspace ( long workspaceId ) : void

Deletes the specified Workspace (and its contents).

It mirrors To the following Smartsheet REST API method: DELETE /workspaces{workspaceId}
GetWorkspace ( long workspaceId, bool loadAll, IEnumerable include ) : Api.Models.Workspace

Gets the specified Workspace (and lists its contents).

It mirrors To the following Smartsheet REST API method: GET /workspaces/{workspaceid}

By default, this operation only returns the top-level items in the Workspace. To load all of the contents, including nested Folders, include the loadAll query string parameter with a value of true.

If no Folders, Sheets, Reports, or Templates are present in the Workspace, the corresponding attribute (e.g., "folders", "sheets") will not be present in the response object.
ListWorkspaces ( PaginationParameters paging ) : PaginatedResult

List all Workspaces.

It mirrors To the following Smartsheet REST API method: GET /Workspaces

This operation supports pagination of results. For more information, see Paging.
UpdateWorkspace ( Api.Models.Workspace workspace ) : Api.Models.Workspace

Update a workspace.

It mirrors To the following Smartsheet REST API method: PUT /workspaces/{workspaceId}
WorkspaceResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic

Constructor. Exceptions: - IllegalArgumentException : if any argument is

Method Details

CopyWorkspace() public method

Creates a copy of the specified Workspace.

It mirrors To the following Smartsheet REST API method:
POST /workspaces/{workspaceId}/copy

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public CopyWorkspace ( long workspaceId, ContainerDestination destination, IEnumerable include, IEnumerable skipRemap ) : Api.Models.Workspace
workspaceId long the workspace Id
destination Smartsheet.Api.Models.ContainerDestination the destination to copy to
include IEnumerable the elements to copy. Note: Cell history will not be copied, regardless of which include parameter values are specified.
skipRemap IEnumerable the references to NOT re-map for the newly created folder /// /// If "cellLinks" is specified in the skipRemap parameter value, the cell links within the newly created folder will continue to point to the original source sheets. /// If "reports" is specified in the skipRemap parameter value, the reports within the newly created folder will continue to point to the original source sheets. /// ///
return Api.Models.Workspace

CreateWorkspace() public method

Create a workspace.

It mirrors To the following Smartsheet REST API method: POST /Workspaces

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public CreateWorkspace ( Api.Models.Workspace workspace ) : Api.Models.Workspace
workspace Api.Models.Workspace the workspace To create
return Api.Models.Workspace

DeleteWorkspace() public method

Deletes the specified Workspace (and its contents).

It mirrors To the following Smartsheet REST API method: DELETE /workspaces{workspaceId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public DeleteWorkspace ( long workspaceId ) : void
workspaceId long the Id of the workspace
return void

GetWorkspace() public method

Gets the specified Workspace (and lists its contents).

It mirrors To the following Smartsheet REST API method: GET /workspaces/{workspaceid}

By default, this operation only returns the top-level items in the Workspace. To load all of the contents, including nested Folders, include the loadAll query string parameter with a value of true.

If no Folders, Sheets, Reports, or Templates are present in the Workspace, the corresponding attribute (e.g., "folders", "sheets") will not be present in the response object.
if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public GetWorkspace ( long workspaceId, bool loadAll, IEnumerable include ) : Api.Models.Workspace
workspaceId long the workspace id
loadAll bool Defaults to false. If true, loads all of the contents, including nested Folders.
include IEnumerable When specified with a value of "source", response will include the source for any sheet that was created from another sheet or template
return Api.Models.Workspace

ListWorkspaces() public method

List all Workspaces.

It mirrors To the following Smartsheet REST API method: GET /Workspaces

This operation supports pagination of results. For more information, see Paging.
if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public ListWorkspaces ( PaginationParameters paging ) : PaginatedResult
paging Smartsheet.Api.Models.PaginationParameters
return PaginatedResult

UpdateWorkspace() public method

Update a workspace.

It mirrors To the following Smartsheet REST API method: PUT /workspaces/{workspaceId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public UpdateWorkspace ( Api.Models.Workspace workspace ) : Api.Models.Workspace
workspace Api.Models.Workspace the workspace To update
return Api.Models.Workspace

WorkspaceResourcesImpl() public method

Constructor. Exceptions: - IllegalArgumentException : if any argument is
public WorkspaceResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic
smartsheet SmartsheetImpl the Smartsheet
return System.Collections.Generic