De API gebruiken om scores toe te passen op uw assets - Data360_Govern - Nieuwste

Help Data360 Govern

Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 Govern
Precisely Data Integriteit Suite > Govern
Version
Nieuwste
Language
Nederlands
Product name
Data360 Govern
Title
Help Data360 Govern
Copyright
2023
First publish date
2014

In dit voorbeeld wordt beschreven hoe u de API gebruikt voor het toepassen van governance scores op uw assets.

Tip: Als u nog niet bekend bent met de Data360 Govern API, raadpleegt u 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.

1. Assettypen identificeren

Gebruik een GET /api/v2/assets/types-aanvraag om een lijst met alle assettypen in uw systeem op te halen.

Voorbeeldaanvraag

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

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:

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

Voorbeeldantwoord

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

Dit antwoord geeft aan dat de UID voor het assettype 'Toepassing' het volgende is: 188f094b-fb02-4de3-8790-8c0d32d98e1a

Opmerking: De naam van de assetklasse 'Bedrijfsasset' is vervangen door de klassenaam 'Woordenlijst'. Als u code of toepassingen hebt die Data360 DQ+ API's aanroepen en een resultaat opleveren dat deze klassenaam omvat en uw code verwacht de klassenaam 'Woordenlijst', moet u de klassenaam 'Bedrijfsasset' bijwerken.

U kunt ook de UID van een item ophalen in de gebruikersinterface door de muisaanwijzer boven het informatiepictogram te houden.

2. Bestaande meetwaarden identificeren voor het assettype

Gebruik een GET-aanvraag met het assettype uid dat u hebt aangegeven in stap één om een hiërarchische structuur te verkrijgen van de bijbehorende meetwaarden.

Voorbeeldaanvraag

In dit voorbeeldaanvraag gebruikt u de UID van het assettype 'Toepassing' die is verkregen in stap 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'

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:

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

Voorbeeldantwoord

Het antwoord toont dat het assettype 'Toepassing' één meetgroep heeft met één onderliggende meetwaarde:

[  {    "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. Metrische informatie ophalen

Gebruik een GET-aanvraag met de metrische uid waarde die in stap twee is geretourneerd om een lijst met metrische gegevens te verkrijgen.

Voorbeeldaanvraag

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

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:

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

Voorbeeldantwoord

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

Gebruik de aanvraag POST /api/v2/metrics/results om metrische scores op een asset van het type 'Toepassing' te uploaden.

In dit voorbeeld werken we de governancescore bij voor een asset met de volgende UID-waarde: b1c4f830-c71c-4f95-909d-a1d67ca5361c

Voorbeeldaanvraag

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'
Opmerking: Als u geen ingangsdatum opgeeft voor een metrisch resultaat, wordt de huidige datum (UTC) gebruikt.

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

Aanvraagtekst:

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

Voorbeeldantwoord

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

Als uw aanvraag geslaagd is, ziet u de bijgewerkte governancescore voor de opgegeven asset in de gebruikersinterface, bijvoorbeeld:

Governancescore