Member Column Search
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API is used to fetch member column details of a level or attribute from a Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/members-column-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 |
|---|---|---|---|
Content-Type (Required) | String | Specify media type of the request body. |
|
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 |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Semantic Model from which the member column details are to be retrieved. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
membersJson (Required) | String | JSON with details of Semantic Model and the member details that needs to be fetched. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"semanticModelName": "AdventureWorksMF",
"semanticModelId": "16781127519540127041056199890401",
"semanticModelFolderName": "restapifolder",
"dimensionsInfo": [
{
"membersInfo": [
{
"memberKeyValue": "2",
"memberDisplayValue": "Assets",
"memberLevelName": "L02"
},
{
"memberKeyValue": "1",
"memberDisplayValue": "Assets New",
"memberLevelName": "L01"
},
{
"memberKeyValue": "4",
"memberDisplayValue": "Assets Old",
"memberLevelName": "L04"
}
],
"hierarchyName": "H_Account-CR",
"dimensionName": "Account-CR"
}
]
}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 membersJson parameter in the request body.
{
"semanticModelName":"AdventureWorksMF",
"semanticModelId":"16781127519540127041056199890401",
"semanticModelFolderName":"restapifolder",
"dimensionsInfo":[
{
"dimensionName":"Account-CR",
"hierarchyName":"H_Account-CR",
"membersInfo":[
{
"memberKeyValue":"2",
"memberDisplayValue":"Assets"
},
{
"memberKeyValue":"1",
"memberDisplayValue":"Assets New"
},
{
"memberKeyValue":"4",
"memberDisplayValue":"Assets Old"
}
]
}
]
}JSON Field Definitions
Field | Type | Description | Possible Values | Example |
semanticModelName | string | The name of the semantic model to search in. Required if semanticModelId is not given. | Any valid semantic model name. | "AdventureWorksMF" |
semanticModelId | string | The ID of the semantic model to search in. Required if semanticModelName is not given. | Any valid semantic model ID. | "" |
semanticModelFolderName | string | The folder name containing the semantic model. Optional, recommended if semanticModelId is not provided. | Any valid folder name. | "Kyvos_DataAccuracyCubes" |
dimensionsInfo | array | A list of dimensions/hierarchies to search inside. Required. | One object per dimension. | [{...}] |
dimensionsInfo[*].dimensionName | string | The name of the dimension to search in. Required. | Any valid dimension name. | "Account-CR" |
dimensionsInfo[*].hierarchyName | string | The name of the hierarchy to search in. Required. | Any valid hierarchy name. | "H_Account-CR" |
dimensionsInfo[*].membersInfo | array | The list of members whose details are to be retireved. Required. | One object per member. | [{...}, {...}] |
dimensionsInfo[*].membersInfo[*].memberKeyValue | string | The key value (technical/internal value) of the member. Required. | Any string or number represented as a string. | "2" |
dimensionsInfo[*].membersInfo[*].memberDisplayValue | string | The display value (label) of the member. Required. | Any text. | "Assets" |