Italiano English (US) Español

Articoli in questa sezione

Vedi altro

REST - Esempio chiamata di lettura con ordinamento

Segui

Come visto nell'esempio precedente possiamo facilmente ottenere in formato JSON un elenco contenente tutti i dati restituiti da una vista. In un contesto semplice, in cui non ci sono molti dati e hai bisogno di ordinarli, puoi farlo direttamente lato applicazione client. Se invece la mole di dati è consistente e vuoi sfruttare la capacità di query di Altamira HRM.

Puoi farlo usando nella tua chiamata il parametro sort. sort supporta il linguaggio json e può essere utilizzato per specificare un campo su cui ordinare i dati e la direzione dell'ordinamento da applicare.

 

REST v3 - Lettura con ordinamento

E' possibile usare un qualsiasi campo presente nella view per ordinare i risultati:

Prametro

Nome

Descrizione

Tipo

header

Token (obbligatorio)

Token generato precedentemente da AltamiraHRM

string

header

environment

Restituisce i dati nel formato corrispondente a quello ricevuto. 

 

Valori disponibili : Frontend, Mobile, Api

 

Valore predefinito : Api

string

querystring

filters

Filtri da applicare ai dati della view.

Corrispondono a quelli specificati nella view di filtro associata a questo report

string

querystring

sort

Colonna da utilizzare per ordinare i dati.

Corrisponde ai quelli specificati in questo report

 

Disponibile solo con il parametro di header "environment"="Frontend"

string

querystring

structure

Visualizza la proprietà 'view' nel Json restituito

Valore predefinito: false

boolean

 

Il parametro Token deve essere inviato come header.

Il parametro sort va invece utilizzato come parametro nella url e dovrà avere la struttura di un oggetto JSON come quello di seguito:

{
      'sort': {
             'tagname' : 'Jobs_FullName',
             'direction': 'ASC|DESC'
       }
}

Invocando la seguente url:

otterrai:

{
    "count": "1",
    "sort": {
            "tagName": "Jobs_Title",
            "direction": "DESC",
            "sortable": true,
       },
    "data": [
       {
            "Jobs_StatusID": id_value,
            "id": id_value,
            "Jobs_FullName": "test - test",
            "Jobs_StatusName": null,
            "Jobs_DatePublished": null,
            "Jobs_DateToUnpublish": null,
            "Jobs_ReceptionType": "Back office",
            "status": {
                "statusID": id_value,
                "statusName": "Creation",
                "statusType": id_value
          }
      },
      {
            "Jobs_StatusID": id_value,
            "id": id_value,
            "Jobs_FullName": "004 - Customer Success Specialist",
            "Jobs_StatusName": "Published",
            "Jobs_DatePublished": "2028-10-15T12:32:00Z",
            "Jobs_DateToUnpublish": null,
            "Jobs_ReceptionType": "Back office",
            "status": {
                "statusID": id_value,
                "statusName": "Published",
                "statusType": id_value
          }
      },
      {
            "Jobs_StatusID": id_value,
            "id": id_value,
            "Jobs_FullName": "003 - Java Software Engineer",
            "Jobs_StatusName": "Published",
            "Jobs_DatePublished": "2024-05-16T10:11:00Z",
            "Jobs_DateToUnpublish": null,
            "Jobs_ReceptionType": "Back office",
            "status": {
                "statusID": id_value,
                "statusName": "Published",
                "statusType": id_value
          }
      },
      {
            "Jobs_StatusID": id_value,
            "id": id_value,
            "Jobs_FullName": "002 - International Sales Director",
            "Jobs_StatusName": "Published",
            "Jobs_DatePublished": "2024-05-17T17:02:00Z",
            "Jobs_DateToUnpublish": null,
            "Jobs_ReceptionType": "Back office",
            "status": {
                "statusID": id_value,
                "statusName": "Published",
                "statusType": id_value
           }
       },
       {
            "Jobs_StatusID": id_value,
            "id": id_value,
            "Jobs_FullName": "001 - Digital Marketing Analyst",
            "Jobs_StatusName": "Published",
            "Jobs_DatePublished": "2024-05-16T10:21:00Z",
            "Jobs_DateToUnpublish": null,
            "Jobs_ReceptionType": "Back office",
            "status": {
                "statusID": id_value,
                "statusName": "Published",
                "statusType": 2
          }
      }
    ],
    "result": [
        {
            "status": "Extracted",
            "statusMessage": "",
            "details": []
        }
    ]
}

I possibili valori da inserire dentro la proprietà "direction" sono le string "ASC" o "DESC"

Tieni presente le seguenti raccomandazioni quando costruisci le query:

  • Se il campo non è presente tra i campi della view non potrà essere utilizzato nell'ordinamento

 

Articoli correlati

Commenti

0 commenti

Accedi per aggiungere un commento.