Documentatie Experience Platform Handleiding voor catalogi en gegevenssets

Een catalogusobject opzoeken

Laatst bijgewerkt: 16 juli 2024

Onderwerpen:
Catalogus

Gemaakt voor:

Ontwikkelaar

Als u de unieke id voor een specifiek Catalog -object kent, kunt u een GET-aanvraag uitvoeren om de details van dat object weer te geven.

NOTE

Wanneer het bekijken van specifieke voorwerpen, is het nog beste praktijken aan filter door eigenschappenen terugkeer slechts de eigenschappen u geinteresseerd bent in.

API formaat

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

Parameter Beschrijving

Parameter	Beschrijving
`{OBJECT_TYPE}`	Het type Catalog -object dat moet worden opgehaald. Geldige objecten zijn: `batches` `dataSets` `dataSetFiles`
`{OBJECT_ID}`	De id van het specifieke object dat u wilt ophalen.

{OBJECT_TYPE}

Het type Catalog -object dat moet worden opgehaald. Geldige objecten zijn:

batches
dataSets
dataSetFiles

{OBJECT_ID} De id van het specifieke object dat u wilt ophalen.

Verzoek

Met de volgende aanvraag wordt een gegevensset opgehaald op basis van de id en worden de eigenschappen name , description , tags en files geretourneerd.

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}'

Reactie

Een succesvolle reactie keert de gespecificeerde dataset met slechts gevraagde properties in het lichaam terug.

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

NOTE

Eigenschappen waarvan de waarden vooraf met @ zijn ingesteld, vertegenwoordigen onderling verwante objecten. Zie de appendix sectie op het bekijken van onderling verwant voorwerpenvoor stappen op hoe te om de details van deze voorwerpen te bekijken.

recommendation-more-help