Standard API

Le Standard API (SAPI) servono come interfaccia per la comunicazione con il backend di Tsuite, permettono il recupero di dati e anche la loro modifica o eliminazione.

La classe StdApi<T, K> si aspetta due Type, T rappresentante il modello completo contenente tutti gli attributi dei un oggetto (vedi Articoli) e K un sotto-tipo di T contenente i soli attributi che arriveranno all’interno della risposta (presenti nel parametro fields)

Parametri di StdApi

• endpoint: string nome dell’endpoint da chiamare
• id?: string id dell’oggetto (utilizzato per POST, PATCH e DELETE)
• paging?: StdApiPaging paginazione, numero e dimensione pagina ritornata
• fields?: StdApiFields<T> array contenente i campi da richiedere
• sorting?: StdApiSorting<T> ordinamento dei risultati
• filters?: StdApiFilters<T> filtri da applicare alla query
• filterLogic?: StdApiFilterLogic logica da apporre ai filtri OR o AND (default)
• localization?: string id della lingua
• systemId?: string id del sistema
• productionUnitId?: string id dell’unità produttiva

Esempio di dichiarazione:

import { StdApi } from "./stdApi"
 
const stdApi = new StdApi<Type1, SubType1>({
  endpoint: `nome_endpoint`,
  systemId: 'id_sistema',
  localization: 'id_lingua',
  paging: {
    number: 1,
    size: 50
  },
  fields: ["id", "name", "description", "status"],
  filters: [
    {
      field: "status",
      operator: StdApiFilterOperator.EQUAL,
      filter: "visibile"
    }
  ],
  sorting: [
    {
      field: "date",
      mode: "DESC"
    }
  ]
})

Endpoint

Qui la lista degli endpoint disponibili