Relationships
Het API-veld Relationships geeft informatie over hoe de huidige resource wordt geassocieerd met andere resources in de API. Dit veld wordt weergegeven in API-responses en stelt u in staat te navigeren tussen gerelateerde data-objecten. Het bevat een reeks relationship-objecten, elk met de volgende structuur:
| Veldnaam | Beschrijving |
|---|---|
Id |
De unieke identifier van de gerelateerde resource. |
Type |
Het resourcetype van het gerelateerde object. Bijvoorbeeld: Monitor en MonitorCheck. |
Links |
Bevat URL’s naar gerelateerde resources die met het huidige object worden geassocieerd. Dit bevat Self, de directe API-eindpunt-URL voor toegang tot de gerelateerde resource. Bijvoorbeeld: /Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918 kan worden gebruikt in een GET request om de data van die specifieke controleregel op te halen. |
API Response
Wanneer u data uit de API ophaalt, bevat de respons een veld Relationships met de bijbehorende controleregel:
{
...
"Relationships": [
{
"Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
}
}
]
}
Relationships gebruiken
Om de bijbehorende controleregeldata op te halen, gebruikt u de URL van Links.Self in een nieuwe API-request:
GET https://api.uptrends.com/v4/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918
Dit retourneert de volledige controleregelconfiguratie en details die geassocieerd worden met de oorspronkelijke data.