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.
Vous disposez de deux types d’assets d’assets métier : List1 et List2. Vous souhaitez ajouter un nouveau champ de liste au type d’asset List1.
1. Identifier les types d’assets
Utilisez une requête /api/v2/assets/types GET pour récupérer une liste de tous les types d’assets de votre système.
Exemple de requête
curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/assets/types'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 :
GET https://example.data3sixty.com/api/v2/assets/types HTTP/1.1Authorization: <API Key>;<API Secret>
Accept: application/jsonExemple de réponse
[
{ "uid": "92ed38e0-73bd-4598-857b-a7724aa596d7", "Name": "List1", "Class": { "ID": 1, "Name": "Business Asset", "Description": "Business assets." }, "Path": "List1" },
{ "uid": "a943957f-1737-43e4-85db-2bd3927f4e69", "Name": "List2", "Class": { "ID": 2, "Name": "Business Asset", "Description": "Business assets." }, "Path": "List2" }
]Cette réponse indique que :
- L’UID du type d’asset « List1 » est le suivant :
92ed38e0-73bd-4598-857b-a7724aa596d7 - L’UID du type d’asset « List2 » est le suivant :
a943957f-1737-43e4-85db-2bd3927f4e69
2. Identifier les assets existants pour le type d’asset
À l’aide du type d’asset uid que vous avez identifié à l’étape un, utilisez une requête GET pour obtenir une liste des assets List2 existants.
Exemple de requête
Cet exemple de requête utilise l’UID du type d’asset « List2 » obtenu à l’étape 1 :
curl -X GET --header 'Accept: application/json' --header 'Authorization: key;secret' 'https://example.data3sixty.com/api/v2/assets/a943957f-1737-43e4-85db-2bd3927f4e69'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 :
GET https://example.data3sixty.com/api/v2/assets/a943957f-1737-43e4-85db-2bd3927f4e69 HTTP/1.1Authorization: <API Key>;<API Secret>
Accept: application/jsonExemple de réponse
La réponse montre que le type d’asset « List2 » dispose de trois assets :
{
"items": [
{
"AssetId": 17284,
"AssetUid": "b664eb76-42d2-476e-8298-09643097e572",
"XrefId": null,
"AssetTypeId": 489,
"AssetTypeUid": "a943957f-1737-43e4-85db-2bd3927f4e69",
"UpdatedOn": "2023-09-21T13:21:34.907Z",
"CreatedOn": "2023-09-21T13:21:34.907Z",
"Color": null,
"Path": "[Asset_Name1]",
"DisplayPath": "Asset_Name1",
"Name": "Asset_Name1"
},
{
"AssetId": 17285,
"AssetUid": "3c60e0a1-3f6c-4c9c-a218-db86c81c0ff6",
"XrefId": null,
"AssetTypeId": 489,
"AssetTypeUid": "a943957f-1737-43e4-85db-2bd3927f4e69",
"UpdatedOn": "2023-09-21T14:43:56.980Z",
"CreatedOn": "2023-09-21T14:43:56.980Z",
"Color": null,
"Path": "[Asset_Name2]",
"DisplayPath": "Asset_Name2",
"Name": "Asset_Name2"
},
{
"AssetId": 17286,
"AssetUid": "a17ab40d-6214-4ed6-bd01-8c3f7a7c9cf5",
"XrefId": null,
"AssetTypeId": 489,
"AssetTypeUid": "a943957f-1737-43e4-85db-2bd3927f4e69",
"UpdatedOn": "2023-09-21T14:44:09.797Z",
"CreatedOn": "2023-09-21T14:44:09.797Z",
"Color": null,
"Path": "[Asset_Name3]",
"DisplayPath": "Asset_Name3",
"Name": "Asset_Name3"
}
],
"pageSize": 200,
"pageNum": 1,
"total": 3
}3. Ajouter un champ de liste
Ajoutez un champ de liste au type d’asset « List1 ». Utilisez la valeur uid de Asset_Name1 renvoyée à l’étape 2 pour spécifier une valeur par défaut.
Exemple de requête
curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \
"Action": "Merge", \
"Fields": [ \
{ \
"Name": "list_field", \
"FriendlyName": "list_field", \
"Category": "List", \
"Type": { \
"Lookup": { \
"Description": { \
"Form": "Example form", \
"Display": "Example display" \
}, \
"AllowAllValue": false, \
"AllowAllLabel": "string", \
"Format": { \
"Display": "{Name}", \
"Edit": "{Name}" \
}, \
"List": { \
"Uid": "a943957f-1737-43e4-85db-2bd3927f4e69", \
"Class": "BusinessAsset", \
"AllowMultipleValues": true \
}, \
"Validation": { \
"IsRequired": false \
}, \
"DefaultValue": "b664eb76-42d2-476e-8298-09643097e572", \
"ColumnOrder": 0, \
"ColumnWidth": 0, \
"SortOrder": 0, \
"IsDisplayable": true, \
"IsEditable": true, \
"IsListable": true, \
"IsPartOfKey": false, \
"IsPrimaryFilter": true, \
"ShowIfEmpty": true \
} \
} \
} \
], \
"AssetTypeUid": "92ed38e0-73bd-4598-857b-a7724aa596d7" \
}' 'https://example.data3sixty.com/api/v2/fields'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/fields HTTP/1.1Authorization: <API Key>;<API Secret>
Accept: application/jsonExemple de réponse
{
"Uid": "92ed38e0-73bd-4598-857b-a7724aa596d7",
"Success": true,
"Message": "Fields successfully updated."
} Un nouveau champ de liste appelé list_field est ajouté au type d’asset « List1 ». La valeur par défaut spécifiée est Asset_Name1, qui est référencé par sa valeur UID dans la requête : "DefaultValue": "b664eb76-42d2-476e-8298-09643097e572".