smartsheet: appmixer.smartsheet.core.ListSearch

Basic Information

Name

appmixer.smartsheet.core.ListSearch

Version

1.0.0

Visibility

Public

Description

Searches all sheets that the user can access, for the specified text. 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!

Input Ports

in

Field	Type	Description
Query	text	Text with which to perform the search. Enclose in double-quotes for an exact search.
Location	text	When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces.
Include	text	When specified with a value of favoriteFlag, response indicates which returned items are favorites. favorite -- dashboards, folders, reports, sheets, templates, and workspaces will have the property favorite: true parentObjectFavorite -- attachments, discussions, summary fields, and rows will have the property parentObjectFavorite: true
Scopes	textarea	If search fails, try using an array for each type of this comma-separated list of search filters. JSON array. Example: ["sightNames"].

Output Ports

out

Field	Type	Description
Results		-
Total Count		-

Full Metadata

#metadata-viewer { display: none; }{ "version": "1.0.0", "name": "appmixer.smartsheet.core.ListSearch", "author": "Appmixer <info@appmixer.com>", "description": "Searches all sheets that the user can access, for the specified text. 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!", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "query" ], "properties": { "query": { "type": "string" }, "location": { "type": "string", "default": "" }, "modifiedSince": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "readOnly": true }, "include": { "type": "string", "default": "" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "attachments", "cellData", "comments", "folderNames", "reportNames", "sheetNames", "sightNames", "summaryFields", "templateNames", "workspaceNames" ] } } } }, "inspector": { "inputs": { "query": { "type": "text", "index": 0, "label": "Query", "tooltip": "Text with which to perform the search. Enclose in double-quotes for an exact search." }, "location": { "type": "text", "index": 1, "label": "Location", "tooltip": "When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces.", "defaultValue": "" }, "include": { "type": "text", "index": 2, "label": "Include", "tooltip": "When specified with a value of favoriteFlag, response indicates which returned items are favorites. favorite -- dashboards, folders, reports, sheets, templates, and workspaces will have the property favorite: true parentObjectFavorite -- attachments, discussions, summary fields, and rows will have the property parentObjectFavorite: true", "defaultValue": "" }, "scopes": { "type": "textarea", "index": 3, "label": "Scopes", "tooltip": "If search fails, try using an array for each type of this comma-separated list of search filters. JSON array. Example: [\"sightNames\"]." } } } } ], "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=" }