Cette section détaille les endpoints permettant de générer des métriques génériques au sein de l'arborescence.
Pour rappel, cette génération s'appuie sur des modèles de métriques qui doivent avoir été préalablement définis sur les types de votre arborescence.
Si vous n'êtes pas familiers avec cette fonctionnalité, consultez la documentation sur les modèles de métriques.
Récupérer la liste des métriques à générer
Description
Cette requête permet de lister l'ensemble des métriques à générer à partir d'un modèle.
Remarque : Il ne s'agit pas ici de générer des métriques, mais de visualiser les métriques qui peuvent être générées par un modèle.
Get /v2/data-structures/{data_structure_id}/templates/generate/metrics
Scope
Pour effectuer cette requête, vous devez posséder le scope suivant : metadata:read.
Paramètres
data_structure_id (string, obligatoire) : ID attribué à l'arborescence.
Cet ID peut être récupéré via la requête
GET v2/data-structuresou lors de la création d'une nouvelle arborescence avecPOST v2/data-structures.
metric_template_id (string, optionnel) : ID attribué au modèle que vous souhaitez éditer.
Cet ID peut être récupéré via la requête
Get v2/data-structures/{data_structure_id}/types/{type_id}/templatesou lors de la création du template.Remarque : Ce paramètre peut être laissé vide pour vous permettre de générer l'ensemble des métriques issues de modèles de l'arborescence.
Ces paramètres doivent être ajoutés à l'URL pour construire la chaîne de requête tel que :
/v2/data-structures/{data_structure_id}/templates/generate/metrics?metric_template_id="string"
Exemple de requête
# Commande pour lister les métriques à générer à partir d'un modèle
curl -X 'GET' \
'https://xxx.indaba.api.indasuite.io-base.com/v2/data-structures/67337415-6bcb-4c21-b0f5-8253d68b6e80/templates/generate/metrics?metric_template_id=80ac9889-dc78-4ecc-9680-3f9ea79697a2' \
# ----- En-têtes -----
-H 'accept: application/json' \
-H 'Authorization: Bearer VOTRE_JETON_JWT'
Réponses
exemple de réponse valide (200 OK) :
Remarque : Cette réponse est incomplète, et ne montre que la génération d'une seule métrique.
{
"data": [
{
"id": "18f86cfb-7cfb-4184-8aee-11612bf7b8dc",
"dataStructureId": "67337415-6bcb-4c21-b0f5-8253d68b6e80",
"typeId": "0b3f2349-9b17-45d9-b7c4-0b47d0f39960",
"parentId": "_siteb",
"label": "ID_MOY",
"metric": {
"id": "main@cip_int_106",
"name": "cip_int_106",
"datasource": "main",
"type": "Raw"
},
"properties": {},
"parents": {
"e9910c2b-83e9-4954-a1dd-abca2d833999": [
{
"code_site": 106,
"id": "_siteb",
"label": "Site b",
"parentid": null
}
]
},
"options": {
"indabaId": "main@cip_int_106",
"indabaLabel": "Custom"
},
"isTypeMetric": true,
"hasError": false,
"metricTemplateId": "80ac9889-dc78-4ecc-9680-3f9ea79697a2",
"metricTemplateVersion": 1,
"hasTemplateCreated": false,
"isLockedToTemplate": true
}
],
"paginationInfo": {
"count": 1,
"total": 1,
"isComplete": true
},
"resultCode": 2010,
"message": "OK"
}
Erreurs courantes
Veuillez vous référer à la liste des erreurs courantes.
Générer des métriques génériques
Description
Cette requête permet de générer des métriques à partir d'un modèle.
Remarque : Il ne s'agit pas ici de générer des métriques, mais de visualiser les métriques qui peuvent être générées par un modèle.
Post /v2/data-structures/{data_structure_id}/templates/generate/metrics
Scope
Pour effectuer cette requête, vous devez posséder le scope suivant : metadata:admin.
Paramètres
data_structure_id (string, obligatoire) : ID attribué à l'arborescence.
Cet ID peut être récupéré via la requête
GET v2/data-structuresou lors de la création d'une nouvelle arborescence avecPOST v2/data-structures.
metric_template_id (string, optionnel) : ID attribué au modèle que vous souhaitez éditer.
Cet ID peut être récupéré via la requête
Get v2/data-structures/{data_structure_id}/types/{type_id}/templatesou lors de la création du template.Remarque : Ce paramètre peut être laissé vide pour vous permettre de générer l'ensemble des métriques issues de modèles de l'arborescence.
Ces paramètres doivent être ajoutés à l'URL pour construire la chaîne de requête :
/v2/data-structures/{data_structure_id}/templates/generate/metrics?metric_template_id="string"
Exemple de requête
# Commande pour générer des métriques à partir d'un modèle de métrique
curl -X 'POST' \
'https://xxx.indaba.api.indasuite.io-base.com/v2/data-structures/67337415-6bcb-4c21-b0f5-8253d68b6e80/templates/generate/metrics?metric_template_id=80ac9889-dc78-4ecc-9680-3f9ea79697a2' \
# ----- En-têtes -----
-H 'accept: application/json' \
-H 'Authorization: Bearer VOTRE_JETON_JWT' \
# ----- Corps de la requête (vide pour cette action) -----
-d ''
Réponses
exemple de réponde valide (200 OK) :
{
"resultCode": 2010,
"message": "OK"
}
Erreurs courantes
Veuillez vous référer à la liste des erreurs courantes.
Erreurs courantes
Vous rencontrerez principalement les codes d'erreur HTTP suivants :
400 Bad Request : Votre requête est malformée. Cela peut être dû à un paramètre manquant, un type de donnée incorrect ou un JSON invalide. Le corps de la réponse contiendra un tableau errors détaillant le problème.
{
"errors": [
{
"error": "Type_De_L_Erreur",
"message": "Description détaillée de l'erreur spécifique."
}
],
"statusCode": 1050,
"message": "Invalid request"
}
401 Unauthorized : Votre jeton d'authentification (JWT) est manquant, invalide ou expiré. Vous devez obtenir un nouveau jeton valide.
403 Forbidden : Votre jeton d'authentification est valide, mais vous n'avez pas les droits nécessaires pour cette action.
Votre jeton n'a pas les droits (scope) nécessaires (par exemple, vous tentez de créer une arborescence sans avoir le scope metadata:admin).
404 Not Found : La ressource que vous essayez d'atteindre n'existe pas. Cela se produit typiquement si vous utilisez un ID incorrect ou si vous demandez une métrique qui n'existe pas.