Recherche d’un objet Catalogue

Dernière mise à jour : 2023-12-06
  • Rubriques :
  • Catalog
    Afficher plus sur ce sujet
  • Créé pour :
  • Developer
    User
    Admin
    Leader

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

REMARQUE

Lors de l’affichage d’objets spécifiques, il est toujours recommandé de filtre par propriétés et ne renvoient que 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} Le type de 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 son name, description, tags, et files propriétés.

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"
    }
}
REMARQUE

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.

Sur cette page