Relationships
Le champ de la commande d’API Relationships fournit des informations sur les liens qui existent entre une ressource donnée et d’autres ressources dans l’API. Ce champ apparaît dans les réponses de l’API et permet de naviguer entre les objets de données liés les uns aux autres. Il contient un tableau d’objets de relation, chacun ayant la structure suivante :
| Nom du champ | Description |
|---|---|
Id |
Identifiant unique de la ressource liée |
Type |
Type de ressource de l’objet lié. Par exemple, Monitor et MonitorCheck. |
Links |
Contient les URL des ressources liées qui sont associées à l’objet sur lequel porte la requête. Ce champ inclut un sous-champ Self qui correspond à l’URL directe de l’endpoint d’API permettant d’accéder à la ressource liée. Par exemple, /Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918 peut être utilisé dans une requête GET pour récupérer les données de ce moniteur. |
Réponse de l’API
Lorsque vous récupérez des données depuis l’API, la réponse inclut un champ Relationships qui indique quel est le moniteur associé :
{
...
"Relationships": [
{
"Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
}
}
]
}
Utiliser le champ Relationships
Pour récupérer les données du moniteur associé, utilisez l’URL issue du champ Links.Self dans une nouvelle requête d’API :
GET https://api.uptrends.com/v4/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918
Vous obtenez en retour la configuration complète du moniteur et les détails des données originales.