Get Properties

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

Overview

This API retrieves properties of an entity.

Method: GET

Request URL: {kyvos-url}/rest/v2/properties/{name-or-id}

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

sessionid

String

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

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

–

Path Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the entity whose properties need to be retrieved.

Note: If the entity name is provided, then either folderName or folderId must also be provided.

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
by	String	Specifies whether the name-or-id parameter should be interpreted as an entity name or entity ID. If by=name, provide the entity name in the name-or-id parameter. If by=id, provide the entity ID in the name-or-id parameter. The default value is name.	–
folderName	String	Name of the folder containing the entity. If the entity is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the entity will be treated as a root-level entity by default.	–
folderId	String	ID of the folder containing the entity.	–
entityType (Required)	String	Type of the entity whose properties need to be retrieved.	`RDATASET`, `SMODEL`

Responses

200 Success

{
  "entities": [
    {
      "entityPropsValues": {
        "property": [
          {
            "mode": "MANUAL",
            "name": "kyvos.query.shuffle.mode",
            "value": "NEVER"
          },
          {
            "mode": "MANUAL",
            "name": "kyvos.build.aggregate.storage.optimized",
            "value": "true"
          }
        ]
      },
      "subType": "CUBE",
      "id": "17697719898192127042034193524567",
      "type": "ANALYTICAL"
    }
  ]
}

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.