Dokumentation Experience Platform Användarhandbok om Query Service

Frågeslutpunkt

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

Ämnen:
Frågor

Skapat för:

Utvecklare

Exempel på API-anrop

Följande avsnitt går igenom anrop som du kan göra med slutpunkten /queries i API:t Query Service. Varje anrop innehåller det allmänna API-formatet, en exempelbegäran med obligatoriska rubriker och ett exempelsvar.

Hämta en lista med frågor

Du kan hämta en lista med alla frågor för din organisation genom att göra en GET-förfrågan till slutpunkten /queries.

API-format

GET /queries
GET /queries?{QUERY_PARAMETERS}

{QUERY_PARAMETERS}: (Valfria) Parametrar har lagts till i sökvägen för begäran 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ågor. Alla dessa parametrar är valfria. Om du anropar den här slutpunkten utan parametrar hämtas alla frågor 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. orderby=created sorterar till exempel resultat efter skapade i stigande ordning. Om du lägger till en - före skapad (orderby=-created) sorteras 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 den äldsta frågan 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. Grundläggande ISO-tidsstämplar har formatet 2020-09-07 för att uttrycka datumet 7 september 2020. Ett mer komplext exempel skrivs som 2022-11-05T08:15:30-05:00 och motsvarar 5 november 2022, 8:15:30 am, US Eastern Standard Time. En tidszon kan anges med en UTC-förskjutning och anges 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 vara HTML escape. Kommandon används för att kombinera flera uppsättningar filter. De fält som stöds är created, updated, state och id. Listan med operatorer som stöds är > (större än), < (mindre än), >= (större än eller lika med), <= (mindre än eller lika med), == (lika med), != (inte lika med) och ~ (innehåller). id==6ebd9c2d-494d-425a-aa91-24033f3abeec returnerar till exempel alla frågor med det angivna ID:t.

excludeSoftDeleted

Anger om en fråga som har tagits bort ska tas med. excludeSoftDeleted=false kommer till exempel att inkludera mjuka borttagna frågor. (Boolean, standardvärde: true)

excludeHidden

Anger om icke-användardrivna frågor ska visas. Om värdet är false inkluderar icke-användardrivna frågor, som CURSOR-definitioner, FETCH eller metadatafrågor. (Boolean, standardvärde: true)

isPrevLink

Frågeparametern isPrevLink används för sidnumrering. Resultaten av API-anropet sorteras med hjälp av deras created-tidsstämpel och egenskapen orderby. När du navigerar på resultatsidorna anges isPrevLink till true vid sidindelning bakåt. Den ändrar ordningen på frågan. Se länkarna "next" och "prev" som exempel.

Begäran

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

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

Svar

Ett lyckat svar returnerar HTTP-status 200 med en lista över frågor för den angivna organisationen som JSON. Följande svar returnerar den senaste frågan som skapats för din organisation.

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

Skapa en fråga

Du kan skapa en ny fråga genom att göra en POST-förfrågan till slutpunkten /queries.

API-format

POST /queries

Begäran

I följande begäran skapas en ny fråga med en SQL-sats i nyttolasten:

curl -X POST https://platform.adobe.io/data/foundation/query/queries \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
        "queryParameters": {
            user_id : {USER_ID}
            }
        "name": "Sample Query",
        "description": "Sample Description"
    }

I exemplet nedan skapas en ny fråga med hjälp av ett befintligt frågemall-ID.

curl -X POST https://platform.adobe.io/data/foundation/query/queries \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "templateID": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
        "name": "Sample Query",
        "description": "Sample Description"
    }

Egenskap

Beskrivning

dbName

Namnet på den databas som du skapar en SQL-fråga för.

sql

Den SQL-fråga som du vill skapa.

name

Namnet på SQL-frågan.

description

Beskrivningen av SQL-frågan.

queryParameters

Ett nyckelvärdepar som ersätter parametriserade värden i SQL-satsen. Det krävs bara om du använder parameterersättningar i den SQL som du anger. Ingen värdetypskontroll utförs för dessa nyckelvärdepar.

templateId

Den unika identifieraren för en befintlig fråga. Du kan ange detta i stället för en SQL-sats.

insertIntoParameters

(Valfritt) Om den här egenskapen är definierad konverteras frågan till en INSERT INTO-fråga.

ctasParameters

(Valfritt) Om den här egenskapen är definierad konverteras frågan till en CTAS-fråga.

Svar

Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med information om din nya fråga. När frågan har aktiverats och körts ändras state från SUBMITTED till SUCCESS.

{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}

NOTE

Du kan använda värdet _links.cancel för att avbryta den skapade frågan.

Hämta en fråga via ID

Du kan hämta detaljerad information om en viss fråga genom att göra en GET-förfrågan till /queries-slutpunkten och ange frågans id-värde i begärandesökvägen.

API-format

GET /queries/{QUERY_ID}

Egenskap

Beskrivning

{QUERY_ID}

Värdet id för frågan som du vill hämta.

Begäran

curl -X GET https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -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 detaljerad information om den angivna frågan.

{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}

NOTE

Du kan använda värdet _links.cancel för att avbryta den skapade frågan.

Avbryt eller mjuka borttagningar av en fråga

Du kan begära att få ta bort eller avbryta en angiven fråga genom att göra en PATCH-begäran till /queries-slutpunkten och ange frågans id-värde i sökvägen för begäran.

API-format

PATCH /queries/{QUERY_ID}

Parameter

Beskrivning

{QUERY_ID}

Värdet id för frågan som du vill utföra åtgärden på.

Begäran

Denna API-begäran använder JSON Patch-syntaxen för sin nyttolast. Mer information om hur JSON Patch fungerar finns i dokumentet om grundläggande API:er.

curl -X PATCH https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json',
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
   "op": "cancel"
 }'

Egenskap

Beskrivning

op

Den typ av åtgärd som ska utföras på resursen. Godkända värden är cancel och soft_delete. Om du vill avbryta frågan måste du ange parametern op med värdet cancel . Observera att mjuk borttagning gör att frågan inte returneras vid GET-begäranden, men att den inte tas bort från systemet.

Svar

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

{
    "message": "Query cancel request received",
    "statusCode": 202
}

recommendation-more-help

ccf2b369-4031-483f-af63-a93b5ae5e3fb