GetHubReference - GET
|
Path |
/api/projects/{projectId}/model/links/{linkId}/hubreferences |
|---|---|
|
Http Method |
GET |
Overview
Get all hub references of a link
Required permissions
-
Write access to the Build module. BUILD READ
Request
Path parameters
|
Parameter |
Type |
Required |
Description |
Example |
|---|---|---|---|---|
|
linkId |
string |
Yes |
The id of the link to get hub references for. |
|
Query parameters
See: Metavault API - General concepts | Paging, sorting and filters for collection query parameters.
Response
Success response (200 OK)
{
"self": "/api/projects/{projectId}/model/links/{linkId}/hubreferences",
"total": 2,
"_embedded": {
"hubreferences": [
{
"self": "/api/projects/{projectId}/model/links/{linkId}/hubreferences/{hrId}",
"id": "hr-12345",
"columnName": "CUSTOMER_HK",
"order": 0,
"hubId": "hub-123",
"linkId": "link-12345",
"_links": {
"hub": "/api/projects/{projectId}/model/hubs/hub-123"
}
},
{
"self": "/api/projects/{projectId}/model/links/{linkId}/hubreferences/{hrId2}",
"id": "hr-12346",
"columnName": "ORDER_HK",
"order": 1,
"hubId": "hub-456",
"linkId": "link-12345",
"_links": {
"hub": "/api/projects/{projectId}/model/hubs/hub-456"
}
}
]
}
}
Response fields
|
Field |
Type |
Description |
|---|---|---|
|
.self |
string |
Url to get the hub reference of the link Updated |
|
total |
int |
Number of hub references in the link |
|
_embedded.hubReferences[].id |
string |
Hub reference identifier |
|
_embedded.hubReferences[].columnName |
string |
Column name for the hub reference |
|
_embedded.hubReferences[].order |
integer |
Order of the hub reference |
|
_embedded.hubReferences[].hubid |
string |
ID of the referenced hub |
|
_embedded.hubReferences[].linkId |
string |
ID of the link |
|
_embedded.hubReferences[]._links.hub |
uri |
URI reference to the hub |