Verwenden der API für die Bewertung Ihrer Assets - Data360_Govern - Neuheiten

Data360 Govern – Hilfe
Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 Govern
Version
Neuheiten
Language
Deutsch
Product name
Data360 Govern
Title
Data360 Govern – Hilfe
Copyright
2024
First publish date
2014
Last updated
2024-11-21
Published on
2024-11-21T15:38:13.793132

In diesem Beispiel wird beschrieben, wie Sie die API verwenden, um Governance-Scores auf Ihre Assets anzuwenden.

Tipp: Falls Sie noch nicht mit der Data360 Govern-API vertraut sind, finden Sie unter API-Dokumentation eine allgemeine Einführung.

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. Asset-Typen identifizieren

Verwenden Sie eine GET /api/v2/assets/types-Anforderung, um eine Liste aller Asset-Typen in Ihrem System abzurufen.

Beispielanforderung 

curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/assets/types'

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:

GET https://example.data3sixty.com/api/v2/assets/types HTTP/1.1Authorization: <API Key>;<API Secret> 		 Accept: application/json

Beispielantwort 

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

Diese Antwort gibt an, dass die UID für den Asset-Typ „Anwendung“ wie folgt lautet: 188f094b-fb02-4de3-8790-8c0d32d98e1a

Anmerkung: Der Asset-Klassename „Business Asset“ hat den Klassennamen „Glossar“ ersetzt. Wenn Sie Code oder Anwendungen verwenden, die beliebige Data360 DQ+-APIs aufrufen, die ein Ergebnis zurückgeben, das diesen Klassennamen enthält, und Ihr Code den Klassennamen „Glossar“ erwartet, müssen Sie aktualisieren, um nach dem Klassennamen „Business Asset“ zu suchen.

Sie können die UID eines Elements auch über die Benutzeroberfläche abrufen, indem Sie den Mauszeiger über das Informationssymbol schieben.

2. Identifizieren vorhandener Messgrößen für den Asset-Typ

Verwenden Sie mithilfe des Asset-Typs uid , den Sie in Schritt 1 angegeben haben, eine GET-Anforderung, um eine hierarchische Struktur der zugehörigen Messgrößen zu erhalten.

Beispielanforderung

In dieser Beispielanforderung wird die UID des Asset-Typs „Anwendung“ verwendet, die in Schritt 1 abgerufen wurde:

curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/metrics/188f094b-fb02-4de3-8790-8c0d32d98e1a/definition'

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:

GET https://example.data3sixty.com/api/v2/metrics/188f094b-fb02-4de3-8790-8c0d32d98e1a/definition HTTP/1.1Authorization: <API Key>;<API Secret> Accept: application/json

Beispielantwort

Die Antwort zeigt, dass der Asset-Typ „Anwendung“ eine Messgrößengruppe mit einer untergeordneten Messgröße hat:

[  {    "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. Metrikinformationen abrufen

Verwenden Sie eine GET-Anforderung, um eine Liste metrischer Details zu erhalten. Verwenden Sie dazu den in Schritt 2 zurückgegebenen uid -Metrikwert.

Beispielanforderung 

curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/metrics/d06f201c-4241-4102-8d68-07d4fb37dfc1'

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:

GET https://example.data3sixty.com/api/v2/metrics/d06f201c-4241-4102-8d68-07d4fb37dfc1 HTTP/1.1Authorization: <API Key>;<API Secret> 	  Accept: application/json

Beispielantwort 

{  "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. Ergebnisse laden in Data360 Govern

Verwenden Sie die Anforderung POST /api/v2/metrics/results, um metrische Scores für ein „Anwendung“-Asset hochzuladen.

In diesem Beispiel wird der Governance-Score für ein Asset mit dem folgenden UID-Wert aktualisiert: b1c4f830-c71c-4f95-909d-a1d67ca5361c

Beispielanforderung 

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'
Anmerkung: Wenn Sie für ein metrisches Ergebnis kein Gültigkeitsdatum angeben, wird das aktuelle Datum (UTC) verwendet.

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/results HTTP/1.1Authorization: <API Key>;<API Secret> 	Content-Type: application/json 	Accept: application/json

Anforderungstext:

[  {    "AssetUid": "b1c4f830-c71c-4f95-909d-a1d67ca5361c",    "MetricAssetUid": "d06f201c-4241-4102-8d68-07d4fb37dfc1",    "EffectiveDate": "2019-05-02T00:00:00.000Z",    "Result": true,     	}]

Beispielantwort 

[  {    "AssetUid": "b1c4f830-c71c-4f95-909d-a1d67ca5361c",    "MetricAssetUid": "d06f201c-4241-4102-8d68-07d4fb37dfc1",    "EffectiveDate": "2019-05-02T00:00:00.000Z",    "Result": true,     	"IsSuccess": true 	}]

Wenn Ihre Anforderung erfolgreich war, wird Ihnen der aktualisierte Governance-Score für das angegebene Asset auf der Benutzeroberfläche angezeigt. Beispiel:

Governance-Score