smartsheet: appmixer.smartsheet.core.GetWorkspace

Basic Information

Name

appmixer.smartsheet.core.GetWorkspace

Version

1.0.0

Visibility

Public

Description

Gets a Workspace object.

Input Ports

in

Field	Type	Description
Workspace Id	text	WorkspaceID of the worksheet being accessed.
Access Api Level	number	Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.
Include	multiselect	A list of optional elements to include in the response: source - adds the Source object indicating which object the folder was created from, if any distributionLink ownerInfo sheetVersion permalinks
Load All	toggle	Set to true to see nested folders. A value of false returns top-level folders only.

Output Ports

out

Field	Type	Description
Id		-
Name		-
Access Level		-
Permalink		-

Full Metadata

#metadata-viewer { display: none; }{ "version": "1.0.0", "name": "appmixer.smartsheet.core.GetWorkspace", "author": "Appmixer <info@appmixer.com>", "description": "Gets a Workspace object.", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "workspaceId" ], "properties": { "workspaceId": { "type": "string" }, "accessApiLevel": { "type": "number", "default": 0 }, "include": { "type": [ "array", "string" ] }, "loadAll": { "type": "boolean", "default": false } } }, "inspector": { "inputs": { "workspaceId": { "type": "text", "index": 0, "label": "Workspace Id", "tooltip": "WorkspaceID of the worksheet being accessed.", "source": { "url": "/component/appmixer/smartsheet/core/ListWorkspaces?outPort=out", "data": { "transform": "./ListWorkspaces#workspacesToSelectArray" } } }, "accessApiLevel": { "type": "number", "index": 1, "label": "Access Api Level", "tooltip": "Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.", "defaultValue": 0 }, "include": { "type": "multiselect", "index": 2, "label": "Include", "tooltip": "A list of optional elements to include in the response:\n<ul>\n<li>source - adds the Source object indicating which object the folder\nwas created from, if any</li>\n<li>distributionLink</li>\n<li>ownerInfo</li>\n<li>sheetVersion</li>\n<li>permalinks</li>\n</ul>", "options": [ { "content": "source", "value": "source" }, { "content": "distributionLink", "value": "distributionLink" }, { "content": "ownerInfo", "value": "ownerInfo" }, { "content": "sheetVersion", "value": "sheetVersion" }, { "content": "permalinks", "value": "permalinks" } ] }, "loadAll": { "type": "toggle", "index": 3, "label": "Load All", "tooltip": "Set to true to see nested folders. A value of false returns top-level folders only.", "defaultValue": false } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Id", "value": "id" }, { "label": "Name", "value": "name" }, { "label": "Access Level", "value": "accessLevel" }, { "label": "Permalink", "value": "permalink" } ] } ], "auth": { "service": "appmixer:smartsheet" }, "icon": "data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDEyMzggMTUxNCIgd2lkdGg9IjEyMzgiIGhlaWdodD0iMTUxNCI+Cgk8dGl0bGU+c21hcnRzaGVldC1sb2dvLWJsdWUtbmV3LXN2ZzwvdGl0bGU+Cgk8c3R5bGU+CgkJLnMwIHsgZmlsbDogIzBlMjk0NyB9IAoJPC9zdHlsZT4KCTxnIGlkPSJMYXllciI+CgkJPGcgaWQ9IkxheWVyIj4KCQkJPHBhdGggaWQ9IkxheWVyIiBjbGFzcz0iczAiIGQ9Im02MTUgMTIwNGMwIDAgMjYzLjQtNjU3LjggNjIyLjktMTA5Ni4zIDAgMTgwLjkgMCA1MzkuOSAwIDgxMS4zIDAgMTUwLjctNS41IDI3NC0xMSAzMjguOC01LjUgNTQuOS0xOS4yIDkwLjUtNDEuMSA5Ni0xNi41IDIuNy00My45LTIuOC05Ni4xLTYzLjEtNDYuNi01NC44LTkzLjMtMTU2LjItOTMuMy0xNTYuMmwtNS41LTExLTguMiA4LjNjLTIuNyAwLTE0NS40IDE0Mi41LTUxNS45IDI3NC0yMDguNSA3NC00MTEuNSAxMDkuNy00NjYuNCAxMTcuOSA1LjUtMjEuOSAxNi40LTc2LjggMTYuNC0xNTAuOCAwLTk1LjkgMC0xMjQ2LjkgMC0xMzYyLjFoMTIxNS42Yy0xOTcuNiAxODYuNC00NDEuOCA0NjYtNTg5LjkgNzk0LjgtMTYuNS0zNS42LTEyMy41LTI3NC0yNTgtMjcxLjMtODUgMi44LTE1MC45IDkzLjItMTUwLjkgOTMuMiAyMDguNi0yLjcgMzgxLjQgNTg2LjUgMzgxLjQgNTg2LjV6Ii8+CgkJPC9nPgoJPC9nPgo8L3N2Zz4=" }