Utiliser l’API pour publier les résultats de règle de qualité des données - Data360_Govern

Conseil : Si vous ne vous êtes pas encore familiarisé avec l’API Data360 Govern, reportez-vous à Documentation de l’API pour obtenir une introduction générale.

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.

Remarque : Vous devez disposer des autorisations requises pour charger et modifier les résultats de règle via l’API et les assets spécifiés ne doivent pas être dans un état inactif.

1. Identifier la valeur OwningAssetUid

Les résultats de règle doivent être liés à une règle qui existe dans votre système. Pour relier les résultats de règle à la règle, vous devez utiliser la valeur UID de la règle (OwningAssetUid) dans votre requête.

Vous pouvez obtenir la valeur UID d’une règle en accédant à la page de détails de la règle.

2. Publier les résultats de règle dans Data360 Govern

Utilisez le point de terminaison POST /api/v2/metrics/quality/results pour charger les résultats de qualité des données en fonction de la règle spécifiée.

Exemple de requête

Dans la requête, vous devez inclure les informations suivantes :

La valeur OwningAssetUid (valeur de l’UID de la règle) que vous avez obtenue à l’étape 1
Les valeurs de résultat pour PassCount et FailCount
Les valeurs EffectiveDate et RunDate du résultat de règle, qui ne peuvent pas être une date dans le futur. Vous devez utiliser le format yyyy-MM-dd pour la date d’entrée en vigueur et le format yyyy-MM-dd HH:mm:ss pour la date d’exécution.

Si vous le souhaitez, vous pouvez également inclure les informations suivantes :

EvaluatedAssetUid - La valeur UID d’un asset technique ou d’un asset métier auquel vous souhaitez relier le résultat de règle. Si vous fournissez ces informations, l’asset ne doit pas être à l’état inactif et vous devez disposer des autorisations requises pour l’asset.
ExecutionItemUid - Une valeur UID permettant d’identifier la requête. Si vous ne fournissez pas de valeur, une valeur sera générée automatiquement et sera renvoyée dans la réponse. Cette valeur sera nécessaire si vous utilisez le point de terminaison PUT /api/v2/metrics/quality/results.

Cet exemple publie les résultats de qualité des données pour une règle dont la valeur UID est la suivante : 99533c04-142d-48c5-b7e8-f4e02c990085

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '[ \  { \    "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", \    "EffectiveDate": "2020-04-22", \    "RunDate": "2020-04-22 10:10:20", \    "PassCount": 20, \    "FailCount": 0 \  } \]' 'https://example.data3sixty.com/api/v2/metrics/quality/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/quality/results HTTP/1.1  Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json

Corps de la requête :

[  {    "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085",    "EffectiveDate": "2020-04-22",    "RunDate": "2020-04-22 10:10:20",    "PassCount": 20,    "FailCount": 0  }]

Exemple de réponse

[  {    "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e",    "ExecutionItemUid": "4b5ef5be-cb43-4ba0-85ac-1fce602aa80c",    "Success": true  }]

Conseil : La valeur Uid renvoyée dans la réponse (02c85456-da74-41ef-905d-6cf2d493dc9e) est l’UID du résultat de règle. Vous pouvez utiliser cette valeur avec le point de terminaison PUT /api/v2/metrics/quality/results si vous souhaitez mettre à jour des champs. Reportez-vous à Mettre à jour les résultats de règle.

Si votre requête aboutit, vous verrez les résultats de qualité des données mis à jour pour la règle spécifiée sur la page Règles de l’interface utilisateur.

Pour plus d’informations sur les règles de qualité des données, reportez-vous à Règles de qualité.

Mettre à jour les résultats de règle

Une fois le résultat d’une règle chargé, vous pouvez utiliser le point de terminaison PUT /api/v2/metrics/quality/results pour le mettre à jour. Par exemple, pour relier un asset métier spécifique au résultat de règle.

1. Identifier l’UID du résultat de règle

L’UID du résultat de règle est renvoyé avec la réponse lorsque vous utilisez le point de terminaison POST /api/v2/metrics/quality/results. Dans l’exemple précédent de cette rubrique, la valeur Uid était 02c85456-da74-41ef-905d-6cf2d493dc9e.

