smartsheet: appmixer.smartsheet.core.CopySheet

Basic Information

Name

appmixer.smartsheet.core.CopySheet

Version

1.0.0

Visibility

Public

Description

Creates a copy of the specified sheet.

Input Ports

in

Field	Type	Description
Sheet Id	number	Sheet Id of the sheet being accessed.
Include	multiselect	A comma-separated list of elements to copy: attachments cellLinks - includes cross-sheet references data - includes formatting discussions - includes comments filters forms ruleRecipients -- includes notification recipients, must also include rules when using this attribute rules -- includes notifications and workflow rules shares \| NOTE: Cell history is not copied, regardless of which include parameter values are specified.
Exclude	select	When specified with a value of sheetHyperlinks, excludes this category from the response
Destination Type	select	Type of the destination container.
Destination Id	number	Folder Id where you can create sheets, sights, reports, templates, and other folders.
Destination Id	number	Workspace Id where you can create sheets, sights, reports, templates, and other folders.
New Name	text	Name of the newly created object (when creating a copy of a dashboard, folder, sheet, or workspace). This attribute is not supported for "move" operations.

Output Ports

out

Field	Type	Description
Version		-
Failed Items		-
Message		-
Result Code		-
Result		-
Result Id		-
Result Access Level		-
Result Name		-
Result Permalink		-

Full Metadata

