Add and Update Folder List

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 adds or updates the Folder list for the specified entity. It supports the following entities: Semantic Model, Dataset, Dataset Relationship, Workbook, and AI Space. Since this is a bulk operation, you must have import and export privileges to use the API.

Method: POST

Request URL: {kyvos-url}/rest/v2/folders/bulk

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.

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
entityType (Required)	String	Type of entity for which the Folder list needs to be saved.	`RDATASET`, `DATASETRELATIONSHIP`, `SMODEL`, `SPACE`, `WORKBOOK`

Request Body

Parameter Name	Type	Description	Possible Values

Parameter Name

Type

Description

Possible Values

json (Required)

String

JSON configuration of the Folder list to be saved.

Note: An example JSON is provided under the Resources section below.

–

Responses

200 Success

[
  {
    "entityId": "folder_17747861614754127031046140817147",
    "statusCode": "0",
    "message": "Successfully replaced folder: Account folder",
    "extMessage": ""
  },
  {
    "entityId": "folder_17747861123133243703104614081147",
    "statusCode": "0",
    "message": "Successfully replaced folder: Order date",
    "extMessage": ""
  }
]

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 json parameter in the request body.

{
    "folders":[
        {
            "entityType":"WORKBOOK",
            "entitySubType":"",
            "name":"2903Chat Session",
            "id":"folder_17747861614754127031046140817147",
            "privilege":"",
            "userId":"17747858982697127077024127458631",
            "desc":""
        },
        {
            "entityType":"WORKBOOK",
            "entitySubType":"",
            "name":"9770_Curated_Content",
            "id":"folder_9770_curated_content",
            "privilege":"",
            "userId":"31a5cf9e-faa5-451e-9b6d-3307ae01f359",
            "desc":""
        }
    ]
}