add initial ESSE3 collections
This commit is contained in:
@@ -0,0 +1,168 @@
|
||||
info:
|
||||
name: Recupero istituti
|
||||
type: http
|
||||
seq: 4
|
||||
tags:
|
||||
- anagrafica
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/istituti"
|
||||
params:
|
||||
- name: tipologiaScuolaCod
|
||||
value: ""
|
||||
type: query
|
||||
description: Codice della tipologia della scuola.
|
||||
disabled: true
|
||||
- name: scuolaMiurCod
|
||||
value: ""
|
||||
type: query
|
||||
description: Codice meccanografico della scuola.
|
||||
disabled: true
|
||||
- name: scuolaSupId
|
||||
value: ""
|
||||
type: query
|
||||
description: Identificativo della scuola.
|
||||
disabled: true
|
||||
- name: scuolaMiurId
|
||||
value: ""
|
||||
type: query
|
||||
description: Identificativo scuola MIUR.
|
||||
disabled: true
|
||||
- name: fields
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
specifica la lista dei campi opzionali (che non vengono recupeati di default);
|
||||
impostando il valore `ALL` vengono mostrati tutti i campi.
|
||||
|
||||
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
|
||||
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
|
||||
|
||||
Esempi
|
||||
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
|
||||
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
|
||||
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
|
||||
disabled: true
|
||||
- name: order
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
|
||||
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
|
||||
* field : nome del campo da ordinare
|
||||
|
||||
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
|
||||
disabled: true
|
||||
- name: start
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
|
||||
disabled: true
|
||||
- name: limit
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
|
||||
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
|
||||
disabled: true
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/istituti"
|
||||
method: GET
|
||||
params:
|
||||
- name: tipologiaScuolaCod
|
||||
value: ""
|
||||
type: query
|
||||
description: Codice della tipologia della scuola.
|
||||
disabled: true
|
||||
- name: scuolaMiurCod
|
||||
value: ""
|
||||
type: query
|
||||
description: Codice meccanografico della scuola.
|
||||
disabled: true
|
||||
- name: scuolaSupId
|
||||
value: ""
|
||||
type: query
|
||||
description: Identificativo della scuola.
|
||||
disabled: true
|
||||
- name: scuolaMiurId
|
||||
value: ""
|
||||
type: query
|
||||
description: Identificativo scuola MIUR.
|
||||
disabled: true
|
||||
- name: fields
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
specifica la lista dei campi opzionali (che non vengono recupeati di default);
|
||||
impostando il valore `ALL` vengono mostrati tutti i campi.
|
||||
|
||||
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
|
||||
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
|
||||
|
||||
Esempi
|
||||
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
|
||||
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
|
||||
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
|
||||
disabled: true
|
||||
- name: order
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
|
||||
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
|
||||
* field : nome del campo da ordinare
|
||||
|
||||
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
|
||||
disabled: true
|
||||
- name: start
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
|
||||
disabled: true
|
||||
- name: limit
|
||||
value: ""
|
||||
type: query
|
||||
description: |
|
||||
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
|
||||
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
|
||||
disabled: true
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Fornisce gli istituti configurati su esse3.
|
||||
|
||||
**Estensioni:**
|
||||
|
||||
Codice Estensione|Valore|Nota
|
||||
-|-|-
|
||||
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
|
||||
|
||||
|
||||
**Controlli di sicurezza:**
|
||||
======
|
||||
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
|
||||
|
||||
**Utente: USER_TECNICO**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
|
||||
Reference in New Issue
Block a user