Ora che sai quali intestazioni utilizzare, puoi iniziare a effettuare chiamate al Query Service API. Le sezioni seguenti descrivono le varie chiamate API che puoi effettuare utilizzando Query Service API. Ogni chiamata include il formato API generale, una richiesta di esempio che mostra le intestazioni richieste e una risposta di esempio.
Per recuperare un elenco di tutte le query pianificate per la tua organizzazione, effettua una richiesta GET al /schedules
endpoint.
Formato API
GET /schedules
GET /schedules?{QUERY_PARAMETERS}
Proprietà | Descrizione |
---|---|
{QUERY_PARAMETERS} |
(Facoltativo) Parametri aggiunti al percorso della richiesta che configurano i risultati restituiti nella risposta. È possibile includere più parametri, separati da e commerciali (& ). I parametri disponibili sono elencati di seguito. |
Parametri query
Di seguito è riportato un elenco dei parametri di query disponibili per l'elenco delle query pianificate. Tutti questi parametri sono facoltativi. Effettuando una chiamata a questo endpoint senza parametri, verranno recuperate tutte le query pianificate disponibili per la tua organizzazione.
Parametro | Descrizione |
---|---|
orderby |
Specifica il campo in base al quale ordinare i risultati. I campi supportati sono created e updated . Ad esempio: orderby=created I risultati verranno ordinati in base alla creazione in ordine crescente. Aggiunta di un - prima della creazione (orderby=-created ) ordinerà gli elementi in base a quelli creati in ordine decrescente. |
limit |
Specifica il limite di dimensioni della pagina per controllare il numero di risultati inclusi in una pagina. (Valore predefinito: 20) |
start |
Sposta l'elenco di risposte utilizzando la numerazione a base zero. Ad esempio: start=2 restituirà un elenco a partire dalla terza query elencata. (Valore predefinito: 0) |
property |
Filtra i risultati in base ai campi. I filtri deve essere HTML in escape. Le virgole vengono utilizzate per combinare più set di filtri. I campi supportati sono created , templateId , e userId . L’elenco degli operatori supportati è > (maggiore di), < (minore di), e == (uguale a) Ad esempio: userId==6ebd9c2d-494d-425a-aa91-24033f3abeec restituirà tutte le query pianificate in cui l’ID utente corrisponde a quello specificato. |
Richiesta
La richiesta seguente recupera la query pianificata più recente creata per la tua organizzazione.
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}'
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con un elenco di query pianificate per l’organizzazione specificata. La risposta seguente restituisce l’ultima query pianificata creata per la tua organizzazione.
{
"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
}
Per creare una nuova query pianificata, devi eseguire una richiesta POST al /schedules
endpoint. Quando crei una query pianificata nell’API, questa viene visualizzata anche nell’editor delle query. Per ulteriori informazioni sulle query pianificate nell’interfaccia utente, leggi Documentazione di Query Editor.
Formato API
POST /schedules
Richiesta
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"
}
}
'
Proprietà | Descrizione |
---|---|
query.dbName |
Nome del database per il quale si sta creando una query pianificata. |
query.sql |
La query SQL da creare. |
query.name |
Nome della query pianificata. |
schedule.schedule |
Pianificazione cron per la query. Per ulteriori informazioni sulle pianificazioni cron, leggere la formato espressione cron documentazione. In questo esempio, "30 * * *" significa che la query verrà eseguita ogni ora al segno dei 30 minuti. In alternativa, è possibile utilizzare le seguenti espressioni abbreviate:
|
schedule.startDate |
Data di inizio per la query pianificata, scritta come timestamp UTC. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 202 (Accepted) con i dettagli della query pianificata appena creata. Al termine dell’attivazione della query pianificata, il state
cambierà da REGISTERING
a 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"
}
}
}
Puoi utilizzare il valore di _links.delete
a elimina la query pianificata creata.
Per recuperare informazioni per una query pianificata specifica, effettua una richiesta GET al /schedules
e fornendo il relativo ID nel percorso della richiesta.
Formato API
GET /schedules/{SCHEDULE_ID}
Proprietà | Descrizione |
---|---|
{SCHEDULE_ID} |
Il id valore della query pianificata da recuperare. |
Richiesta
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}'
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della query pianificata specificata.
{
"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"
}
}
}
Puoi utilizzare il valore di _links.delete
a elimina la query pianificata creata.
Per aggiornare i dettagli di una query pianificata specificata, effettua una richiesta PATCH al /schedules
e fornendo il relativo ID nel percorso della richiesta.
La richiesta PATCH supporta due percorsi diversi: /state
e /schedule/schedule
.
È possibile aggiornare lo stato della query pianificata selezionata impostando path
proprietà a /state
e value
proprietà come enable
o disable
.
Formato API
PATCH /schedules/{SCHEDULE_ID}
Proprietà | Descrizione |
---|---|
{SCHEDULE_ID} |
Il id valore della query pianificata di cui si desidera eseguire il PATCH. |
Richiesta
Questa richiesta API utilizza la sintassi Patch JSON per il suo payload. Per ulteriori informazioni sul funzionamento della patch JSON, consulta il documento API Fundals.
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"
}
]
}'
Proprietà | Descrizione |
---|---|
op |
Operazione da eseguire sulla pianificazione della query. Il valore accettato è replace . |
path |
Percorso del valore a cui applicare la patch. In questo caso, poiché si sta aggiornando lo stato della query pianificata, è necessario impostare il valore path a /state . |
value |
Il valore aggiornato del /state . Questo valore può essere impostato come enable o disable per attivare o disattivare la query pianificata. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 202 (Accepted) con il seguente messaggio.
{
"message": "Request to patch accepted",
"statusCode": 202
}
È possibile aggiornare la pianificazione cron della query pianificata impostando path
proprietà a /schedule/schedule
nel corpo della richiesta. Per ulteriori informazioni sulle pianificazioni cron, leggere la formato espressione cron documentazione.
Formato API
PATCH /schedules/{SCHEDULE_ID}
Proprietà | Descrizione |
---|---|
{SCHEDULE_ID} |
Il id valore della query pianificata di cui si desidera eseguire il PATCH. |
Richiesta
Questa richiesta API utilizza la sintassi Patch JSON per il suo payload. Per ulteriori informazioni sul funzionamento della patch JSON, consulta il documento API Fundals.
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 * * * *"
}
]
}'
Proprietà | Descrizione |
---|---|
op |
Operazione da eseguire sulla pianificazione della query. Il valore accettato è replace . |
path |
Percorso del valore a cui applicare la patch. In questo caso, poiché stai aggiornando la pianificazione della query pianificata, devi impostare il valore di path a /schedule/schedule . |
value |
Il valore aggiornato del /schedule . Questo valore deve essere sotto forma di una pianificazione cron. In questo esempio, la query pianificata verrà eseguita ogni ora al minuto 45. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 202 (Accepted) con il seguente messaggio.
{
"message": "Request to patch accepted",
"statusCode": 202
}
Per eliminare una query pianificata specificata, devi eseguire una richiesta DELETE al /schedules
e fornendo l’ID della query pianificata da eliminare nel percorso della richiesta.
La pianificazione deve prima di essere eliminato.
Formato API
DELETE /schedules/{SCHEDULE_ID}
Proprietà | Descrizione |
---|---|
{SCHEDULE_ID} |
Il id valore della query pianificata di cui si desidera eseguire il DELETE. |
Richiesta
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}'
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 202 (Accepted) con il seguente messaggio.
{
"message": "Schedule deleted successfully",
"statusCode": 202
}