smartsheet: appmixer.smartsheet.core.ListSearchSheet

Basic Information

Name

appmixer.smartsheet.core.ListSearchSheet

Version

1.0.0

Visibility

Public

Description

Gets a list of the user's search results in a sheet based on query. The list contains an abbreviated row object for each search result in a sheet. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later! Newly created or recently updated data may not be immediately discoverable via search.

Input Ports

in

Field	Type	Description
Sheet Id	number	Sheet Id of the sheet being accessed.
Query	text	Text with which to perform the search. Enclose in double-quotes for an exact search.

Output Ports

out

Field	Type	Description
Results		-
Total Count		-

Full Metadata

#metadata-viewer { display: none; }{ "version": "1.0.0", "name": "appmixer.smartsheet.core.ListSearchSheet", "author": "Appmixer <info@appmixer.com>", "description": "Gets a list of the user's search results in a sheet based on query. The list contains an abbreviated row object for each search result in a sheet. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later! Newly created or recently updated data may not be immediately discoverable via search.", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "sheetId", "query" ], "properties": { "sheetId": { "type": "number" }, "query": { "type": "string" } } }, "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" } } }, "query": { "type": "text", "index": 1, "label": "Query", "tooltip": "<p>Text with which to perform the search. Enclose in double-quotes for an exact search.</p>" } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Results", "value": "results", "schema": { "description": "Array of SearchResultItem objects.", "type": "array", "items": { "type": "object", "properties": { "objectId": { "description": "Search result object Id.", "type": "number", "example": 1 }, "parentObjectId": { "description": "Search result parent object Id.", "type": "number", "example": 1 }, "contextData": { "description": "Additional info on search result context.", "type": "array", "items": { "type": "string" } }, "objectType": { "description": "Search result object type (attachment, dashboard, discussion, folder, report, row, sheet, summaryField, template, or workspace).", "type": "string", "example": "ROW" }, "parentObjectName": { "description": "Search result parent object name.", "type": "string", "example": "Project Tracker" }, "parentObjectType": { "description": "Search result parent object type (dashboard, folder, report, sheet, template, or workspace).", "type": "string", "example": "SHEET" }, "proofUrl": { "description": "The proofUrl string will be present in the contextData if the discussion or attachment belongs to a proof.", "type": "string", "example": "https://proof.smartsheet.com/review/abc123" }, "text": { "description": "Search result text excerpt.", "type": "string", "example": "Custom field text" } } } } }, { "label": "Total Count", "value": "totalCount" } ] } ], "auth": { "service": "appmixer:smartsheet" }, "icon": "data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDEyMzggMTUxNCIgd2lkdGg9IjEyMzgiIGhlaWdodD0iMTUxNCI+Cgk8dGl0bGU+c21hcnRzaGVldC1sb2dvLWJsdWUtbmV3LXN2ZzwvdGl0bGU+Cgk8c3R5bGU+CgkJLnMwIHsgZmlsbDogIzBlMjk0NyB9IAoJPC9zdHlsZT4KCTxnIGlkPSJMYXllciI+CgkJPGcgaWQ9IkxheWVyIj4KCQkJPHBhdGggaWQ9IkxheWVyIiBjbGFzcz0iczAiIGQ9Im02MTUgMTIwNGMwIDAgMjYzLjQtNjU3LjggNjIyLjktMTA5Ni4zIDAgMTgwLjkgMCA1MzkuOSAwIDgxMS4zIDAgMTUwLjctNS41IDI3NC0xMSAzMjguOC01LjUgNTQuOS0xOS4yIDkwLjUtNDEuMSA5Ni0xNi41IDIuNy00My45LTIuOC05Ni4xLTYzLjEtNDYuNi01NC44LTkzLjMtMTU2LjItOTMuMy0xNTYuMmwtNS41LTExLTguMiA4LjNjLTIuNyAwLTE0NS40IDE0Mi41LTUxNS45IDI3NC0yMDguNSA3NC00MTEuNSAxMDkuNy00NjYuNCAxMTcuOSA1LjUtMjEuOSAxNi40LTc2LjggMTYuNC0xNTAuOCAwLTk1LjkgMC0xMjQ2LjkgMC0xMzYyLjFoMTIxNS42Yy0xOTcuNiAxODYuNC00NDEuOCA0NjYtNTg5LjkgNzk0LjgtMTYuNS0zNS42LTEyMy41LTI3NC0yNTgtMjcxLjMtODUgMi44LTE1MC45IDkzLjItMTUwLjkgOTMuMiAyMDguNi0yLjcgMzgxLjQgNTg2LjUgMzgxLjQgNTg2LjV6Ii8+CgkJPC9nPgoJPC9nPgo8L3N2Zz4=" }