1Change Entity and Folder Ownership

Overview

This API changes ownership of entities and folders in Kyvos. It is accessible only to admin users.

Method: POST

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

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
json (Required)	String	JSON string containing the change-owner request.	–

Responses

200 Success

{
  "code": "0",
  "message": "Ownership updated successfully for folders and entities."
}

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

Use Cases

The API supports two common use cases for the json parameter in the request body:

USER_BASED
ENTITY_BASED

Example JSON — USER_BASED

{
  "usecase": "USER_BASED",
  "newOwner": {
    "name": "kyvos.user"
  },
  "entityTypes": [
    {
      "entityType": "DRD_OBJECT"
    }
  ],
  "currentOwners": [
    {
      "name": "bi admin"
    }
  ]
}

JSON Fields Definitions

Field	Type	Description	Possible Values	Example

Field	Type	Description	Possible Values	Example
`usecase`	String	The use case type that determines how ownership is changed	`"USER_BASED"`, `"ENTITY_BASED"`	`"USER_BASED"`
`newOwner`	Array<Object>	The new owner details.	—	`[{ "name": "kyvos.user" }]`
`newOwner[].name`	String	Name of the new owner who will receive ownersh.	Any valid system user name	`"kyvos.user"`
`entityTypes[].entitySubType`	String	Entity sub-type filter (optional). `SMODEL` is normalized to `CUBE`	`"DASHBOARD"`, `"SHEET"`, `"CUBE"`	`"SHEET"`
`currentOwners`	Array<Object>	List of current owners whose entities should be reassigned to the new owner. Cannot be empty	—	`[{ "name": "bi admin" }]`
`currentOwners[].name`	String	Name of the current owner whose entities should be reassigned	Any valid system user name	`"bi admin"`

Example JSON — ENTITY_BASED

{
  "usecase": "ENTITY_BASED",
  "newOwner": {
    "name": "kyvos.user"
  },
  "entities": [
    {
      "entityType": "ANALYTICAL",
      "entitySubType": "CUBE",
      "id": "110705"
    },
    {
      "entityType": "WORKBOOK",
      "name": "Sales Workbook",
      "folderName": "Reports/Sales"
    }
  ]
}

JSON Field Definitions

Field	Type	Description	Possible Values	Example

Field	Type	Description	Possible Values	Example
`usecase`	String	The use case type that determines how ownership is changed	`"USER_BASED"`, `"ENTITY_BASED"`	`"ENTITY_BASED"`
`newOwner`	Array<Object>	The new owner details.	—	`[{ "name": "kyvos.user" }]`
`newOwner[].name`	String	Name of the new owner who will receive ownersh.	Any valid system user name	`"kyvos.user"`
`entities[].entityType`	String	Entity type of the specific entity	`"QUERY"` (or `"DATASET"` — normalized to `"QUERY"`), `"ANALYTICAL"`, `"WORKBOOK"`, `"WORKSHEET"`, `"CONNECTION"`, `"SPACE"`, `"DRD_OBJECT"`, `"FOLDER"`	`"ANALYTICAL"`
`entities[].entitySubType`	String	Entity sub-type. `SMODEL` is normalized to `CUBE`. `ANALYTICAL` entityType defaults to `CUBE`	`"CUBE"`, `"SMODEL"`, `"RDATASET"`, `"TRANSFORMATION"`, `"REGISTERED"`, `"DASHBOARD"`, `"SHEET"`, `"SPACE"`	`"CUBE"`
`entities[].name`	String	Entity name. If `id` is not provided, this is required	Any valid entity name	`"Sales Workbook"`
`entities[].folderId`	String	Folder ID where the entity resides. Required when `id` is not provided (for non-FOLDER entities)	Any valid folder ID	`"67890"`
`entities[].folderName`	String	Folder name where the entity resides. Required when `id` is not provided (for non-FOLDER entities)	Any valid folder name	`"Reports/Sales"`
`entities[].folderEntityType`	String	Required when `entityType` is `"FOLDER"` and `id` is not provided. Specifies the type of entities inside the folder	`"QUERY"` (or `"DATASET"`), `"ANALYTICAL"`, `"WORKBOOK"`, `"WORKSHEET"`, `"SPACE"`	`"ANALYTICAL"`
`entities[].folderEntitySubType`	String	Sub-type for entities inside the folder. `SMODEL` is normalized to `CUBE`. `ANALYTICAL` folderEntityType defaults to `CUBE`	`"CUBE"`, `"SMODEL"`, `"RDATASET"`, `"TRANSFORMATION"`, `"REGISTERED"`, `"DASHBOARD"`, `"SHEET"`, `"SPACE"`	`"CUBE"`