144 lines
4.9 KiB
YAML
144 lines
4.9 KiB
YAML
info:
|
|
name: Inserisce oppure aggiorna i dati di un soggetto esterno in esse3
|
|
type: http
|
|
seq: 2
|
|
tags:
|
|
- soggetti_esterni
|
|
|
|
http:
|
|
method: PUT
|
|
url: "{{baseUrl}}/soggettiEsterni"
|
|
params:
|
|
- name: optionalFields
|
|
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
|
|
auth: inherit
|
|
|
|
settings:
|
|
encodeUrl: true
|
|
timeout: 0
|
|
followRedirects: true
|
|
maxRedirects: 5
|
|
forwardAuthorizationHeader: true
|
|
|
|
examples:
|
|
- name: 200 Response
|
|
description: Update succeded
|
|
request:
|
|
url: "{{baseUrl}}/soggettiEsterni"
|
|
method: PUT
|
|
params:
|
|
- name: optionalFields
|
|
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
|
|
response:
|
|
status: 200
|
|
statusText: OK
|
|
body:
|
|
type: text
|
|
data: ""
|
|
- name: 422 Response
|
|
description: aggiornamento non riuscito
|
|
request:
|
|
url: "{{baseUrl}}/soggettiEsterni"
|
|
method: PUT
|
|
params:
|
|
- name: optionalFields
|
|
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
|
|
response:
|
|
status: 422
|
|
statusText: Unprocessable Entity
|
|
body:
|
|
type: text
|
|
data: ""
|
|
|
|
docs: |
|
|
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Il servizio prevede l'indicazione di SOGG_EST_ID o COD_FIS o ID_AB per identificare l'eventuale soggetto esterno da aggiornare. Se sono tutti nulli sarà creato un nuovo soggetto esterno, altrimenti si procede all'aggiornamento.
|
|
|
|
|
|
**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()
|
|
|
|
|
|
Classe di modello : SoggettoEsterno
|
|
======
|
|
|
|
Estensioni sulle proprietà
|
|
----
|
|
Proprietà | x-field-type
|
|
-|-|
|
|
soggEstId|primaryKey
|
|
soggEstAlias|optional
|
|
soggEstProfili|optional
|
|
|
|
|
|
Classe di modello : SoggEstProfili
|
|
======
|
|
|
|
Estensioni sulle proprietà
|
|
----
|
|
Proprietà | x-field-type
|
|
-|-|
|
|
soggEstId|primaryKey
|
|
|
|
|
|
Classe di modello : DettaglioErroreAggiuntivo
|
|
======
|
|
|
|
Estensioni sulle proprietà
|
|
----
|
|
Proprietà | x-field-type
|
|
-|-|
|
|
rawValue|rawJson
|