Mécanisme des métadonnées metadata-mechanism
Vous pouvez récupérer les métadonnées des ressources en utilisant resourceType dans une requête GET :
GET /profileAndServices/resourceType/<resourceName>
La réponse renvoie les métadonnées principales de la ressource (tous les autres champs sont descriptifs ou internes) :
-
Le nœud Content renvoie les champs de la ressource. Chaque champ du nœud Content comporte les champs suivants :
-
"apiName" : nom de l’attribut utilisé dans les API.
-
"type" : définition de type de niveau supérieur (chaîne, nombre, lien, collection, énumération…).
-
"dataPolicy" : la valeur du champ doit respecter les politiques données. Par exemple, si la règle dataPolicy est définie sur "email", la valeur doit être un email valide. Lors d’un PATCH ou d’un POST, la variable dataPolicy peut vérifier la valeur ou modifier la valeur à transformer (smartCase, par exemple).
-
"category" : indique la catégorie du champ dans le requêteur.
-
"resType" : le type technique.
Si "type" est renseigné avec la valeur "link" ou "collection", la valeur resTarget est le nom de la ressource ciblée par le lien.
Si "type" est renseigné avec la valeur "enumeration", un champ "values" est ajouté et chaque valeur d’énumération est détaillée dans le nœud values .
-
-
Le nœud Filters renvoie l’URL permettant de récupérer les filtres associés. Voir à ce propos cette section.
Exemple de requête
Exécutez une requête GET sur la ressource.
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
Elle renvoie la description complète de la ressource de profil.
{
...
"content": {
"email": {...},
...
},
"data": "/profileAndServices/profile/",
"filters": {
"href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/<PKEY>"
},
"help": "Identified profiles",
"href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/metadata",
"label": "Profiles",
"mandatory": false,
"name": "profile",
"pkgStatus": "never",
"readOnly": false,
"schema": "nms:recipient",
"type": "item"
}