1Search Entities

Overview

This API searches for entities in Kyvos based on specified criteria such as entity name, type, subtype, description, etc.

Method: POST

Request URL: {kyvos-url}/rest/v2/entities/search

Authorization

API Key: `sessionid`

This method authenticates requests using a session ID which acts like an API key.

BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.

Headers

Header Name	Type	Description	Possible Values

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies media type of request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

Request Body

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
filterJson (Required)	String	JSON array of filter objects. Each object contains fieldName and value keys. Must be a non-empty JSON array. Note: An example JSON is provided under the Resources section below.	–
fetchProcessedStatus	Boolean	When true, includes the processed status of entities in the response.	true/false Default: false
queryableModelsOnly	Boolean	When true, returns only processed Semantic Models (Semantic Models that can be queried).	true/false Default: false
maxRows	String	Maximum number of rows to return in the search results. Must be a valid integer value.	Default: 500
lastEntityId	String	Entity ID used as a cursor for pagination. Returns entities after this entity ID.	–
lastEntityName	String	Entity name used as a cursor for pagination. Returns entities after this entity name.	–
modelType	String	Filters results by model type.	–

Responses

200 Success

{
    "iros": [
        {
            "businessContext": "",
            "description": "",
            "modelType": "BASE",
            "ownerId": "399638300",
            "type": "ANALYTICAL",
            "categoryName": "Account",
            "lastModifiedTimestamp": "1784783836773",
            "folderId": "folder_17847823627396127030036167728010",
            "supportedQueryingLanguage": "",
            "tags": "",
            "isPhysicalViewDifferent": false,
            "entityState": "ACTIVE",
            "isEmbeddingAvailable": false,
            "name": "Account",
            "queryingContext": "",
            "subType": "CUBE",
            "accessRights": "1",
            "id": "17847823979721127054077114290822",
            "folderName": "Account",
            "categoryId": "folder_17847823627396127030036167728010",
            "allowRawDataQuery": true
        },
        {
            "businessContext": "",
            "description": "",
            "modelType": "BASE",
            "ownerId": "154854259",
            "type": "ANALYTICAL",
            "categoryName": "Product",
            "lastModifiedTimestamp": "1787127984391",
            "folderId": "folder_17561091437514127040021190437024",
            "supportedQueryingLanguage": "",
            "tags": "",
            "isPhysicalViewDifferent": false,
            "entityState": "ACTIVE",
            "isEmbeddingAvailable": false,
            "name": "Product Date",
            "queryingContext": "",
            "subType": "CUBE",
            "accessRights": "1",
            "id": "17568053499514127095046179629153",
            "folderName": "Product",
            "categoryId": "folder_17561091437514127040021190437024",
            "allowRawDataQuery": true
        },
        {
            "businessContext": "",
            "description": "",
            "modelType": "BASE",
            "ownerId": "320755803",
            "type": "ANALYTICAL",
            "categoryName": "Order",
            "lastModifiedTimestamp": "1775913269623",
            "folderId": "folder_17120439416741127014045198976661",
            "supportedQueryingLanguage": "",
            "tags": "",
            "isPhysicalViewDifferent": false,
            "entityState": "ACTIVE",
            "isEmbeddingAvailable": false,
            "name": "Order value",
            "queryingContext": "",
            "subType": "CUBE",
            "accessRights": "1",
            "id": "17391885424684127034021163589511",
            "folderName": "Order",
            "categoryId": "folder_17120439416741127014045198976661",
            "allowRawDataQuery": true
        }
    ]
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
412	Precondition failed. Parameter missing.
500	Internal Server Error

Resources

Below is an example of JSON structure which can be used as a reference for the filterJson parameter in the request body.

[ 
  { 
    "fieldName": "entityType", 
    "value": "CUBE" 
  }, 

  { 
    "fieldName": "folderName", 
    "value": "folderName", 
    "operation": "INLIST" 
  }, 

  { 
    "fieldName": "name", 
    "value": "name", 
    "operation": "CONTAINSIGNORECASE" 
  }, 

  { 
    "fieldName": "description", 
    "value": "description", 
    "operation": "CONTAINSIGNORECASE" 
  } 

]