Ponto de extremidade de modelos de consulta

Exemplos de chamadas de API

As seções a seguir descrevem as várias chamadas de API que podem ser feitas usando o Query Service API. Cada chamada inclui o formato da API geral, uma solicitação de amostra que mostra os cabeçalhos necessários e uma resposta de amostra.

Consulte a Documentação dos modelos de consulta da interface do usuário para obter informações sobre como criar modelos por meio da interface do usuário do Experience Platform.

Recuperar uma lista de templates de query

Você pode recuperar uma lista de todos os modelos de consulta para sua Organização IMS fazendo uma solicitação de GET para a /query-templates endpoint .

Formato da API

GET /query-templates
GET /query-templates?{QUERY_PARAMETERS}
Propriedade Descrição
{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

Esta é uma lista de parâmetros de consulta disponíveis para listar templates de query. Todos esses parâmetros são opcionais. Fazer uma chamada para esse terminal sem parâmetros recuperará todos os modelos de consulta disponíveis para sua organização.

Parâmetro Descrição
orderby Especifica o campo pelo qual ordenar os resultados. Os campos compatíveis são created e updated. Por exemplo, orderby=created classificará os resultados por criados em ordem crescente. Adicionar um - antes de criar (orderby=-created) classificará os itens por criados em ordem decrescente.
limit Especifica o limite de tamanho de página para controlar o número de resultados incluídos em uma página. (Valor padrão: 20º)
start Desloca a lista de resposta usando a numeração baseada em zero. Por exemplo, start=2 retornará uma lista a partir da terceira query listada. (Valor padrão: 0)
property Filtre os resultados com base nos campos. Os filtros must ser HTML escapado. Vírgulas são usadas para combinar vários conjuntos de filtros. Os campos compatíveis são name e userId. O único operador suportado é == (igual a). Por exemplo, name==my_template retornará todos os modelos de consulta com o nome my_template.

Solicitação

A solicitação a seguir recupera o modelo de consulta mais recente criado para sua organização IMS.

curl -X GET https://platform.adobe.io/data/foundation/query/query-templates?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 modelos de consulta para a Organização IMS especificada. A resposta a seguir retorna o modelo de consulta mais recente criado para sua organização IMS.

{
    "templates": [
        {
            "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n",
            "name": "Test",
            "id": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
            "updated": "2019-11-21T21:50:01.469Z",
            "userId": "{USER_ID}",
            "created": "2019-11-21T21:50:01.469Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "DELETE"
                },
                "update": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "PUT",
                    "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
                }
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-11-21T21:50:01.469Z",
        "next": "2019-11-21T21:50:01.469Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z&isPrevLink=true"
        }
    },
    "version": 1
}
OBSERVAÇÃO

Você pode usar o valor de _links.delete para excluir seu modelo de consulta.

Criar um modelo de consulta

Você pode criar um template de query fazendo uma solicitação POST para a variável /query-templates endpoint .

Formato da API

POST /query-templates

Solicitação

curl -X POST https://platform.adobe.io/data/foundation/query/query-templates
 -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}'
 -d '{
        "sql": "SELECT * FROM accounts;",
        "name": "Sample query template"
    }'
Propriedade Descrição
sql A consulta SQL que você deseja criar.
name O nome do template de query.

Resposta

Uma resposta bem-sucedida retorna o status HTTP 202 (Accepted) com detalhes do modelo de consulta recém-criado.

{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}
OBSERVAÇÃO

Você pode usar o valor de _links.delete para excluir seu modelo de consulta.

Recuperar um modelo de consulta especificado

Você pode recuperar um template de query específico fazendo uma solicitação do GET para o /query-templates/{TEMPLATE_ID} e fornecer a ID do modelo de consulta no caminho da solicitação.

Formato da API

GET /query-templates/{TEMPLATE_ID}
Propriedade Descrição
{TEMPLATE_ID} O id valor do template de query que deseja recuperar.

Solicitação

curl -X GET https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -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 detalhes do modelo de consulta especificado.

{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "A5A562D15E1645480A495CE1@techacct.adobe.com",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}
OBSERVAÇÃO

Você pode usar o valor de _links.delete para excluir seu modelo de consulta.

Atualizar um modelo de consulta especificado

Você pode atualizar um template de query específico fazendo uma solicitação de PUT para a variável /query-templates/{TEMPLATE_ID} e fornecer a ID do modelo de consulta no caminho da solicitação.

Formato da API

PUT /query-templates/{TEMPLATE_ID}
Propriedade Descrição
{TEMPLATE_ID} O id valor do template de query que deseja recuperar.

Solicitação

OBSERVAÇÃO

A solicitação de PUT requer que o sql e o campo de nome sejam preenchidos e o substituir o conteúdo atual desse template de query.

curl -X PUT https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -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}'
 -d '{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template"
 }'
Propriedade Descrição
sql A consulta SQL que você deseja atualizar.
name O nome da consulta agendada.

Resposta

Uma resposta bem-sucedida retorna o status HTTP 202 (Accepted) com as informações atualizadas para seu template de query especificado.

{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:29:20.028Z",
    "lastUpdatedBy": "{USER_ID}",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\": \"new sql \", \"name\": \"new name\"}"
        }
    }
}
OBSERVAÇÃO

Você pode usar o valor de _links.delete para excluir seu modelo de consulta.

Excluir um modelo de consulta especificado

Você pode excluir um modelo de consulta específico fazendo uma solicitação DELETE para a variável /query-templates/{TEMPLATE_ID} e fornecer a ID do modelo de consulta no caminho da solicitação.

Formato da API

DELETE /query-templates/{TEMPLATE_ID}
Propriedade Descrição
{TEMPLATE_ID} O id valor do template de query que deseja recuperar.

Solicitação

curl -X DELETE https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -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 202 (Accepted) com a seguinte mensagem.

{
    "message": "Deleted",
    "statusCode": 202
}

Nesta página