查询模板端点

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

主题：

创建对象：

undefined

示例API调用

以下部分描述了您可以使用Query Service API进行的各种API调用。每个调用包括常规API格式、显示所需标头的示例请求以及示例响应。

有关通过Experience PlatformUI创建模板的信息，请参阅UI查询模板文档。

检索查询模板列表

您可以通过向/query-templates端点发出GET请求来检索贵组织的所有查询模板列表。

API格式

GET /query-templates
GET /query-templates?{QUERY_PARAMETERS}

属性

描述

{QUERY_PARAMETERS}

（可选）添加到请求路径的参数，用于配置响应中返回的结果。可以包含多个参数，以&符号(&)分隔。下面列出了可用的参数。

查询参数

以下是列出查询模板的可用查询参数列表。所有这些参数都是可选的。在不使用参数的情况下对此端点进行调用将检索对您的组织可用的所有查询模板。

参数

描述

orderby

指定排序结果所依据的字段。支持的字段为created和updated。例如，orderby=created将按创建的结果以升序排序。在创建之前(orderby=-created)添加-将按创建的顺序降序对项进行排序。

limit

指定页大小限制，以控制页中包含的结果数。（默认值： 20）

start

指定ISO格式时间戳对结果进行排序。如果未指定开始日期，则API调用将首先返回最早创建的模板，然后继续列出更新的结果。
个ISO时间戳允许在日期和时间使用不同级别的粒度。基本ISO时间戳采用2020-09-07格式，表示日期2020年9月7日。一个更复杂的示例将编写为2022-11-05T08:15:30-05:00，对应于2022年11月5日美国东部标准时间上午8:15:30。可以为时区提供UTC偏移量，时区由后缀“Z”(2020-01-01T01:01:01Z)表示。如果未提供时区，则默认设置为0。

property

根据字段筛选结果。筛选器必须进行HTML转义。逗号用于组合多组过滤器。支持的字段为name和userId。唯一支持的运算符是==（等于）。例如，name==my_template将返回名称为my_template的所有查询模板。

请求

以下请求将检索为您的组织创建的最新查询模板。

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

响应

成功的响应返回HTTP状态200，其中包含指定组织的查询模板列表。以下响应会返回为您的组织创建的最新查询模板。

{
    "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
}

NOTE

您可以使用_links.delete的值删除查询模板。

创建查询模板

您可以通过向/query-templates端点发出POST请求来创建查询模板。

API格式

POST /query-templates

请求

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 account_balance FROM user_data WHERE user_id='$user_id';",
        "name": "Sample query template",
        "queryParameters": {
            user_id : {USER_ID}
            }
    }'

属性

描述

sql

要创建的SQL查询。您可以使用标准SQL或参数替换。要在SQL中使用参数替换，必须在参数键前面加上$。例如，$key，并在queryParameters字段中提供SQL中使用的参数作为JSON键值对。此处传递的值将是模板中使用的默认参数。如果要覆盖这些参数，必须在POST请求中覆盖它们。

name

查询模板的名称。

queryParameters

键值配对，用于替换SQL语句中的任何参数化值。只有在您提供的SQL中使用参数替换 if 时才需要。将不对这些键值对执行任何值类型检查。

响应

成功的响应返回HTTP状态202（已接受）以及新创建的查询模板的详细信息。

{
    "sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
    "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\"}"
        }
    }
}

NOTE

您可以使用_links.delete的值删除查询模板。

检索指定的查询模板

您可以通过向/query-templates/{TEMPLATE_ID}端点发出GET请求并在请求路径中提供查询模板的ID来检索特定的查询模板。

API格式

GET /query-templates/{TEMPLATE_ID}

属性

描述

{TEMPLATE_ID}

要检索的查询模板的id值。

请求

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

响应

成功的响应返回HTTP状态200以及指定查询模板的详细信息。

{
    "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\"}"
        }
    }
}

NOTE

您可以使用_links.delete的值删除查询模板。

更新指定的查询模板

您可以通过向/query-templates/{TEMPLATE_ID}端点发出PUT请求并在请求路径中提供查询模板的ID来更新特定的查询模板。

API格式

PUT /query-templates/{TEMPLATE_ID}

属性

描述

{TEMPLATE_ID}

要检索的查询模板的id值。

请求

NOTE

PUT请求要求填写sql和名称字段，并将覆盖该查询模板的当前内容。

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 account_balance FROM user_data WHERE user_id='$user_id';",
    "name": "Sample query template",
    "queryParameters": {
            user_id : {USER_ID}
        }
    }'

属性

描述

sql

name

查询模板的名称。

queryParameters

键值配对，用于替换SQL语句中的任何参数化值。只有在您提供的SQL中使用参数替换 if 时才需要。将不对这些键值对执行任何值类型检查。

响应

成功的响应会返回HTTP状态202（已接受），其中包含指定查询模板的更新信息。

{
    "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\"}"
        }
    }
}

NOTE

您可以使用_links.delete的值删除查询模板。

删除指定的查询模板

您可以通过向/query-templates/{TEMPLATE_ID}发出DELETE请求并在请求路径中提供查询模板的ID来删除特定的查询模板。

API格式

DELETE /query-templates/{TEMPLATE_ID}

属性

描述

{TEMPLATE_ID}

要检索的查询模板的id值。

请求

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

响应

成功的响应返回HTTP状态202（已接受），并显示以下消息。

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

recommendation-more-help

ccf2b369-4031-483f-af63-a93b5ae5e3fb