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.
{% hint style="warning" %} In base alle capacità del server in cui il gestionale è installato, è possibile un rallentamento del server in caso di molteplici richieste contemporanee all'API. {% endhint %}
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).
{% swagger baseUrl="http://localhost/openstamanager" path="/api?token=&resource=" method="get" summary="Richiesta standard" %} {% swagger-description %} Richiesta standard per la comunicazione con l'API in modalità
retrieve
. {% endswagger-description %}
{% swagger-parameter in="query" name="token" type="string" required="false" %} Token di accesso {% endswagger-parameter %}
{% swagger-parameter in="query" name="resource" type="string" required="false" %} Risorsa richiesta {% endswagger-parameter %}
{% swagger-parameter in="query" name="page" type="integer" required="false" %} Intero compreso tra 0 e il valore del campo
pages
restituito dalla prima richiesta (esempio:
page=5
) {% endswagger-parameter %}
{% swagger-parameter in="query" name="display" type="array" required="false" %} Array che indica un filtro sui campi da restituire alla richiesta (esempio:
display=[id,name]
) {% endswagger-parameter %}
{% swagger-parameter in="query" name="filter" type="array" required="false" %} Array composto che indica dei filtro da applicare sui contenuti dei risultati alla richiesta (esempio:
filter[id]=[1]
) {% endswagger-parameter %}
{% swagger-parameter in="query" name="order" type="array" required="false" %} Array che indica l'ordinamento da impostare sulla richiesta {% endswagger-parameter %}
{% swagger-response status="200" description="" %}
{% endswagger-response %} {% endswagger %}
{% hint style="info" %} 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. {% endhint %}
- Anagrafiche:
anagrafiche - Interventi:
interventi