Si vous ne disposez pas de cette valeur, vous pouvez obtenir la valeur UID d’un résultat de règle en accédant à l’onglet Résultats de règle d’un asset de règle dans l’application. Sinon, vous pouvez utiliser le point de terminaison GET /api/v2/metrics/quality/results, comme suit :

Exemple de requête

curl -X GET --header 'Accept: application/json' 'https://example.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085'

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 :

https://documentation-igx.preview.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085 HTTP/1.1  Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json

Exemple de réponse

{  "pageSize": 250,  "pageNum": 1,  "total": 2,  "items": [    {      "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e",      "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085",      "EvaluatedAssetUid": "00000000-0000-0000-0000-000000000000",      "EffectiveDate": "2020-04-22T00:00:00.000Z",      "RunDate": "2020-04-22T10:10:20.000Z",      "PassCount": 20,      "FailCount": 0,      "Passed": true    },    {      "ResultUid": "984bfc0c-bdbe-411e-8482-84b13133a7d3",      "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085",      "EvaluatedAssetUid": "00000000-0000-0000-0000-000000000000",      "EffectiveDate": "2020-04-22T00:00:00.000Z",      "RunDate": "2020-04-22T10:10:20.000Z",      "PassCount": 20,      "FailCount": 0,      "Passed": true    }  ]}

La réponse inclut l’UID du résultat de règle : "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e"

2. Mettre à jour le résultat de règle

Dans cet exemple, un asset métier dont la valeur UID est 8dab72ca-5679-4144-8395-b1850ff39278 est ajouté au résultat de règle : il s’agit de la valeur EvaluatedAssetUid. Vous pouvez obtenir la valeur UID d’un asset en accédant à la page de détails de cet asset.

Exemple de requête

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '[ \  { \    "Uid": "99533c04-142d-48c5-b7e8-f4e02c990085", \    "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278", \  } \]' 'https://example.data3sixty.com/api/v2/metrics/quality/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 :

PUT https://example.data3sixty.com/api/v2/metrics/quality/results HTTP/1.1  Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json

Corps de la requête :

[  {    "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e",    "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278"  }]

Dans cet exemple, le paramètre EvaluatedAssetUid est fourni dans la requête PUT. Vous devez inclure au moins un des quatre champs facultatifs suivants dans la requête :

EvaluatedAssetUid
RunDate
PassCount
FailCount

Les champs que vous ne fournissez pas ne seront pas mis à jour.

Exemple de réponse

[  {    "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e",    "ExecutionItemUid": "628b96bb-2964-4485-817e-abfc18ff675f",    "Success": true  }]

3. Vérifier que le résultat de règle a été mis à jour

Après avoir mis à jour le résultat de règle à l’aide du point de terminaison PUT, vous pouvez utiliser à nouveau le point de terminaison GET pour vérifier que la valeur EvaluatedAssetUid a été ajoutée au résultat de règle. Le point de terminaison GET utilise l’UID de la règle (OwningAssetUid) que vous avez obtenue lors de la première étape de cette rubrique.

Exemple de requête

curl -X GET --header 'Accept: application/json' 'https://example.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085'

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 :

https://documentation-igx.preview.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085 HTTP/1.1  Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json

Exemple de réponse

La réponse montre que la valeur PUT a abouti et que EvaluatedAssetUid (8dab72ca-5679-4144-8395-b1850ff39278) a été ajouté au résultat de règle (02c85456-da74-41ef-905d-6cf2d493dc9e).

{  "pageSize": 250,  "pageNum": 1,  "total": 2,  "items": [    {      "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e",      "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085",      "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278",      "EffectiveDate": "2020-04-22T00:00:00.000Z",      "RunDate": "2020-04-22T10:10:20.000Z",      "PassCount": 20,      "FailCount": 0,      "Passed": true    },    {      "ResultUid": "984bfc0c-bdbe-411e-8482-84b13133a7d3",      "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085",      "EvaluatedAssetUid": "00000000-0000-0000-0000-000000000000",      "EffectiveDate": "2020-04-22T00:00:00.000Z",      "RunDate": "2020-04-22T10:10:20.000Z",      "PassCount": 20,      "FailCount": 0,      "Passed": true    }  ]}

Utiliser l’API pour publier les résultats de règle de qualité des données - Data360_Govern - Latest

Aide Data360 Govern

Mettre à jour les résultats de règle