DocumentaçãoExperience PlatformGuia de catálogo e conjuntos de dados

Pesquisar um objeto de Catálogo

Last update: Wed Dec 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Developer

Se você souber o identificador exclusivo de um Catalog objeto, você pode executar uma solicitação GET para exibir os detalhes desse objeto.

NOTE
Ao visualizar objetos específicos, ainda é prática recomendada filtrar por propriedades e retornam somente as propriedades em que você está interessado.

Formato da API

GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
Parâmetro
Descrição
{OBJECT_TYPE}

O tipo de Catalog objeto a ser recuperado. Os objetos válidos são:

  • batches
  • dataSets
  • dataSetFiles
{OBJECT_ID}
O identificador do objeto específico que você deseja recuperar.

Solicitação

A solicitação a seguir recupera um conjunto de dados por sua ID, retornando seu name, description, tags, e files propriedades.

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

Resposta

Uma resposta bem-sucedida retorna o conjunto de dados especificado somente com o properties no corpo.

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset",
        "description": "Sample dataset containing important data.",
        "tags": {
            "adobe/pqs/table": [
                "sample_dataset"
            ]
        },
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    }
}
NOTE
Propriedades cujos valores recebem o prefixo @ representam objetos inter-relacionados. Consulte a seção do apêndice sobre exibição de objetos inter-relacionados para obter etapas sobre como visualizar os detalhes desses objetos.
recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676