1Copy Dataset Relationship

1Copy Dataset Relationship

Overview

This API creates a copy of an existing Dataset Relationship in the specified target folder.

Method: POST

Request URL: {kyvos-url}/rest/v2/dataset-relationships/{name-or-id}/copy


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 the media type of the 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.

–


Path Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Represents the name or ID of the Dataset Relationship to be copied.

Note: If the Dataset Relationship name is provided, then sourceFolderName 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 Dataset Relationship name or Dataset Relationship ID.

If by=name, provide the Dataset Relationship name in the name-or-id parameter.

If by=id, provide the Dataset Relationship ID in the name-or-id parameter.

The default value is name.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

targetDatasetRelationshipName (Required)

String

Name of the new Dataset Relationship to be created as a copy of the selected Dataset Relationship.

–

sourceFolderName

String

Name of the folder containing the source Dataset Relationship. If the Dataset Relationship is present in the root directory, specify [Root].

Note: If sourceFolderName is not provided, the Dataset Relationship will be treated as a root-level entity by default.

–

targetFolderName

String

Name of the destination folder where the copied Dataset Relationship will be created.

Note: If neither targetFolderName nor targetFolderId is provided, the API creates the copied Dataset Relationship in the root directory.

–

targetFolderId

String

ID of the destination folder where the copied Dataset Relationship will be created.

–


Responses

200 Success

{ "code": 0, "message": "Dataset Relationship copied successfully." }

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.


Copyright Kyvos, Inc. 2026. All rights reserved.