Cet exemple décrit comment utiliser l’API pour appliquer des scores de gouvernance à vos assets.
Les exemples de requêtes présentés dans cette rubrique utilisent la syntaxe Curl pour afficher toutes les informations requises dans une requête, notamment les en-têtes de requête, les méthodes, les points de terminaison et les données, ainsi que les paramètres obligatoires et facultatifs. En outre, pour chaque requête, les mêmes informations d’en-tête sont affichées dans un bloc distinct à utiliser lors de la connexion à l’API Data360 Govern via un client d’API.
1. Identifier les types d’assets
Utilisez une requête /api/v2/assets/types GET pour récupérer une liste de tous les types d’assets de votre système.
Exemple de requête
curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/assets/types'L’exemple suivant montre les informations d’en-tête pour la même requête à utiliser lors de la connexion à l’API Data360 Govern via un client d’API :
GET https://example.data3sixty.com/api/v2/assets/types HTTP/1.1Authorization: <API Key>;<API Secret> Accept: application/jsonExemple de réponse
[ { "uid": "188f094b-fb02-4de3-8790-8c0d32d98e1a", "Name": "Application", "Class": { "ID": 1, "Name": "Business Asset", "Description": "Business assets." }, "Path": "Application" }, { "uid": "85315000-c77f-4898-84db-f4872cbd2dc0", "Name": "Bloomberg", "Description": "Metadata via the Bloomberg Fields CSV file and other Bloomberg sources.", "Class": { "ID": 2, "Name": "Technical Asset", "Description": "Technical assets." }, "Path": "Bloomberg" } ]Cette réponse indique que l’UID du type d’asset 'Application' est : 188f094b-fb02-4de3-8790-8c0d32d98e1a
Vous pouvez également obtenir l’UID d’un élément depuis l’interface utilisateur en survolant l’icône d’information.
2. Identifier les mesures existantes pour le type d’asset
À l’aide de l’uid du type d’asset que vous avez identifié à l’étape un, utilisez une requête GET pour obtenir une structure hiérarchique des mesures associées.
Exemple de requête
Cet exemple de requête utilise l’UID du type d’asset 'Application' obtenu à l’étape 1 :
curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/metrics/188f094b-fb02-4de3-8790-8c0d32d98e1a/definition'L’exemple suivant montre les informations d’en-tête pour la même requête à utiliser lors de la connexion à l’API Data360 Govern via un client d’API :
GET https://example.data3sixty.com/api/v2/metrics/188f094b-fb02-4de3-8790-8c0d32d98e1a/definition HTTP/1.1Authorization: <API Key>;<API Secret> Accept: application/jsonExemple de réponse
La réponse montre que le type d’asset 'Application' dispose d’un groupe de mesures avec une mesure enfant :
[ { "Uid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", "IsGroup": true, "Name": "my metrics", "Weight": 0.5 "Metrics":[ { "Uid": "c2604685-6fdc-4eae-beba-039e6a5d9335", "IsGroup": false, "Name": "child measure", "Weight": 1 } ] } ]3. Obtenir des informations métriques
À l’aide de la valeur uid de la métrique renvoyée à l’étape 2, utilisez une requête GET pour obtenir une liste de détails de la métrique.
Exemple de requête
curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/metrics/d06f201c-4241-4102-8d68-07d4fb37dfc1'L’exemple suivant montre les informations d’en-tête pour la même requête à utiliser lors de la connexion à l’API Data360 Govern via un client d’API :
GET https://example.data3sixty.com/api/v2/metrics/d06f201c-4241-4102-8d68-07d4fb37dfc1 HTTP/1.1Authorization: <API Key>;<API Secret> Accept: application/jsonExemple de réponse
{ "Children": [ { "Children": [], "Versions": [ { "Conditions": [], "Uid": "c2604685-6fdc-4eae-beba-039e6a5d9335", "EffectiveDate": "2018-10-25T00:00:00.000Z", "Weight": 1, "ConditionAndOr": "a" } ], "Uid": "c2604685-6fdc-4eae-beba-039e6a5d9335", "ParentUid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", "AssetTypeUid": "188f094b-fb02-4de3-8790-8c0d32d98e1a", "IsGroup": false, "State": 1, "Name": "Child measure ", "Description": "Child measure description" } ], "Versions": [ { "Conditions": [], "Uid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", "EffectiveDate": "2018-10-25T00:00:00.000Z", "Weight": 0.5, "ConditionAndOr": "a" } ], "Uid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", "AssetTypeUid": "188f094b-fb02-4de3-8790-8c0d32d98e1a", "IsGroup": true, "State": 1, "Name": "Measure group", "Description": "Measure group description"}4. Charger les résultats dans Data360 Govern
Utilisez la requête /api/v2/metrics/results POST pour charger les scores des métriques sur un asset de type 'Application'.
Dans cet exemple, nous mettons à jour le score de gouvernance d’un asset dont la valeur UID est la suivante : b1c4f830-c71c-4f95-909d-a1d67ca5361c
Exemple de requête
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: key;secret' -d '[ \ { \ "AssetUid": "b1c4f830-c71c-4f95-909d-a1d67ca5361c", \ "MetricAssetUid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", \ "EffectiveDate": "2019-05-08T08:51:56.737Z", \ "Result": true \ } \]' 'https://example.data3sixty.com/api/v2/metrics/results'L’exemple suivant montre les informations d’en-tête pour la même requête à utiliser lors de la connexion à l’API Data360 Govern via un client d’API :
POST https://example.data3sixty.com/api/v2/metrics/results HTTP/1.1Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/jsonCorps de la requête :
[ { "AssetUid": "b1c4f830-c71c-4f95-909d-a1d67ca5361c", "MetricAssetUid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", "EffectiveDate": "2019-05-02T00:00:00.000Z", "Result": true, }]Exemple de réponse
[ { "AssetUid": "b1c4f830-c71c-4f95-909d-a1d67ca5361c", "MetricAssetUid": "d06f201c-4241-4102-8d68-07d4fb37dfc1", "EffectiveDate": "2019-05-02T00:00:00.000Z", "Result": true, "IsSuccess": true }]Si votre requête aboutit, vous verrez apparaître dans l’interface utilisateur le score de gouvernance mis à jour pour l’asset spécifié, par exemple :