info:
  name: Recupero dei soggetti esterni (GET)
  type: http
  seq: 5
  tags:
    - soggetti_esterni

http:
  method: GET
  url: "{{baseUrl}}/soggettiEsterniReplica"
  params:
    - name: soggEstId
      value: ""
      type: query
      description: identificativo soggetto esterno
      disabled: true
    - name: cognome
      value: ""
      type: query
      description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
      disabled: true
    - name: nome
      value: ""
      type: query
      description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
      disabled: true
    - name: dipId
      value: ""
      type: query
      description: id dipartimento
      disabled: true
    - name: tipoSoggEstCod
      value: ""
      type: query
      description: codice tipo relatore
      disabled: true
    - name: idAb
      value: ""
      type: query
      description: identificativo address book della persona in U-GOV
      disabled: true
    - name: codFis
      value: ""
      type: query
      description: codice fiscale dell'utente
      disabled: true
    - name: daDataMod
      value: ""
      type: query
      description: data di ultima modifica (DD/MM/YYYY), verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
      disabled: true
    - name: daOraMod
      value: ""
      type: query
      description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
      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: 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
    - 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
  forwardAuthorizationHeader: true

examples:
  - name: 200 Response
    description: Successful response
    request:
      url: "{{baseUrl}}/soggettiEsterniReplica"
      method: GET
      params:
        - name: soggEstId
          value: ""
          type: query
          description: identificativo soggetto esterno
          disabled: true
        - name: cognome
          value: ""
          type: query
          description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
          disabled: true
        - name: nome
          value: ""
          type: query
          description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
          disabled: true
        - name: dipId
          value: ""
          type: query
          description: id dipartimento
          disabled: true
        - name: tipoSoggEstCod
          value: ""
          type: query
          description: codice tipo relatore
          disabled: true
        - name: idAb
          value: ""
          type: query
          description: identificativo address book della persona in U-GOV
          disabled: true
        - name: codFis
          value: ""
          type: query
          description: codice fiscale dell'utente
          disabled: true
        - name: daDataMod
          value: ""
          type: query
          description: data di ultima modifica (DD/MM/YYYY), verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
          disabled: true
        - name: daOraMod
          value: ""
          type: query
          description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
          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: 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
        - 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 i soggetti esterni 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()


  Classe di modello : ReplicaSoggettoEsterno
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  soggEstId|primaryKey
  consensiSoggEsterni|optional
  entiSoggEsterni|optional
  soggEstAlias|optional
  soggEstProfili|optional


  Classe di modello : ReplicaConsensiSoggEsterni
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  soggEstId|primaryKey


  Classe di modello : ReplicaEntiSoggEsterni
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  soggEstId|primaryKey
  enteId|primaryKey
  sedi|optional


  Classe di modello : ReplicaSediEntiSoggEsterni
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  soggEstId|primaryKey
  enteId|primaryKey


  Classe di modello : SoggEstProfili
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  soggEstId|primaryKey
