查詢範本端點

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

主題：
查詢

建立對象：

開發人員

API呼叫範例

以下各節說明您可以使用Query Service API進行的各種API呼叫。每個呼叫都包含一般API格式、顯示必要標題的範例要求以及範例回應。

如需透過Experience PlatformUI建立範本的資訊，請參閱UI查詢範本檔案。

擷取查詢範本清單

您可以對/query-templates端點發出GET要求，以擷取貴組織的所有查詢範本清單。

API格式

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

屬性

說明

{QUERY_PARAMETERS}

(Optional)將引數新增至要求路徑，以設定回應中傳回的結果。可以包含多個引數，以&符號(&)分隔。可用的引數列示如下。

查詢引數

以下是列出查詢範本的可用查詢引數清單。所有這些引數都是選用的。在不使用引數的情況下呼叫此端點將會擷取您的組織可用的所有查詢範本。

參數

說明

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)表示。如果未提供時區，則預設為零。

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要求，並在要求路徑中提供查詢範本的識別碼，以擷取特定的查詢範本。

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要求，並在要求路徑中提供查詢範本的識別碼，以更新特定的查詢範本。

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要求，並在要求路徑中提供查詢範本的識別碼，以刪除特定的查詢範本。

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