Entity Associated Library Entities¶
/api/repositories/{repository}/entities/{entityId}/associated
Parameter | Type | Purpose |
---|---|---|
repository | string | The name of the Repository |
entityId | int | The ID of the real entity |
Get¶
-
GET
/api/repositories/
(string: repository)/entities/
(int: entityId)/associated
¶ Gets a list of Library Entities associated with an Entity.
GET /api/repositories/jupiter/entities/2/associated HTTP/1.1
Response Code | Reason |
---|---|
200 | No error |
500 | Server error |
The response contains a JSON list containing all Library Entities associated with an Entity.
For example, the request above would result in the following response:
{
"data": {
"entity": {
"entityId": "1"
},
"library": [
{
"libraryId": "19",
"metadata": {
"url": "/api/repositories/jupiter/library/entities/19"
}
},
{
"libraryId": "20",
"metadata": {
"url": "/api/repositories/jupiter/library/entities/20"
}
},
{
"libraryId": "21",
"metadata": {
"url": "/api/repositories/jupiter/library/entities/21"
}
}
]
}
}
If no associated Library Entities were found for a given Entity, it would result in the following response:
{
"data": {
"entity": {
"entityId": "1"
},
"library": []
}
}