Il service TABLES serve per estrapolare la lista di tutte le tabelle e se necessario la struttura di ogni tabella.
Il service in questione può essere richiamato tramite il seguente url: https://api.gooseapp.com/tables/
La struttura dati JSON dovrà essere inviata tramite POST, qui di seguito un esempio JSON di chiamata:
{ code: "DEV001", key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78", structure: false }
Questa chiamata restituisce un JSON contenente tutte le tabelle presenti sul proprio database in Cloud.
I parametri disponibili per la chiamate TABLES sono i seguenti:
Nome |
Tipo |
Obbligatorio |
Descrizione |
---|---|---|---|
code |
varchar(6) |
Yes |
Codice azienda |
key |
varchar(200) |
Yes |
Chiave API di sicurezza |
structure |
boolean |
No |
Indica se richiesta o meno la struttura di ogni tabella |
Una chiamata come la seguente permette di ottenere la lista di tutte le tabelle del sistema.
{ code: "DEV001", key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78", structure: false }
Nel caso l'operazione eseguita vada a buon fine si ottiene il seguente JSON:
{ status: "OK", result: { total: 73, data: [ { name: "AGE_FAM" }, { name: "AGE_GRU" }, ... ] } }
Lo status "OK" indica che l'operazione di TABLES è andata a buon fine, nella struttura result sono poi presenti i campi total (totale campi selezionati) e data (struttura dati di ritorno).
Una chiamata come la seguente permette invece di ottenere la lista di tutte le tabelle e la struttura di ognuna. In questo caso è sufficiente impostare la specifica structure a true.
{ code: "DEV001", key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78", structure: true }
Nel caso l'operazione eseguita vada a buon fine si ottiene il seguente JSON:
{ status: "OK", result: { total: 73, data: [ { name: "AGE_FAM", structure: [ Array Fields List ] }, { name: "AGE_GRU", structure: [ Array Fields List ] }, ... ] } }
Nel caso l'operazione eseguita non vada a buon fine si ottiene il seguente JSON:
{ status: "error", error: { code: 120, description: "Table 'client_goose_DEM001.CON_TRO' doesn't exist'" } }
In caso di errore lo status viene restituito con valore "error" e nella struttura error vengono indicati il codice di errore e una descrizione dell'errore.
Vuoi chiederci qualcosa?
Scrivici a: support@gooseapp.com