smartsheet: appmixer.smartsheet.core.MoveSheet

Basic Information

Name

appmixer.smartsheet.core.MoveSheet

Version

1.0.0

Visibility

Public

Description

Moves the specified sheet to a new location. When a sheet that is shared to one or more users and/or groups is moved into or out of a workspace, those sheet-level shares are preserved.

Input Ports

in

Field	Type	Description
Sheet Id	number	Sheet Id of the sheet being accessed.
Destination Id	number	The Id of the destination container (when copying or moving a sheet or a folder). Required if destinationType is "folder" or "workspace". If destinationType is "home", this value must be null.
Destination Type	select	Type of the destination container.

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.MoveSheet", "author": "Appmixer <info@appmixer.com>", "description": "Moves the specified sheet to a new location.\nWhen a sheet that is shared to one or more users and/or groups is moved into or out of a workspace, those sheet-level shares are preserved.", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "sheetId" ], "properties": { "sheetId": { "type": "number" }, "destinationId": { "description": "The Id of the destination container (when copying or moving a sheet or a folder). Required if destinationType is \"folder\" or \"workspace\". If destinationType is \"home\", this value must be null.", "type": "number", "path": "destinationId" }, "destinationType": { "description": "Type of the destination container.", "type": "string", "nullable": true, "enum": [ "folder", "home", "workspace" ], "path": "destinationType" } } }, "inspector": { "inputs": { "sheetId": { "type": "number", "index": 0, "label": "Sheet Id", "tooltip": "Sheet Id of the sheet being accessed." }, "destinationId": { "type": "number", "index": 2, "label": "Destination Id", "tooltip": "The Id of the destination container (when copying or moving a sheet or a folder). Required if destinationType is \"folder\" or \"workspace\". If destinationType is \"home\", this value must be null." }, "destinationType": { "type": "select", "index": 3, "label": "Destination Type", "tooltip": "Type of the destination container.", "options": [ { "content": "folder", "value": "folder" }, { "content": "home", "value": "home" }, { "content": "workspace", "value": "workspace" } ] } } } } ], "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=" }