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

Pesquisar vários objetos de Catálogo

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

Criado para:

  • Desenvolvedor

Se quiser exibir vários objetos específicos, em vez de fazer uma solicitação por objeto, o Catalog fornece um atalho simples para solicitar vários objetos do mesmo tipo. Você pode usar uma única solicitação do GET para retornar vários objetos específicos incluindo uma lista de IDs separadas por vírgulas.

NOTE
Mesmo ao solicitar objetos Catalog específicos, ainda é prática recomendada properties consultar parâmetro para retornar apenas as propriedades que você precisa.

Formato da API

GET /{OBJECT_TYPE}/{ID_1},{ID_2},{ID_3},{ID_4}
GET /{OBJECT_TYPE}/{ID_1},{ID_2},{ID_3},{ID_4}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
Parâmetro
Descrição
{OBJECT_TYPE}

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

  • batches
  • dataSets
  • dataSetFiles
{ID}
Um identificador para um dos objetos específicos que você deseja recuperar.

Solicitação

A solicitação a seguir inclui uma lista separada por vírgulas de IDs de conjunto de dados, bem como uma lista separada por vírgulas de propriedades a serem retornadas para cada conjunto de dados.

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5bde21511dd27b0000d24e95,5bda3a4228babc0000126377,5bceaa4c26c115000039b24b,5bb276b03a14440000971552,5ba9452f7de80400007fc52a?properties=name,description,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 uma lista dos conjuntos de dados especificados, contendo apenas as propriedades solicitadas (name, description e files) para cada um.

NOTE
Se um objeto retornado não contiver uma ou mais das propriedades solicitadas indicadas pela consulta properties, a resposta retornará apenas as propriedades solicitadas que ela não inclui, conforme mostrado em Sample Dataset 3 e Sample Dataset 4 abaixo.
{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bb276b03a14440000971552"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSetFiles?dataSetId=5bda3a4228babc0000126377"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bde21511dd27b0000d24e95"
    }
}
recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676