Endpoint de consultas

Última atualização: 16 de julho de 2024
  • Tópicos:

Criado para:

  • Desenvolvedor

Exemplos de chamadas de API

As seções a seguir abordam chamadas que você pode fazer usando o ponto de extremidade /queries na API Query Service. Cada chamada inclui o formato da API geral, uma solicitação de amostra mostrando os cabeçalhos necessários e uma resposta de amostra.

Recuperar uma lista de consultas

Você pode recuperar uma lista de todas as consultas para sua organização fazendo uma solicitação GET para o ponto de extremidade /queries.

Formato da API

GET /queries
GET /queries?{QUERY_PARAMETERS}
  • {QUERY_PARAMETERS}: (Opcional) Parâmetros adicionados ao caminho da solicitação que configuram os resultados retornados na resposta. Vários parâmetros podem ser incluídos, separados por "E" comercial (&). Os parâmetros disponíveis estão listados abaixo.

Parâmetros de consulta

Veja a seguir uma lista de parâmetros de consulta disponíveis para consultas de listagem. Todos esses parâmetros são opcionais. Fazer uma chamada para esse endpoint sem parâmetros recuperará todas as consultas disponíveis para sua organização.

ParâmetroDescrição
orderbyEspecifica o campo pelo qual ordenar resultados. Os campos com suporte são created e updated. Por exemplo, orderby=created classificará os resultados por ordem crescente criada. Adicionar um - antes de criar (orderby=-created) classificará os itens por ordem decrescente.
limitEspecifica o limite de tamanho de página para controlar o número de resultados incluídos em uma página. (Valor padrão: 20)
startEspecifique um carimbo de data e hora no formato ISO para ordenar os resultados. Se nenhuma data de início for especificada, a chamada à API retornará primeiro a consulta criada mais antiga e, em seguida, continuará a listar os resultados mais recentes.Os carimbos de data e hora ISO
permitem diferentes níveis de granularidade na data e hora. Os carimbos de data e hora ISO básicos assumem o formato de: 2020-09-07 para expressar a data em 7 de setembro de 2020. Um exemplo mais complexo seria escrito como 2022-11-05T08:15:30-05:00 e corresponde a 5 de novembro de 2022, às 8:15:30 am, Hora Padrão do Leste dos EUA. Um fuso horário pode ser fornecido com um deslocamento UTC e é indicado pelo sufixo "Z" (2020-01-01T01:01:01Z). Se nenhum fuso horário for fornecido, o padrão será zero.
propertyFiltrar resultados com base em campos. Os filtros devem ter HTML de escape. As vírgulas são usadas para combinar vários conjuntos de filtros. Os campos com suporte são created, updated, state e id. A lista de operadores com suporte é > (maior que), < (menor que), >= (maior ou igual a), <= (menor ou igual a), == (igual a), != (diferente de) e ~ (contém). Por exemplo, id==6ebd9c2d-494d-425a-aa91-24033f3abeec retornará todas as consultas com a ID especificada.
excludeSoftDeletedIndica se uma consulta que foi excluída por software deve ser incluída. Por exemplo, excludeSoftDeleted=false irá incluir consultas excluídas por software. (Booleano, valor padrão: true)
excludeHiddenIndica se as consultas não orientadas por usuário devem ser exibidas. Se este valor for definido como falso incluirá consultas não orientadas por usuário, como definições de CURSOR, BUSCAR ou consultas de metadados. (Booleano, valor padrão: true)
isPrevLinkO parâmetro de consulta isPrevLink é usado para paginação. Os resultados da chamada de API são classificados usando o carimbo de data/hora created e a propriedade orderby. Ao navegar pelas páginas de resultados, isPrevLink é definido como verdadeiro quando a página é retroativa. Inverte a ordem da consulta. Consulte os links "próximo" e "anterior" como exemplos.

Solicitação

A solicitação a seguir recupera a consulta mais recente criada para sua organização.

curl -X GET https://platform.adobe.io/data/foundation/query/queries?limit=1 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com uma lista de consultas para a organização especificada como JSON. A resposta a seguir retorna a consulta mais recente criada para sua organização.

{
    "queries": [
        {
            "isInsertInto": false,
            "request": {
                "dbName": "prod:all",
                "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n"
            },
            "state": "SUCCESS",
            "rowCount": 0,
            "errors": [],
            "isCTAS": false,
            "version": 1,
            "id": "9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
            "elapsedTime": 28,
            "updated": "2019-12-06T22:00:17.390Z",
            "client": "Adobe Query Service UI",
            "userId": "{USER_ID}",
            "created": "2019-12-06T22:00:17.362Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "GET"
                },
                "soft_delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "PATCH",
                    "body": "{ \"op\": \"soft_delete\"}"
                },
                "referenced_datasets": [
                    {
                        "id": "5b2bdd32230d4401de87397c",
                        "href": "https://platform.adobe.io/data/foundation/catalog/dataSets/5b2bdd32230d4401de87397c"
                    }
                ]
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-12-06T22:00:17.362Z",
        "next": "2019-08-01T00:14:21.748Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-08-01T00:14:21.748Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-12-06T22:00:17.362Z&isPrevLink=true"
        }
    },
    "version": 1
}