De API gebruiken om regelresultaten van de gegevenskwaliteit te posten - Data360_Govern

Tip: Als u nog niet bekend bent met de Data360 Govern API, raadpleegt u de API-documentatie voor een algemene introductie.

De voorbeeldaanvragen in dit onderwerp gebruiken de Curl-syntaxis om alle vereiste informatie in een aanvraag weer te geven, inclusief aanvraagheaders, methoden, eindpunten en gegevens, alsmede verplichte en optionele parameters: Bovendien wordt voor elke aanvraag dezelfde headerinformatie weergegeven in een apart blok voor gebruik bij het verbinden met de Data360 Govern API via een API-client.

Opmerking: U moet de vereiste rechten hebben om regelresultaten te uploaden en te bewerken via de API en de opgegeven assets mogen geen inactieve status hebben.

1. De OwningAssetUid identificeren

Regelresultaten moeten worden gekoppeld aan een bestaande regel in uw systeem. Om de regelresultaten aan de regel te relateren, moet u de regel-UID-waarde (OwningAssetUid) gebruiken in uw aanvraag.

U kunt de UID-waarde van een regel ophalen door naar de detailpagina van de regel te navigeren.

2. Regelresultaten posten in Data360 Govern

Gebruik het eindpunt POST /api/v2/metrics/quality/results om resultaten van de gegevenskwaliteit te uploaden naar de opgegeven regel.

Voorbeeldaanvraag

In de aanvraag moet u de volgende informatie opgeven:

De OwningAssetUid (regel-UID-waarde) die u hebt verkregen in stap 1
De resultaatwaarden voor de PassCount en FailCount
EffectiveDate en RunDate van het regelresultaat. De datum mag niet in de toekomst liggen. U moet de notatie yyyy-MM-dd gebruiken voor de ingangsdatum en de notatie yyyy-MM-dd HH:mm:ss voor de datum van uitvoering.

Optioneel kunt u ook de volgende informatie opnemen:

EvaluatedAssetUid - De UID-waarde van een technische asset of bedrijfsasset waaraan u het regelresultaat wilt relateren. Als u deze informatie verstrekt, mag de asset niet in een inactieve status staan en moet u de vereiste rechten voor de asset hebben.
ExecutionItemUid - Een UID-waarde om de aanvraag te identificeren. Als u geen waarde opgeeft, wordt deze automatisch gegenereerd en geretourneerd in het antwoord. Deze waarde is nodig als u het eindpunt PUT /api/v2/metrics/quality/results gebruikt.

In dit voorbeeld worden resultaten voor de gegevenskwaliteit vermeld voor een regel met de volgende UID-waarde: 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'

In het volgende voorbeeld wordt de headerinformatie weergegeven voor dezelfde aanvraag voor gebruik bij het verbinden met de Data360 Govern API via een API-client:

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

Aanvraagtekst:

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

Voorbeeldantwoord

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

Tip: De Uid -waarde die in het antwoord is geretourneerd (02c85456-da74-41ef-905d-6cf2d493dc9e) is de UID voor het regelresultaat. U kunt deze waarde gebruiken met het eindpunt PUT /api/v2/metrics/quality/results als u velden wilt bijwerken. Zie Regelresultaten bijwerken.

Als uw aanvraag is geslaagd, ziet u de bijgewerkte resultaten voor de gegevenskwaliteit voor de opgegeven regel op de pagina Regels in de gebruikersinterface.

Zie Regels voor kwaliteit voor meer informatie over regels voor gegevenskwaliteit.

Regelresultaten bijwerken

Nadat u een regelresultaat hebt geladen, kunt u het eindpunt PUT /api/v2/metrics/quality/results gebruiken om het te vernieuwen. Bijvoorbeeld om een specifieke bedrijfsasset te relateren aan het regelresultaat.

1. De UID van de regelresultaat identificeren

De UID van het regelresultaat wordt geretourneerd met het antwoord wanneer u het eindpunt POST /api/v2/metrics/quality/results gebruikt. In het vorige voorbeeld in dit onderwerp was de waarde Uid 02c85456-da74-41ef-905d-6cf2d493dc9e.

Als u deze waarde niet hebt, kunt u de UID-waarde van een regelresultaat ophalen door naar het tabblad Regelresultaten te navigeren van een regelasset in de toepassing. U kunt ook als volgt het eindpunt GET /api/v2/metrics/quality/results gebruiken:

Voorbeeldaanvraag

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

In het volgende voorbeeld wordt de headerinformatie weergegeven voor dezelfde aanvraag voor gebruik bij het verbinden met de Data360 Govern API via een API-client:

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

Voorbeeldantwoord

{  "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    }  ]}

Het antwoord bevat de regelresultaat-UID: "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e"

2. Het regelresultaat bijwerken

In dit voorbeeld wordt een bedrijfsasset met een UID-waarde van 8dab72ca-5679-4144-8395-b1850ff39278 toegevoegd aan het regelresultaat. Dit is de waarde EvaluatedAssetUid. U kunt de UID-waarde voor een asset ophalen door naar de detailpagina van de asset te navigeren.

Voorbeeldaanvraag

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'

In het volgende voorbeeld wordt de headerinformatie weergegeven voor dezelfde aanvraag voor gebruik bij het verbinden met de Data360 Govern API via een API-client:

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

Aanvraagtekst:

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

In dit voorbeeld wordt de EvaluatedAssetUid weergegeven in de PUT-aanvraag. U moet ten minste één van de vier volgende optionele velden in de aanvraag opnemen:

EvaluatedAssetUid
RunDate
PassCount
FailCount

Velden die u niet opgeeft, worden niet bijgewerkt.

Voorbeeldantwoord

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

3. Controleren of het regelresultaat is bijgewerkt

Nadat u het regelresultaat hebt bijgewerkt met behulp van het PUT-eindpunt, kunt u het GET-eindpunt opnieuw gebruiken om te controleren of de EvaluatedAssetUid is toegevoegd aan het regelresultaat. Het GET-eindpunt gebruikt de regel-UID (OwningAssetUid) die u hebt verkregen in de eerste stap van dit onderwerp.

Voorbeeldaanvraag

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

In het volgende voorbeeld wordt de headerinformatie weergegeven voor dezelfde aanvraag voor gebruik bij het verbinden met de Data360 Govern API via een API-client:

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

Voorbeeldantwoord

Het antwoord toont dat de PUT is geslaagd en dat EvaluatedAssetUid (8dab72ca-5679-4144-8395-b1850ff39278) is toegevoegd aan het regelresultaat (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    }  ]}

De API gebruiken om regelresultaten van de gegevenskwaliteit te posten - Data360_Govern - Nieuwste

Help Data360 Govern

Regelresultaten bijwerken