/
Search Entities REST API Use Cases

Search Entities REST API Use Cases

In Entity Search API there can be multiple cases below are some sample use cases that user may encounter:

Case 1: To search a semantic model with the name “Business Catalog”, provide the following JSON

[ { "fieldName": "entityType", "value": "SMODEL" }, { "fieldName": "name", "value": "Order Date" } ] Which will give following response: { "IROS": { "IRO": [ { "ACCESSRIGHTS": 1, "FOLDER_NAME": "Prakhar", "OWNERID": 261457523, "LAST_MODIFIED_TIMESTAMP": 1718177710648, "FOLDER_ID": "folder_16565937926485127092077130330265", "ID": 16570220603099127066018164857210, "TYPE": "SMODEL", "NAME": "LOCAL_Order Date" }, { "ACCESSRIGHTS": 1, "FOLDER_NAME": "Prakhar", "OWNERID": 261457523, "LAST_MODIFIED_TIMESTAMP": 1657023354166, "FOLDER_ID": "folder_16565937926485127092077130330265", "ID": 16570232273366127065031119718986, "TYPE": "SMODEL", "NAME": "LOCAL_Order Date_Calculated" } ]}

Case 2: To search a semantic model with the name “Business Catalog” including the job status, pass fetchProcessedStatus as true and provide the following JSON:

[ { "fieldName": "entityType", "value": "SMODEL" }, { "fieldName": "name", "value": "Order Date" } ]   Which will give following response:   { "IROS": { "IRO": [ { "ACCESSRIGHTS": 1, "FOLDER_NAME": "Prakhar", "LAST_BUILD_STATUS": "SUCCESSFUL", "OWNERID": 261457523, "LAST_MODIFIED_TIMESTAMP": 1718177710648, "FOLDER_ID": "folder_16565937926485127092077130330265", "ID": 16570220603099127066018164857210, "TYPE": "SMODEL", "BUILD_STATUS": "COMPLETED", "NAME": "LOCAL_Order Date" }, { "ACCESSRIGHTS": 1, "FOLDER_NAME": "Prakhar", "LAST_BUILD_STATUS": "SUCCESSFUL", "OWNERID": 261457523, "LAST_MODIFIED_TIMESTAMP": 1657023354166, "FOLDER_ID": "folder_16565937926485127092077130330265", "ID": 16570232273366127065031119718986, "TYPE": "SMODEL", "BUILD_STATUS": "COMPLETED", "NAME": "LOCAL_Order Date_Calculated" } ] }

Case 3: To search a semantic model with the name “Business Catalog”, but only those that are queryable, pass queryableModelsOnly as true.

Case 4: To list all worksheets from Kyvos with the name “FinancialYear”, provide the following JSON.

[ { "fieldName": "entityType", "value": "WORKSHEET" }, { "fieldName": "name", "value": "SwitchCase2AllParamCase" } ] Which will give following response: { "IROS": { "IRO": { "ACCESSRIGHTS": 1, "OWNERID": 258778844, "FOLDER_ID": "folder_17482371099058127040089196799444", "LAST_MODIFIED": "05/27/2025 10:22:21 IST", "WORKBOOK_ID": 17482371125088127078079155298628, "DESC": "This WS, is for test", "NAME": "SwitchCase2AllParamCase", "VIZ_TYPE": "CROSSTAB", "OWNER": "sanchit.agnihotri", "FOLDER_NAME": "Sanchit", "LAST_MODIFIED_TIMESTAMP": 1748321541497, "ID": "Sheet17482371585734127028041191871871", "TYPE": "SHEET" } } }

Case 5: To list all worksheet with the name “Financial Year” but only those worksheets that have description as “DESC value”, provide the following JSON.

[ { "fieldName": "entityType", "value": "WORKSHEET" }, { "fieldName": "name", "value": "SwitchCase" }, { "fieldName":"description", "value":"This WS", "relation":"OR", "startEnclosure":"(" }, { "fieldName":"vizType", "value":"CROSSTAB", "relation":"AND", "endEnclosure":")" } ]

 

Copyright Kyvos, Inc. 2026. All rights reserved.