objetos de lista

É possível recuperar uma lista de todos os objetos disponíveis de um tipo específico por meio de uma única chamada de API, com a prática recomendada de incluir filtros que limitam o tamanho da resposta.

Formato da API

GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
Parâmetro Descrição
{OBJECT_TYPE} O tipo de Catalog objeto a ser listado. Objetos válidos são:
  • accounts
  • batches
  • connections
  • connectors
  • dataSets
  • dataSetFiles
  • dataSetViews
{FILTER} Um parâmetro de query usado para filtrar os resultados retornados na resposta. Vários parâmetros são separados por E comercial (&). Consulte o guia sobre como filtrar dados do catálogo para obter mais informações.

Solicitação

A solicitação de amostra abaixo recupera uma lista de conjuntos de dados, com um limit filtro reduzindo a resposta a cinco resultados, e um properties filtro que limita as propriedades exibidas para cada conjunto de dados.

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

Resposta

Uma resposta bem-sucedida retorna uma lista de Catalog objetos na forma de pares de valores chave, filtrados pelos parâmetros de query fornecidos na solicitação. Para cada par de valores-chave, a chave representa um identificador exclusivo para o Catalog objeto em questão, que pode ser usado em outra chamada para visualização desse objeto específico para obter mais detalhes.

Observação

Se um objeto retornado não contiver uma ou mais das propriedades solicitadas indicadas pelo properties query, a resposta retornará somente as propriedades solicitadas que ela inclui, conforme mostrado em Sample Dataset 3 e Sample Dataset 4 abaixo.

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSets/5bb276b03a14440000971552/views/5bb276b01250b012f9acc75b/files"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSets/5bda3a4228babc0000126377/views/5bda3a4228babc0000126378/files"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSets/5bde21511dd27b0000d24e95/views/5bde21511dd27b0000d24e96/files"
    }
}

Nesta página