Création d’un jeu de mappages
Vous pouvez créer un nouveau jeu de mappages en effectuant une requête POST vers le point d’entrée /mappingSets
.
Format d’API
POST /mappingSets
Requête
La requête suivante crée un nouveau jeu de mappages configuré en fonction des paramètres fournis dans le payload.
curl -X POST https://platform.adobe.io/data/foundation/conversion/mappingSets \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/89abc189258b1cb1a816d8f2b2341a6d98000ed8f4008305",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "id",
"destination": "_id",
"name": "id",
"description": "Identifier field"
},
{
"sourceType": "ATTRIBUTE",
"source": "firstName",
"destination": "person.name.firstName"
},
{
"sourceType": "ATTRIBUTE",
"source": "lastName",
"destination": "person.name.lastName"
}
]
}
Propriété | Description |
---|---|
outputSchema.schemaRef.id | Identifiant du schéma XDM auquel vous faites référence. |
outputSchema.schemaRef.contentType | Détermine le format de réponse du schéma référencé. Vous trouverez plus d’informations sur ce champ dans le guide de développement du registre des schémas. |
mappings.sourceType |
Le type de source décrit comment la valeur sera extraite de la source vers la destination. Le type de source prend en charge deux valeurs possibles :
WARNING : la définition incorrecte des valeurs de type source peut rendre vos jeux de mappages non modifiables. |
mappings.source | L’emplacement à partir duquel vous souhaitez mapper les données. |
mappings.destination | L’emplacement auquel vous souhaitez mapper les données. |
Réponse
Une réponse réussie renvoie un statut HTTP 200 avec des informations sur le jeu de mappages que vous venez de créer.
{
"id": "e7c80e4c0d8f4a98a7d400b4e178b635",
"version": 0,
"createdDate": 1614901254724,
"modifiedDate": 1614901254724,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
Validation des mappages
Vous pouvez vérifier que vos mappages fonctionnent correctement en effectuant une requête POST vers le point d’entrée /mappingSets/validate
.
Format d’API
POST /mappingSets/validate
Requête
La requête suivante valide les mappages fournis dans le payload.
curl -X POST https://platform.adobe.io/data/foundation/conversion/mappingSets/validate \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/89abc189258b1cb1a816d8f2b2341a6d98000ed8f4008305",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "id",
"destination": "_id",
"name": "id",
"description": "Identifier field"
},
{
"sourceType": "ATTRIBUTE",
"source": "firstName",
"destination": "person.name.firstName"
},
{
"sourceType": "ATTRIBUTE",
"source": "lastName",
"destination": "person.name.lastName"
}
]
}
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations de validation pour le mappage proposé.
{
"validationResponse": [
{
"status": "SUCCESS",
"errors": null
},
{
"status": "SUCCESS",
"errors": null
},
{
"status": "SUCCESS",
"errors": null
}
]
}
Aperçu des données pour les mappages
Vous pouvez prévisualiser les données qui seront mappées en envoyant une requête POST au point d’entrée /mappingSets/preview
.
Format d’API
POST /mappingSets/preview
Requête
curl -X POST https://platform.adobe.io/data/foundation/conversion/mappingSets/preview \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"data": [
{
"id": 1234,
"firstName": "Jim",
"lastName": "Seltzer"
}
],
"mappingSet": {
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/stardust/schemas/89abc189258b1cb1a816d8f2b2341a6d98000ed8f4008305",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "id",
"destination": "_id",
"name": "id",
"description": "Identifier field"
},
{
"sourceType": "ATTRIBUTE",
"source": "firstName",
"destination": "person.name.firstName"
},
{
"sourceType": "ATTRIBUTE",
"source": "lastName",
"destination": "person.name.lastName"
}
]
}
}'
Réponse
Une réponse réussie renvoie un statut HTTP 200 avec un aperçu de vos données mappées.
[
{
"data": {
"person": {
"name": {
"firstName": "Jim",
"lastName": "Seltzer"
}
},
"_id": "1234"
},
"errors": null
}
]