Documentation Experience Platform Guide des catalogues et des jeux de données

Recherche d’un objet Catalogue

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :
Catalogue

Créé pour :

Développeur

Si vous connaissez l’identifiant unique d’un objet Catalog spécifique, vous pouvez exécuter une requête de GET pour afficher les détails de cet objet.

NOTE

Lors de l’affichage d’objets spécifiques, il est toujours recommandé de filtrer par propriétés et de renvoyer uniquement les propriétés qui vous intéressent.

Format d’API

GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}

Paramètre

Description

{OBJECT_TYPE}

Type d’objet Catalog à récupérer. Les objets valides sont :

batches
dataSets
dataSetFiles

{OBJECT_ID}

L’identifiant de l’objet spécifique que vous souhaitez récupérer.

Requête

La requête suivante récupère un jeu de données à l’aide de son identifiant, renvoyant ses propriétés name, description, tags et files.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a?properties=name,description,tags,files' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie le jeu de données spécifié contenant uniquement les properties demandées dans le corps.

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset",
        "description": "Sample dataset containing important data.",
        "tags": {
            "adobe/pqs/table": [
                "sample_dataset"
            ]
        },
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    }
}

NOTE

Les propriétés dont les valeurs comportent le préfixe @ représentent des objets interconnectés. Consultez la section de l’annexe sur l’affichage des objets interconnectés pour savoir comment afficher les détails de ces objets.

recommendation-more-help