Le operazioni di retrieve permettono di ottenere le informazioni registrate nel gestionale, e solitamente non influenzano in alcun modo lo stato del software e i dati interni.
In base alle capacità del server in cui il gestionale è installato, è possibile un rallentamento del server in caso di molteplici richieste contemporanee all'API.
Considerando la potenziale quantità delle informazioni restituite, il sistema API del gestionale restituisce le informazioni richieste presentando una paginazione di default di 200 record (impostazione Lunghezza pagine per API).
GET http://localhost/openstamanager/api?token=<token>&resource=<resource>
Richiesta standard per la comunicazione con l'API in modalità
retrieve
.
| Name | Type | Description |
|---|---|---|
Il rispetto delle opzioni sopra indicate, come per la gestione della paginazione automatica, è riservato alla singola risorsa: in casi specifici e documentati, la risorsa potrebbe ignorare le opzioni indicate a favore di un comportamento personalizzato.
Questo è particolarmente rilevante in caso di personalizzazioni, interne o esterne, del software.
Anagrafiche: anagrafiche
Interventi: interventi
token
string
Token di accesso
resource
string
Risorsa richiesta
page
integer
Intero compreso tra 0 e il valore del campo
pages
restituito dalla prima richiesta (esempio:
page=5
)
display
array
Array che indica un filtro sui campi da restituire alla richiesta (esempio:
display=[id,name]
)
filter
array
Array composto che indica dei filtro da applicare sui contenuti dei risultati alla richiesta (esempio:
filter[id]=[1]
)
order
array
Array che indica l'ordinamento da impostare sulla richiesta
