1Get Dynamic Fields

Overview

This API retrieves all dynamic group fields associated with a specific Workbook. Additionally, you can provide a unique field ID to retrieve a specific dynamic group field.

Method: GET

Request URL: {kyvos-url}/rest/v2/viewer/{name-or-id}/fetch-dynamic-fields

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 Workbook for which you want to retrieve the dynamic group fields.

Note: If the Workbook 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 a Workbook name or Workbook ID. If by=name, provide the Workbook name in the name-or-id parameter. If by=id, provide the Workbook ID in the name-or-id parameter. The default value is name.	–
folderName	String	Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Workbook will be treated as a root-level entity by default.	–
folderId	String	ID of the folder containing the Workbook.	–
dynamicFieldId	String	ID of the dynamic group field to be retrieved. If not provided, all dynamic group fields associated with the Workbook are returned.	–

Responses

200 Success

{
  "groupFields": [
    {
      "baseFieldInfo": {
        "dimensionId": "DIM_77",
        "name": "OrderPriority (%)",
        "id": "DIMENSION_ATTRIBUTE_168",
        "type": "ATTRIBUTE"
      },
      "semanticModel": {
        "name": "OrderDate_ValueBased",
        "id": "17246636471674127064015165867288",
        "folderName": "Kyvos_NoSpark"
      },
      "dataType": "CHAR",
      "name": "DynamicGroupField_1",
      "action": "",
      "description": "",
      "id": "DYNAMIC_MEMBER_624133",
      "memberGroups": [
        {
          "isCustomName": false,
          "values": {
            "dataSeperator": "|$|",
            "distinct": "Critical|$|High"
          },
          "name": "Critical & High"
        }
      ],
      "type": "LIST",
      "otherGroupLabel": "Others",
      "remainingMembersAsOthers": false,
      "tags": ""
    },
    {
      "baseFieldInfo": {
        "dimensionId": "DIM_11",
        "name": "CustomerID",
        "id": "DIMENSION_ATTRIBUTE_13",
        "type": "ATTRIBUTE"
      },
      "semanticModel": {
        "name": "OrderDate_ValueBased",
        "id": "17246636471674127064015165867288",
        "folderName": "Kyvos_NoSpark"
      },
      "dataType": "CHAR",
      "name": "DynamicGroupField",
      "action": "",
      "description": "",
      "id": "DYNAMIC_MEMBER_613623",
      "memberGroups": [
        {
          "isCustomName": false,
          "values": {
            "dataSeperator": "|$|",
            "distinct": "AA-10315|$|AA-10375|$|AA-10480|$|AA-10645"
          },
          "name": "AA-10315 & AA-10375 & AA-10480 & AA-10645"
        }
      ],
      "type": "LIST",
      "otherGroupLabel": "Others",
      "remainingMembersAsOthers": false,
      "tags": ""
    }
  ]
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	Connection, database, schema, or table not found.
500	Internal Server Error.