#metadata-viewer { display: none; }{ "version": "1.0.0", "name": "appmixer.smartsheet.core.CopySheet", "author": "Appmixer <info@appmixer.com>", "description": "Creates a copy of the specified sheet.", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "sheetId" ], "properties": { "sheetId": { "type": "number" }, "include": { "type": [ "array", "string" ] }, "exclude": { "type": "string", "enum": [ "sheetHyperlinks" ] }, "destinationFolderId": { "type": "number" }, "destinationWorkspaceId": { "type": "number" }, "destinationType": { "type": "string", "enum": [ "folder", "workspace", "home" ] }, "newName": { "description": "Name of the newly created object (when creating a copy of a dashboard, folder, sheet, or workspace). This attribute is not supported for \"move\" operations.", "type": "string", "path": "newName" } } }, "inspector": { "inputs": { "sheetId": { "type": "number", "index": 0, "label": "Sheet Id", "tooltip": "Sheet Id of the sheet being accessed.", "source": { "url": "/component/appmixer/smartsheet/core/ListSheets?outPort=out", "data": { "transform": "./ListSheets#sheetsToSelectArray" } } }, "include": { "type": "multiselect", "index": 2, "label": "Include", "tooltip": "A comma-separated list of elements to copy:\n<ul>\n<li>attachments</li>\n<li>cellLinks - includes cross-sheet references</li>\n<li>data - includes formatting</li>\n<li>discussions - includes comments</li>\n<li>filters</li>\n<li>forms</li>\n<li>ruleRecipients -- includes notification recipients, must also include\nrules when using this attribute</li>\n<li>rules -- includes notifications and workflow rules</li>\n<li>shares |\nNOTE: Cell history is not copied, regardless of which include parameter values are specified.</li>\n</ul>", "options": [ { "content": "attachments", "value": "attachments" }, { "content": "cellLinks", "value": "cellLinks" }, { "content": "data", "value": "data" }, { "content": "discussions", "value": "discussions" }, { "content": "filters", "value": "filters" }, { "content": "forms", "value": "forms" }, { "content": "ruleRecipients", "value": "ruleRecipients" }, { "content": "rules", "value": "rules" }, { "content": "shares", "value": "shares" } ] }, "exclude": { "type": "select", "index": 3, "label": "Exclude", "tooltip": "When specified with a value of sheetHyperlinks, excludes this category from the response", "options": [ { "content": "sheetHyperlinks", "value": "sheetHyperlinks" } ] }, "destinationType": { "type": "select", "index": 5, "label": "Destination Type", "tooltip": "Type of the destination container.", "options": [ { "content": "Folder", "value": "folder" }, { "content": "home", "value": "home" }, { "content": "Workspace", "value": "workspace" } ] }, "destinationFolderId": { "when": { "eq": { "destinationType": "folder" } }, "type": "number", "index": 6, "label": "Destination Id", "tooltip": "Folder Id where you can create sheets, sights, reports, templates, and other folders.", "source": { "url": "/component/appmixer/smartsheet/core/ListHomeFolders?outPort=out", "data": { "transform": "./ListHomeFolders#foldersToSelectArray" } } }, "destinationWorkspaceId": { "when": { "eq": { "destinationType": "workspace" } }, "type": "number", "index": 7, "label": "Destination Id", "tooltip": "Workspace Id where you can create sheets, sights, reports, templates, and other folders.", "source": { "url": "/component/appmixer/smartsheet/core/ListWorkspaces?outPort=out", "data": { "transform": "./ListWorkspaces#workspacesToSelectArray" } } }, "newName": { "type": "text", "index": 6, "label": "New Name", "tooltip": "Name of the newly created object (when creating a copy of a dashboard, folder, sheet, or workspace). This attribute is not supported for \"move\" operations." } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Version", "value": "version" }, { "label": "Failed Items", "value": "failedItems", "schema": { "description": "Array of BulkItemFailure objects which represents the items that failed to be added or updated. See [Partial Success](/partial-success) for more information. Applicable only for bulk operations that support partial success.", "type": "array", "nullable": true, "items": { "type": "object", "properties": { "rowId": { "description": "The Id of the row that failed. Applicable only to bulk row operations.", "type": "number", "nullable": true, "example": 1 }, "error": { "description": "The error caused by the failed item.", "type": "object", "properties": { "refId": { "description": "The Id of the specific error occurrence. Please include this information when contacting Smartsheet support.", "type": "string", "example": "abc123def456" }, "errorCode": { "description": "Custom error code from Smartsheet. See the complete [Error Code List](../#section/Error-Code-List).", "type": "number", "example": 1 }, "message": { "description": "Descriptive error message.", "type": "string", "example": "The row was not found." } } }, "index": { "description": "The index of the failed item in the bulk request array.", "type": "number", "example": 1 } } } } }, { "label": "Message", "value": "message" }, { "label": "Result Code", "value": "resultCode" }, { "label": "Result", "value": "result" }, { "label": "Result Id", "value": "result.id" }, { "label": "Result Access Level", "value": "result.accessLevel" }, { "label": "Result Name", "value": "result.name" }, { "label": "Result Permalink", "value": "result.permalink" } ] } ], "auth": { "service": "appmixer:smartsheet" }, "icon": "data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDEyMzggMTUxNCIgd2lkdGg9IjEyMzgiIGhlaWdodD0iMTUxNCI+Cgk8dGl0bGU+c21hcnRzaGVldC1sb2dvLWJsdWUtbmV3LXN2ZzwvdGl0bGU+Cgk8c3R5bGU+CgkJLnMwIHsgZmlsbDogIzBlMjk0NyB9IAoJPC9zdHlsZT4KCTxnIGlkPSJMYXllciI+CgkJPGcgaWQ9IkxheWVyIj4KCQkJPHBhdGggaWQ9IkxheWVyIiBjbGFzcz0iczAiIGQ9Im02MTUgMTIwNGMwIDAgMjYzLjQtNjU3LjggNjIyLjktMTA5Ni4zIDAgMTgwLjkgMCA1MzkuOSAwIDgxMS4zIDAgMTUwLjctNS41IDI3NC0xMSAzMjguOC01LjUgNTQuOS0xOS4yIDkwLjUtNDEuMSA5Ni0xNi41IDIuNy00My45LTIuOC05Ni4xLTYzLjEtNDYuNi01NC44LTkzLjMtMTU2LjItOTMuMy0xNTYuMmwtNS41LTExLTguMiA4LjNjLTIuNyAwLTE0NS40IDE0Mi41LTUxNS45IDI3NC0yMDguNSA3NC00MTEuNSAxMDkuNy00NjYuNCAxMTcuOSA1LjUtMjEuOSAxNi40LTc2LjggMTYuNC0xNTAuOCAwLTk1LjkgMC0xMjQ2LjkgMC0xMzYyLjFoMTIxNS42Yy0xOTcuNiAxODYuNC00NDEuOCA0NjYtNTg5LjkgNzk0LjgtMTYuNS0zNS42LTEyMy41LTI3NC0yNTgtMjcxLjMtODUgMi44LTE1MC45IDkzLjItMTUwLjkgOTMuMiAyMDguNi0yLjcgMzgxLjQgNTg2LjUgMzgxLjQgNTg2LjV6Ii8+CgkJPC9nPgoJPC9nPgo8L3N2Zz4=" }