FolderResourcesCopyFolder Method

Creates a copy of the specified Folder.

It mirrors to the following Smartsheet REST API method:
POST /folders/{folderId}/copy

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

Folder CopyFolder(
	long folderId,
	ContainerDestination destination,
	IEnumerable<FolderCopyInclusion> include,
	IEnumerable<FolderRemapExclusion> skipRemap
)

Function CopyFolder ( 
	folderId As Long,
	destination As ContainerDestination,
	include As IEnumerable(Of FolderCopyInclusion),
	skipRemap As IEnumerable(Of FolderRemapExclusion)
) As Folder

Folder^ CopyFolder(
	long long folderId, 
	ContainerDestination^ destination, 
	IEnumerable<FolderCopyInclusion>^ include, 
	IEnumerable<FolderRemapExclusion>^ skipRemap
)

abstract CopyFolder : 
        folderId : int64 * 
        destination : ContainerDestination * 
        include : IEnumerable<FolderCopyInclusion> * 
        skipRemap : IEnumerable<FolderRemapExclusion> -> Folder

Parameters

folderId: Type: SystemInt64
the folder Id
destination: Type: Smartsheet.Api.ModelsContainerDestination
the destination to copy to
include: Type: System.Collections.GenericIEnumerableFolderCopyInclusion
the elements to copy. Note: Cell history will not be copied, regardless of which include parameter values are specified.
skipRemap: Type: System.Collections.GenericIEnumerableFolderRemapExclusion
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 Value

Type: Folder
the created folder

Exceptions

Exception	Condition
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

Reference

FolderResources Interface

Smartsheet.Api Namespace

FolderResourcesAddLanguageSpecificTextSet("LST182BB057_0?cpp=::|nu=.");CopyFolder Method

Parameters

Return Value

Reference

FolderResourcesCopyFolder Method