Dokumentation Experience Platform Användarhandbok om Query Service

Frågemallar, slutpunkt

Last update: Wed Feb 28 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Queries

Skapat för:

Developer

Exempel på API-anrop

I följande avsnitt beskrivs de olika API-anropen som du kan göra med Query Service API. Varje anrop innehåller det allmänna API-formatet, en exempelbegäran med obligatoriska rubriker och ett exempelsvar.

Se Dokumentation för UI-frågemallar om du vill ha information om hur du skapar mallar i användargränssnittet för Experience Platform.

Hämta en lista med frågemallar

Du kan hämta en lista med alla frågemallar för din organisation genom att göra en GET-förfrågan till /query-templates slutpunkt.

API-format

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

Egenskap

Beskrivning

{QUERY_PARAMETERS}

(Valfritt) Parametrar har lagts till i den begärda sökvägen som konfigurerar resultaten som returneras i svaret. Flera parametrar kan inkluderas, avgränsade med et-tecken (&). De tillgängliga parametrarna visas nedan.

Frågeparametrar

Här följer en lista med tillgängliga frågeparametrar för att lista frågemallar. Alla dessa parametrar är valfria. Om du anropar den här slutpunkten utan parametrar hämtas alla frågemallar som är tillgängliga för din organisation.

Parameter

Beskrivning

orderby

Anger fältet som resultaten ska sorteras efter. De fält som stöds är created och updated. Till exempel: orderby=created sorterar resultaten efter att de har skapats i stigande ordning. Lägga till en - före skapande (orderby=-created) sorterar objekt efter att de har skapats i fallande ordning.

limit

Anger sidstorleksgränsen för att styra antalet resultat som ska inkluderas på en sida. (Standardvärde: 20)

start

Ange en tidsstämpel för ISO-format för att beställa resultaten. Om inget startdatum anges returnerar API-anropet de äldsta mallarna först och fortsätter sedan att visa de senaste resultaten.
ISO-tidsstämplar tillåter olika nivåer av granularitet för datum och tid. De grundläggande ISO-tidsstämplarna har formatet: 2020-09-07 för att uttrycka datumet 7 september 2020. Ett mer komplext exempel skulle skrivas som 2022-11-05T08:15:30-05:00 och motsvarar 5 november 2022, 8:15:30.00, US Eastern Standard Time. En tidszon kan anges med en UTC-förskjutning och markeras med suffixet "Z" (2020-01-01T01:01:01Z). Om ingen tidszon anges är standardvärdet noll.

property

Filtrera resultat baserat på fält. Filtren måste Bli HTML rymd. Kommandon används för att kombinera flera uppsättningar filter. De fält som stöds är name och userId. Den enda operatorn som stöds är == (lika med). Till exempel: name==my_template returnerar alla frågemallar med namnet my_template.

Begäran

Följande begäran hämtar den senaste frågemallen som har skapats för din organisation.

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

Svar

Ett godkänt svar returnerar HTTP-status 200 med en lista över frågemallar för den angivna organisationen. Följande svar returnerar den senaste frågemallen som har skapats för din organisation.

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

Du kan använda värdet för _links.delete till ta bort frågemallen.

Skapa en frågemall

Du kan skapa en frågemall genom att göra en POST-förfrågan till /query-templates slutpunkt.

API-format

POST /query-templates

Begäran

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

Egenskap

Beskrivning

sql

Den SQL-fråga som du vill skapa. Du kan antingen använda standard-SQL eller en parameterersättning. Om du vill använda en parameterersättning i SQL måste parameternyckeln föregås av en $. Till exempel: $keyoch ange parametrarna som används i SQL som JSON-nyckelvärdepar i queryParameters fält. De värden som skickas här är standardparametrarna som används i mallen. Om du vill åsidosätta de här parametrarna måste du åsidosätta dem i POSTEN.

name

Namnet på frågemallen.

queryParameters

Ett nyckelvärdepar som ersätter parametriserade värden i SQL-satsen. Endast obligatoriskt if du använder parameterersättningar i den SQL som du anger. Ingen värdetypskontroll utförs för dessa nyckelvärdepar.

Svar

Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med information om den nya frågemallen.

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

Du kan använda värdet för _links.delete till ta bort frågemallen.

Hämta en angiven frågemall

Du kan hämta en viss frågemall genom att göra en GET-förfrågan till /query-templates/{TEMPLATE_ID} slutpunkt och ange ID för frågemallen i sökvägen för begäran.

API-format

GET /query-templates/{TEMPLATE_ID}

Egenskap

Beskrivning

{TEMPLATE_ID}

The id värdet för den frågemall som du vill hämta.

Begäran

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

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om den angivna frågemallen.

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

Du kan använda värdet för _links.delete till ta bort frågemallen.

Uppdatera en angiven frågemall

Du kan uppdatera en viss frågemall genom att göra en PUT-förfrågan till /query-templates/{TEMPLATE_ID} slutpunkt och ange ID för frågemallen i sökvägen för begäran.

API-format

PUT /query-templates/{TEMPLATE_ID}

Egenskap

Beskrivning

{TEMPLATE_ID}

The id värdet för den frågemall som du vill hämta.

Begäran

NOTE

Begäran från PUT kräver att både sql- och namnfältet fylls i och kommer att skriv över det aktuella innehållet i den frågemallen.

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

Egenskap

Beskrivning

sql

name

Namnet på frågemallen.

queryParameters

Svar

Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med den uppdaterade informationen för den angivna frågemallen.

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

Du kan använda värdet för _links.delete till ta bort frågemallen.

Ta bort en angiven frågemall

Du kan ta bort en viss frågemall genom att göra en DELETE-förfrågan till /query-templates/{TEMPLATE_ID} och tillhandahåller ID för frågemallen i sökvägen för begäran.

API-format

DELETE /query-templates/{TEMPLATE_ID}

Egenskap

Beskrivning

{TEMPLATE_ID}

The id värdet för den frågemall som du vill hämta.

Begäran

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

Svar

Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med följande meddelande.

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

recommendation-more-help

ccf2b369-4031-483f-af63-a93b5ae5e3fb