In den Beispiel-Anforderungen in diesem Abschnitt der Hilfe wird die Curl-Syntax verwendet, um alle erforderlichen Informationen, einschließlich Anforderungsheadern, Methoden, Endpunkten und Daten, sowie alle obligatorischen und optionalen Parameter darzustellen: Zusätzlich werden für jede Anforderung dieselben Header-Informationen in einem separaten Block angezeigt, die Sie bei der Verbindung mit der Data360 Govern-API über einen API-Client verwenden können.
1. Identifizieren der OwningAssetUid
Regelergebnisse müssen mit einer Regel verknüpft sein, die in Ihrem System vorhanden ist. Um die Regelergebnisse mit der Regel zu verknüpfen, müssen Sie den Regel-UID-Wert (OwningAssetUid) in Ihrer Anforderung verwenden.
Sie können den UID-Wert einer Regel abrufen, indem Sie die Detailseite der Regel öffnen.
2. Regelergebnisse posten in Data360 Govern
Verwenden Sie den Endpunkt POST /api/v2/metrics/quality/results, um Datenqualitätsergebnisse in die angegebene Regel hochzuladen.
Beispielanforderung
In der Anforderung müssen Sie folgende Informationen angeben:
- Die
OwningAssetUid(Regel-UID-Wert), die Sie in Schritt 1 erhalten haben - Die Ergebniswerte für
PassCountundFailCount -
EffectiveDateundRunDatedes Regelergebnisses, die kein Datum in der Zukunft darstellen dürfen. Sie müssen das Formatyyyy-MM-ddfür das Gültigkeitsdatum und das Formatyyyy-MM-dd HH:mm:ssfür das Ausführungsdatum verwenden.
Optional können Sie auch die folgenden Informationen einfügen:
-
EvaluatedAssetUid- Der UID-Wert eines technischen Assets oder Business-Assets, mit dem Sie das Regelergebnis verknüpfen möchten. Wenn Sie diese Informationen angeben, darf das Asset nicht inaktiv sein und Sie müssen über die erforderlichen Berechtigungen für das Asset verfügen. -
ExecutionItemUid- Ein UID-Wert zur Identifizierung der Anforderung. Wenn Sie keinen Wert angeben, wird automatisch ein Wert generiert und in der Antwort zurückgegeben. Dieser Wert wird benötigt, wenn Sie den Endpunkt PUT/api/v2/metrics/quality/resultsverwenden.
In diesem Beispiel werden Datenqualitätsergebnisse für eine Regel mit dem folgenden UID-Wert angezeigt: 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'Im folgenden Beispiel werden die Header-Informationen für dieselbe Anforderung angezeigt, die bei der Verbindung mit der Data360 Govern-API über einen API-Client verwendet wird:
POST https://example.data3sixty.com/api/v2/metrics/quality/results HTTP/1.1 Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/jsonAnforderungstext:
[ { "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", "EffectiveDate": "2020-04-22", "RunDate": "2020-04-22 10:10:20", "PassCount": 20, "FailCount": 0 }]Beispielantwort
[ { "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "ExecutionItemUid": "4b5ef5be-cb43-4ba0-85ac-1fce602aa80c", "Success": true }]Uid -Wert (02c85456-da74-41ef-905d-6cf2d493dc9e) ist die UID für das Regelergebnis. Sie können diesen Wert mit dem Endpunkt PUT /api/v2/metrics/quality/results verwenden, wenn Sie Felder aktualisieren möchten. Siehe Aktualisieren von Regelergebnissen.Wenn Ihre Anforderung erfolgreich war, werden Ihnen die aktualisierten Datenqualitätsergebnisse für die angegebene Regel auf der Seite Regeln auf der Benutzeroberfläche angezeigt.
Weitere Informationen zur Verwendung von Datenqualitätsregeln finden Sie unter Qualitätsregeln.
Aktualisieren von Regelergebnissen
Nachdem Sie ein Regelergebnis geladen haben, können Sie den Endpunkt PUT /api/v2/metrics/quality/results verwenden, um es zu aktualisieren. Zum Beispiel, um ein bestimmtes Business-Assets mit dem Regelergebnis zu verknüpfen.
1. Identifizieren der UID des Regelergebnisses
Die Regelergebnis-UID wird mit der Antwort zurückgegeben, wenn Sie den Endpunkt POST /api/v2/metrics/quality/results verwenden. Im vorherigen Beispiel in diesem Thema lautete der Wert für Uid 02c85456-da74-41ef-905d-6cf2d493dc9e.
Wenn Sie diesen Wert nicht zur Hand haben, können Sie den UID-Wert eines Regelergebnisses abrufen, indem Sie zur Registerkarte Regelergebnisse eines Regel-Assets in der Anwendung navigieren. Alternativ können Sie den Endpunkt GET /api/v2/metrics/quality/results wie folgt verwenden:
Beispielanforderung
curl -X GET --header 'Accept: application/json' 'https://example.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085'Im folgenden Beispiel werden die Header-Informationen für dieselbe Anforderung angezeigt, die bei der Verbindung mit der Data360 Govern-API über einen API-Client verwendet wird:
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/jsonBeispielantwort
{ "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 } ]}Die Antwort enthält die UID des Regelergebnisses: "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e"
2. Das Regelergebnis aktualisieren
In diesem Beispiel wird ein Business-Asset mit dem UID-Wert 8dab72ca-5679-4144-8395-b1850ff39278 zum Regelergebnis hinzugefügt. Dies ist der Wert EvaluatedAssetUid. Sie können den UID-Wert eines Assets abrufen, indem Sie die Detailseite des Assets öffnen.
Beispielanforderung
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'Im folgenden Beispiel werden die Header-Informationen für dieselbe Anforderung angezeigt, die bei der Verbindung mit der Data360 Govern-API über einen API-Client verwendet wird:
PUT https://example.data3sixty.com/api/v2/metrics/quality/results HTTP/1.1 Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/jsonAnforderungstext:
[ { "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278" }]In diesem Beispiel wird die EvaluatedAssetUid in der PUT-Anforderung bereitgestellt. Sie müssen mindestens eines der vier folgenden optionalen Felder in die Anforderung aufnehmen:
-
EvaluatedAssetUid -
RunDate -
PassCount -
FailCount
Felder, die Sie nicht bereitstellen, werden nicht aktualisiert.
Beispielantwort
[ { "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "ExecutionItemUid": "628b96bb-2964-4485-817e-abfc18ff675f", "Success": true }]3. Überprüfen, ob das Regelergebnis aktualisiert wurde
Nachdem Sie das Regelergebnis mithilfe des PUT-Endpunktes aktualisiert haben, können Sie den GET-Endpunkt erneut verwenden, um zu überprüfen, ob EvaluatedAssetUid zum Regelergebnis hinzugefügt wurde. Der GET-Endpunkt verwendet die Regel-UID (OwningAssetUid), die Sie im ersten Schritt in diesem Thema abgerufen haben.
Beispielanforderung
curl -X GET --header 'Accept: application/json' 'https://example.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085'Im folgenden Beispiel werden die Header-Informationen für dieselbe Anforderung angezeigt, die bei der Verbindung mit der Data360 Govern-API über einen API-Client verwendet wird:
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/jsonBeispielantwort
Die Antwort zeigt, dass PUT erfolgreich war und die EvaluatedAssetUid (8dab72ca-5679-4144-8395-b1850ff39278) zum Regelergebnis (02c85456-da74-41ef-905d-6cf2d493dc9e) hinzugefügt wurde.
{ "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 } ]}