Get Dataset Relationship
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves the specified Dataset Relationship object.
Method: GET
Request URL: {kyvos-url}/rest/v2/dataset-relationships/{name-or-id}
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 |
|---|---|---|---|
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 which you want to retrieve. Note: If the Dataset Relationship name is provided, then either folderName or folderId 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. | – |
folderName | String | Name of the folder from which you want to retrieve the Dataset Relationship. If the Dataset Relationship is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Dataset Relationship will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder from which you want to retrieve the Dataset Relationship. | – |
Responses
200 Success
{
"iro":{
"entityRepositDate":"",
"ownerAppId":"351003706",
"linkedEntityId":"",
"type":"DRD_OBJECT",
"specific":{
"drdObject":{
"layout":{
"nodes":[
{
"top":"24",
"left":"395",
"width":"200",
"id":"14697760002691127040031128139982_4",
"collapse":"false",
"height":"222"
},
{
"top":"4",
"left":"102",
"width":"176",
"id":"14701183280232127011090119940747_0",
"collapse":"false",
"height":"221"
},
{
"top":"273",
"left":"707",
"width":"199.988",
"id":"14697788430250127088051125870133_2",
"collapse":"false",
"height":"219.988"
},
{
"top":"10",
"left":"702",
"width":"200",
"id":"14701198255374127083010127448719_1",
"collapse":"false",
"height":"201"
},
{
"top":"290",
"left":"85",
"width":"200",
"id":"14697755311300127060030131351344_3",
"collapse":"false",
"height":"223"
},
{
"top":"279",
"left":"395",
"width":"200",
"id":"14697760325862127022017139679474_5",
"collapse":"false",
"height":"258"
}
]
},
"panelProperties":{},
"nodes":[
{
"id":"14697760002691127040031128139982_4",
"relDataset":{
"aliasName":"Unit_History_Fact",
"id":"16087236856722127012014164522755",
"type":"FACT"
}
},
{
"id":"14701183280232127011090119940747_0",
"relDataset":{
"aliasName":"Channel",
"id":"16087232363931127040013198037241",
"type":""
}
},
{
"id":"14697788430250127088051125870133_2",
"relDataset":{
"aliasName":"Products",
"id":"16087234903129127087087144585496",
"type":""
}
},
{
"id":"14701198255374127083010127448719_1",
"relDataset":{
"aliasName":"Customer",
"id":"16087233372269127021029149711602",
"type":""
}
},
{
"id":"14697755311300127060030131351344_3",
"relDataset":{
"aliasName":"Date",
"id":"16087232762084127016051117896329",
"type":""
}
},
{
"id":"14697760325862127022017139679474_5",
"relDataset":{
"aliasName":"Price_Cost_History_Fact",
"id":"16087238211139127055042163177495",
"type":"FACT"
}
}
],
"lineType":"NOODLE",
"viewType":"GRAPHICAL",
"relations":[
{
"sourceId":"14697760002691127040031128139982_4",
"name":"",
"join":{
"type":"INNER",
"joinBy":[
{
"node1Key":{"id":"","type":"","content":"ship_to_id"},
"node1SecondaryKey":{"id":"","type":""},
"operator":"EQUAL_TO",
"node2SecondaryKey":{"id":"","type":""},
"node2Key":{"id":"","type":"","content":"ship_to_id"}
}
]
},
"type":"ONE_TO_MANY",
"node2Id":"14701198255374127083010127448719_1",
"node1Id":"14697760002691127040031128139982_4"
},
{
"sourceId":"14697760325862127022017139679474_5",
"name":"",
"join":{
"type":"INNER",
"joinBy":[
{
"node1Key":{"id":"","type":"","content":"item_id"},
"node1SecondaryKey":{"id":"","type":""},
"operator":"EQUAL_TO",
"node2SecondaryKey":{"id":"","type":""},
"node2Key":{"id":"","type":"","content":"item_id"}
}
]
},
"type":"ONE_TO_MANY",
"node2Id":"14697788430250127088051125870133_2",
"node1Id":"14697760325862127022017139679474_5"
},
{
"sourceId":"14697760002691127040031128139982_4",
"name":"",
"join":{
"type":"INNER",
"joinBy":[
{
"node1Key":{"id":"","type":"","content":"month_id"},
"node1SecondaryKey":{"id":"","type":""},
"operator":"EQUAL_TO",
"node2SecondaryKey":{"id":"","type":""},
"node2Key":{"id":"","type":"","content":"month_id"}
}
]
},
"type":"ONE_TO_MANY",
"node2Id":"14697755311300127060030131351344_3",
"node1Id":"14697760002691127040031128139982_4"
},
{
"sourceId":"14697760002691127040031128139982_4",
"name":"",
"join":{
"type":"INNER",
"joinBy":[
{
"node1Key":{"id":"","type":"","content":"item_id"},
"node1SecondaryKey":{"id":"","type":""},
"operator":"EQUAL_TO",
"node2SecondaryKey":{"id":"","type":""},
"node2Key":{"id":"","type":"","content":"item_id"}
}
]
},
"type":"ONE_TO_MANY",
"node2Id":"14697788430250127088051125870133_2",
"node1Id":"14697760002691127040031128139982_4"
},
{
"sourceId":"14697760325862127022017139679474_5",
"name":"",
"join":{
"type":"INNER",
"joinBy":[
{
"node1Key":{"id":"","type":"","content":"month_id"},
"node1SecondaryKey":{"id":"","type":""},
"operator":"EQUAL_TO",
"node2SecondaryKey":{"id":"","type":""},
"node2Key":{"id":"","type":"","content":"month_id"}
}
]
},
"type":"ONE_TO_MANY",
"node2Id":"14697755311300127060030131351344_3",
"node1Id":"14697760325862127022017139679474_5"
},
{
"sourceId":"14697760002691127040031128139982_4",
"name":"",
"join":{
"type":"INNER",
"joinBy":[
{
"node1Key":{"id":"","type":"","content":"channel_id"},
"node1SecondaryKey":{"id":"","type":""},
"operator":"EQUAL_TO",
"node2SecondaryKey":{"id":"","type":""},
"node2Key":{"id":"","type":"","content":"channel_id"}
}
]
},
"type":"ONE_TO_MANY",
"node2Id":"14701183280232127011090119940747_0",
"node1Id":"14697760002691127040031128139982_4"
}
],
"layoutProperty":{
"panelDetails":{
"files":{"style":{"height":300},"id":"files"},
"datasets":{"style":{"height":300},"id":"datasets"},
"properties":{"style":{"height":601},"id":"properties"}
},
"columnDetails":[
{
"panels":[],
"index":0,
"style":{"width":352}
},
{
"panels":[],
"index":1,
"style":{"width":120}
}
]
}
}
},
"folderId":"folder_16774887564612127062080176677386",
"designSource":"DESIGNER",
"ownerAppName":"",
"common":{
"compatibilityVersion":"3",
"desc":"",
"tags":""
},
"entityState":"",
"name":"Sanity_DRD_ON_MultiFact",
"isPublic":true,
"subType":"",
"repositDate":"05/12/2026 16:01:28 IST",
"id":"17785818880175127014040150037850",
"folderName":"Sanity_Suite",
"accessRights":"1",
"categoryId":"folder_16774887564612127062080176677386"
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |