Nu när du förstår vilka rubriker du ska använda kan du börja ringa till Query Service API. Följande avsnitt går igenom 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.
Du kan hämta en lista över alla schemalagda frågor för din organisation genom att göra en GET-förfrågan till /schedules
slutpunkt.
API-format
GET /schedules
GET /schedules?{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 schemalagda frågor. Alla dessa parametrar är valfria. Om du anropar den här slutpunkten utan parametrar hämtas alla schemalagda 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 . 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 |
Förskjuter svarslistan med nollbaserad numrering. Till exempel: start=2 kommer att returnera en lista med början från den tredje listade frågan. (Standardvärde: 0) |
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 created , templateId och userId . Listan med operatorer som stöds är > (större än), < (mindre än), och == (lika med). Till exempel: userId==6ebd9c2d-494d-425a-aa91-24033f3abeec returnerar alla schemalagda frågor där användar-ID:t är angivet. |
Begäran
Följande begäran hämtar den senaste schemalagda frågan som har skapats för din organisation.
curl -X GET https://platform.adobe.io/data/foundation/query/schedules?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 schemalagda frågor för den angivna organisationen. Följande svar returnerar den senaste schemalagda frågan som skapats för din organisation.
{
"schedules": [
{
"state": "ENABLED",
"query": {
"dbName": "prod:all",
"sql": "SELECT * FROM accounts;",
"name": "Sample Scheduled Query",
"description": "A sample of a scheduled query."
},
"updatedUserId": "{USER_ID}",
"version": 2,
"id": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"updated": "1578523458919",
"schedule": {
"schedule": "30 * * * *",
"startDate": "2020-01-08T12:30:00.000Z",
"maxActiveRuns": 1
},
"userId": "{USER_ID}",
"created": "1578523458919",
"_links": {
"enable": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "PATCH",
"body": "{ \"op\": \"enable\" }"
},
"runs": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
"method": "GET"
},
"self": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "DELETE"
},
"disable": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "PATCH",
"body": "{ \"op\": \"disable\" }"
},
"trigger": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
"method": "POST"
}
}
}
],
"_page": {
"orderby": "+created",
"start": "2020-01-08T22:44:18.919Z",
"count": 1
},
"_links": {},
"version": 2
}
Du kan skapa en ny schemalagd fråga genom att göra en POST-förfrågan till /schedules
slutpunkt. När du skapar en schemalagd fråga i API:t kan du även se den i Frågeredigeraren. Mer information om schemalagda frågor i användargränssnittet finns i Dokumentation för Frågeredigeraren.
API-format
POST /schedules
Begäran
curl -X POST https://platform.adobe.io/data/foundation/query/schedules
-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 '
{
"query": {
"dbName": "prod:all",
"sql": "SELECT * FROM accounts;",
"name": "Sample Scheduled Query",
"description": "A sample of a scheduled query."
},
"schedule": {
"schedule": "30 * * * *",
"startDate": "2020-01-08T12:30:00.000Z"
}
}
'
Egenskap | Beskrivning |
---|---|
query.dbName |
Namnet på databasen som du skapar en schemalagd fråga för. |
query.sql |
Den SQL-fråga som du vill skapa. |
query.name |
Namnet på den schemalagda frågan. |
schedule.schedule |
Kronschemat för frågan. Mer information om kundscheman finns i cron, uttrycksformat dokumentation. I det här exemplet betyder "30 * * *" att frågan kommer att köras varje timme vid 30 minuters markering. Du kan också använda följande kortkommandouttryck:
|
schedule.startDate |
Startdatumet för den schemalagda frågan, skrivet som en UTC-tidsstämpel. |
Svar
Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med information om din nyligen skapade schemalagda fråga. När den schemalagda frågan har aktiverats, state
ändras från REGISTERING
till ENABLED
.
{
"state": "REGISTERING",
"query": {
"dbName": "prod:all",
"sql": "SELECT * FROM accounts;",
"name": "Sample Scheduled Query",
"description": "A sample of a scheduled query."
},
"updatedUserId": "{USER_ID}",
"version": 2,
"id": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"schedule": {
"schedule": "30 * * * *",
"startDate": "2020-01-08T12:30:00.000Z",
"maxActiveRuns": 1
},
"userId": "{USER_ID}",
"_links": {
"enable": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "PATCH",
"body": "{ \"op\": \"enable\" }"
},
"runs": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
"method": "GET"
},
"self": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "DELETE"
},
"disable": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "PATCH",
"body": "{ \"op\": \"disable\" }"
},
"trigger": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
"method": "POST"
}
}
}
Du kan använda värdet för _links.delete
till ta bort din skapade schemalagda fråga.
Du kan hämta information för en viss schemalagd fråga genom att göra en GET-förfrågan till /schedules
slutpunkt och ange dess ID i sökvägen för begäran.
API-format
GET /schedules/{SCHEDULE_ID}
Egenskap | Beskrivning |
---|---|
{SCHEDULE_ID} |
The id värdet för den schemalagda fråga som du vill hämta. |
Begäran
curl -X GET https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
-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 schemalagda frågan.
{
"state": "ENABLED",
"query": {
"dbName": "prod:all",
"sql": "SELECT * FROM accounts;",
"name": "Sample Scheduled Query",
"description": "A sample of a scheduled query."
},
"updatedUserId": "{USER_ID}",
"version": 2,
"id": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"updated": "1578523458919",
"schedule": {
"schedule": "30 * * * *",
"startDate": "2020-01-08T12:30:00.000Z",
"maxActiveRuns": 1
},
"userId": "{USER_ID}",
"created": "1578523458919",
"_links": {
"enable": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "PATCH",
"body": "{ \"op\": \"enable\" }"
},
"runs": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
"method": "GET"
},
"self": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "GET"
},
"delete": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "DELETE"
},
"disable": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
"method": "PATCH",
"body": "{ \"op\": \"disable\" }"
},
"trigger": {
"href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
"method": "POST"
}
}
}
Du kan använda värdet för _links.delete
till ta bort din skapade schemalagda fråga.
Du kan uppdatera informationen för en viss schemalagd fråga genom att göra en PATCH-förfrågan till /schedules
slutpunkten och genom att ange dess ID i sökvägen för begäran.
Begäran från PATCH stöder två olika sökvägar: /state
och /schedule/schedule
.
Du kan uppdatera tillståndet för den valda schemalagda frågan genom att ställa in path
egenskap till /state
och value
egenskap som antingen enable
eller disable
.
API-format
PATCH /schedules/{SCHEDULE_ID}
Egenskap | Beskrivning |
---|---|
{SCHEDULE_ID} |
The id värdet för den schemalagda fråga som du vill PATCH. |
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/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
-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 '{
"body": [
{
"op": "replace",
"path": "/state",
"value": "disable"
}
]
}'
Egenskap | Beskrivning |
---|---|
op |
Åtgärden som ska utföras i frågeschemat. Godkänt värde är replace . |
path |
Sökvägen för det värde som du vill laga. I det här fallet måste du ange värdet för path till /state . |
value |
Det uppdaterade värdet för /state . Värdet kan antingen anges som enable eller disable för att aktivera eller inaktivera den schemalagda frågan. |
Svar
Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med följande meddelande.
{
"message": "Request to patch accepted",
"statusCode": 202
}
Du kan uppdatera cron-schemat för den schemalagda frågan genom att ange path
egenskap till /schedule/schedule
i begärandetexten. Mer information om kundscheman finns i cron, uttrycksformat dokumentation.
API-format
PATCH /schedules/{SCHEDULE_ID}
Egenskap | Beskrivning |
---|---|
{SCHEDULE_ID} |
The id värdet för den schemalagda fråga som du vill PATCH. |
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/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
-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 '{
"body": [
{
"op": "replace",
"path": "/schedule/schedule",
"value": "45 * * * *"
}
]
}'
Egenskap | Beskrivning |
---|---|
op |
Åtgärden som ska utföras i frågeschemat. Godkänt värde är replace . |
path |
Sökvägen för det värde som du vill laga. I det här fallet måste du ange värdet för path till /schedule/schedule . |
value |
Det uppdaterade värdet för /schedule . Värdet måste anges i form av ett kronschema. I det här exemplet körs den schemalagda frågan varje timme med 45 minuters markering. |
Svar
Ett lyckat svar returnerar HTTP-status 202 (Accepterad) med följande meddelande.
{
"message": "Request to patch accepted",
"statusCode": 202
}
Du kan ta bort en angiven schemalagd fråga genom att göra en DELETE-förfrågan till /schedules
slutpunkt och ange ID för den schemalagda fråga som du vill ta bort i sökvägen för begäran.
Schemat måste inaktiveras innan de tas bort.
API-format
DELETE /schedules/{SCHEDULE_ID}
Egenskap | Beskrivning |
---|---|
{SCHEDULE_ID} |
The id värdet för den schemalagda fråga som du vill DELETE. |
Begäran
curl -X DELETE https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
-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": "Schedule deleted successfully",
"statusCode": 202
}