1Validate Dataset Relationship
Overview
This API is used to validate Dataset Relationship.
Method: POST
Request URL: {kyvos-url}/rest/v2/dataset-relationships/{name-or-id}/validate
Authorization
API Key: sessionId
This method authenticates requests using a sessionId 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 | Specifies the media type of 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 Dataset Relationship. Note: If the Dataset Relationship name is provided, then folderName must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Dataset Relationship name or a 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. | – |
Form Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Dataset Relationship. | – |
json | JSON Object | JSON definition of the Dataset Relationship to validate. Note: An example JSON is provided under the resources section below. | – |
Responses
200 Success (Valid Relationship)
{
"code": 0,
"message": "Dataset Relationship validated successfully",
"validationStatus": "VALID"
}200 Success (Invalid Relationship)
{
"code": 0,
"message": "Dataset Relationship is invalid",
"validationStatus": "INVALID",
"validationResult": {
"name": "Account",
"id": "17781501170349127097085168835064",
"hasError": true,
"type": "DRD_OBJECT",
"problems": [
{
"problemFunctionalType": "DEFAULT",
"objects": [
{
"name": "Account",
"id": "17778956085863127034012164369951_0"
}
],
"stackTrace": {
"reason": [
{
"isExists": false,
"isEncoded": false,
"id": "17778956085863127034012164369951",
"message": "Dataset for node Account does not exist.",
"object": "OTHERS"
}
]
},
"type": "ERROR"
}
]
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
Resources
JSON Example of a Dataset Relationship API request body object.