smartsheet: appmixer.smartsheet.core.ListColumnsOnSheet

Basic Information

Name

appmixer.smartsheet.core.ListColumnsOnSheet

Version

1.0.0

Visibility

Public

Description

Gets a list of all columns belonging to the sheet specified in the URL.

Input Ports

in

Field	Type	Description
Sheet Id	number	Sheet Id of the sheet being accessed.
Level	number	specifies whether multi-contact data is returned in a backwards-compatible, text format (level=0, default) or as multi-contact data (level=1).

Output Ports

out

Field	Type	Description
Columns		-

Full Metadata

#metadata-viewer { display: none; }{ "version": "1.0.0", "name": "appmixer.smartsheet.core.ListColumnsOnSheet", "author": "Appmixer <info@appmixer.com>", "description": "Gets a list of all columns belonging to the sheet specified in the URL.", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "sheetId" ], "properties": { "sheetId": { "type": "number" }, "level": { "type": "integer", "default": 1 } } }, "inspector": { "inputs": { "sheetId": { "type": "number", "index": 0, "label": "Sheet Id", "tooltip": "<p>Sheet Id of the sheet being accessed.</p>", "source": { "url": "/component/appmixer/smartsheet/core/ListSheets?outPort=out", "data": { "transform": "./ListSheets#sheetsToSelectArray" } } }, "level": { "type": "number", "index": 1, "label": "Level", "tooltip": "<p>specifies whether multi-contact data is returned in a backwards-compatible, text format (level=0, default) or as multi-contact data (level=1).</p>", "defaultValue": 1 } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Columns", "value": "columns", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Column Id.", "example": 12345 }, "index": { "type": "number", "description": "Column index or position. This number is zero-based.", "example": 1 }, "symbol": { "type": "string", "description": "When applicable for **CHECKBOX** or **PICKLIST** column types. See [Symbol Columns](../../tag/columnsRelated#section/Column-Types/Symbol-Columns).", "example": "STAR" }, "title": { "type": "string", "description": "Column title.", "example": "Status" }, "type": { "type": "string", "enum": [ "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER" ], "description": "See [Column Types](../../tag/columnsRelated#section/Column-Types)", "example": "TEXT_NUMBER" }, "validation": { "type": "boolean", "description": "Indicates whether validation has been enabled for the column (value = **true**).", "example": false } } } } } ] } ], "auth": { "service": "appmixer:smartsheet" }, "icon": "data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDEyMzggMTUxNCIgd2lkdGg9IjEyMzgiIGhlaWdodD0iMTUxNCI+Cgk8dGl0bGU+c21hcnRzaGVldC1sb2dvLWJsdWUtbmV3LXN2ZzwvdGl0bGU+Cgk8c3R5bGU+CgkJLnMwIHsgZmlsbDogIzBlMjk0NyB9IAoJPC9zdHlsZT4KCTxnIGlkPSJMYXllciI+CgkJPGcgaWQ9IkxheWVyIj4KCQkJPHBhdGggaWQ9IkxheWVyIiBjbGFzcz0iczAiIGQ9Im02MTUgMTIwNGMwIDAgMjYzLjQtNjU3LjggNjIyLjktMTA5Ni4zIDAgMTgwLjkgMCA1MzkuOSAwIDgxMS4zIDAgMTUwLjctNS41IDI3NC0xMSAzMjguOC01LjUgNTQuOS0xOS4yIDkwLjUtNDEuMSA5Ni0xNi41IDIuNy00My45LTIuOC05Ni4xLTYzLjEtNDYuNi01NC44LTkzLjMtMTU2LjItOTMuMy0xNTYuMmwtNS41LTExLTguMiA4LjNjLTIuNyAwLTE0NS40IDE0Mi41LTUxNS45IDI3NC0yMDguNSA3NC00MTEuNSAxMDkuNy00NjYuNCAxMTcuOSA1LjUtMjEuOSAxNi40LTc2LjggMTYuNC0xNTAuOCAwLTk1LjkgMC0xMjQ2LjkgMC0xMzYyLjFoMTIxNS42Yy0xOTcuNiAxODYuNC00NDEuOCA0NjYtNTg5LjkgNzk0LjgtMTYuNS0zNS42LTEyMy41LTI3NC0yNTgtMjcxLjMtODUgMi44LTE1MC45IDkzLjItMTUwLjkgOTMuMiAyMDguNi0yLjcgMzgxLjQgNTg2LjUgMzgxLjQgNTg2LjV6Ii8+CgkJPC9nPgoJPC9nPgo8L3N2Zz4=" }