Celonis (anteprima)

API della piattaforma Celonis per l'uso con elementi del modello di conoscenza, ad esempio record, indicatori KPI, filtri, trigger e relativi dati.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti:      - Aree di Azure per enti pubblici      - Aree di Azure Cina      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Di alta qualità	Tutte le aree di Power Apps , ad eccezione dei seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	Supporto di Celonis
URL	https://developer.celonis.com/
Email	intelligence-api-feedback-sc@celonis.de

Metadati del connettore
Editore	Celonis
Sito web	https://www.celonis.com
Informativa sulla privacy	https://www.celonis.com/privacy-policy/
Categorie	IA; Gestione aziendale

Titolo

L'API Celonis Intelligence consente ai clienti di Celonis di incorporare l'intelligence sui processi interattivi in piattaforme di terze parti in cui gli utenti finali possono trarre vantaggio dalle informazioni dettagliate sui processi di Celonis. In questo modo, porterebbe l'intelligenza di Celonis come gli indicatori KPI di processo o l'inefficienze dei processi più vicini agli utenti finali e trarre vantaggio dagli utenti operativi senza l'accesso corrente a Celonis fornendo preziose informazioni dettagliate per un processo decisionale migliore durante l'esecuzione delle attività quotidiane. Oltre alla funzionalità di query dei dati, l'API Intelligence supporta anche il push dei dati in piattaforme di terze parti consentendo loro di sottoscrivere trigger aziendali.

Autore: nome del server di pubblicazione

Celonis

Prerequisiti

1. Un team in Celonis Platform.
2. Modello di conoscenza disponibile nel team di un cliente.
3. Sottoscrizione di Celonis basata su processo (contattare il team dell'account per verificare).

Operazioni supportate

I metodi API correnti consentono agli utenti di interagire con i modelli di conoscenza definiti in Celonis Platform fornendo le funzionalità seguenti:

Metodi di individuazione dei modelli di conoscenza

Ottenere un elenco di modelli di knowledge base (KM)

Ottenere un elenco di record km

Ottenere i dettagli dello schema dei record km

Ottenere un elenco di filtri km

Metodi di recupero dei dati del modello di knowledge base

Ottenere un elenco di dati del record km

Metodi di gestione del ciclo di vita delle sottoscrizioni

Ottenere un elenco di sottoscrizioni

Ottenere un elenco di trigger km

Creare una sottoscrizione a un trigger del servizio di gestione delle chiavi

Aggiornare una sottoscrizione

Sospendere una sottoscrizione

Riprendere una sottoscrizione

Terminare una sottoscrizione

Recupero delle credenziali

Authentication

Ogni richiesta all'API deve essere autenticata con una chiave API Celonis. Esistono due modi per eseguire questa operazione:

Uso di una chiave API utente

Per informazioni su come creare una chiave API utente, seguire la guida alle chiavi API utente . L'API Celonis usa l'autenticazione del token di connessione per verificare l'accesso dei consumer. Le credenziali devono essere inviate in un'intestazione di autorizzazione nella richiesta HTTP. Le credenziali inviate nell'URL o nel corpo della richiesta verranno ignorate. Per eseguire l'autenticazione tramite l'autenticazione del token di connessione:

1. Creare il token in Celonis: MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
2. Includere la stringa nell'intestazione autorizzazione HTTP formattata come segue:
   Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM

Uso di una chiave API dell'applicazione

Per informazioni su come creare un oggetto AppKey, seguire la guida alle chiavi API dell'applicazione . Per eseguire l'autenticazione tramite l'autenticazione AppKey:

1. Creare AppKey in Celonis:
   MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
2. Includere la stringa nell'intestazione autorizzazione HTTP formattata come segue:
   Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr

Authorization

È necessario impostare le autorizzazioni corrette e assicurarsi che la chiave API utente o la chiave API dell'applicazione sfruttata per scopi di autorizzazione abbia accesso al pacchetto Celonis Studio contenente i modelli di knowledge base a cui si vuole accedere tramite le API di Intelligence. È possibile concedere le autorizzazioni di accesso seguendo questa procedura:

• Passare al pacchetto di Studio.
• Fare clic sui tre puntini e selezionare Permissions dal menu a comparsa.
• Cercare l'utente (nel caso in cui si stia usando un token di connessione ) o AppKey (nel caso in cui si usi un oggetto AppKey ) e concedere almeno USE PACKAGE i diritti.

Come iniziare

L'URL di base per l'API Celonis è https://<team>.<cluster>.celonis.cloud/intelligence/api Per trovare il team e il cluster, controllare l'URL usato per accedere alla piattaforma Celonis e recuperare il team e il cluster da esso. L'API Celonis Intelligence è un'API JSON e i relativi endpoint restituiscono sempre una risposta JSON, indipendentemente dal successo della richiesta. I metodi API correnti consentono agli utenti di interagire con i modelli di conoscenza definiti in Celonis Platform fornendo le funzionalità seguenti:

• Elenco dei modelli di knowledge base disponibili e dei relativi dettagli
• Elenco di record e relativi dettagli
• Elenco di filtri
• Dati per un record specifico. Informazioni dettagliate sulle funzionalità dell'API Celonis Intelligence nel portale per sviluppatori di Celonis.

Problemi noti e limitazioni

Limitazione della velocità

L'API intelligence non è stata compilata per esportare in blocco i dati RAW, ma per rendere disponibili i risultati calcolati e le informazioni dettagliate dal data mining di elaborazione alle piattaforme e alle applicazioni di terze parti. Ecco perché l'API Celonis applica la limitazione della frequenza. Ciò significa che solo un determinato numero di richieste è consentito al giorno e un determinato numero di record può essere recuperato in ogni chiamata. Celonis si riserva il diritto di modificare i limiti di tariffa in qualsiasi momento per garantire un servizio di alta qualità per tutti i clienti. Nel caso in cui un client superi ripetutamente i limiti di velocità o si impegna nel comportamento ritenuto sospetto, Celonis si riserva il diritto di limitare o sospendere temporaneamente o definitivamente l'accesso all'API per tale client. Quando un client supera il numero di richieste al giorno, l'API Celonis restituirà una risposta 429 (troppe richieste), inclusa un'intestazione HTTP (x-ratelimit-reset) che indica il tempo (in secondi) che il client deve attendere prima di poter elaborare una nuova richiesta. Le intestazioni HTTP seguenti vengono restituite anche come parte di ogni chiamata:

• x-ratelimit-limit : rappresenta il numero massimo di richieste che il client può eseguire nell'intervallo di tempo corrente.
• x-ratelimit-remaining : numero di richieste rimanenti nell'intervallo di tempo corrente. Attualmente, l'API presenta i limiti predefiniti seguenti:

Tabella 1. Limiti di frequenza delle richieste predefiniti

| Limite | Valori predefiniti | |--|--|| | Numero massimo di richieste/giorno | 6000 requests/day | | Numero massimo di richieste al secondo | 20 requests/second | | Numero massimo di campi consentiti per richiesta nel modello di knowledge base | 200 campi/richiesta | | Numero massimo di record per richiesta restituiti quando si chiama l'endpoint /data | 50 record/richiesta | | Numero massimo totale di record che è possibile recuperare tramite l'endpoint /data | Primi 5.000 record per tabella filtrata/ordinata | La sottoscrizione al trigger applica anche la limitazione della frequenza. Ciò significa che per un team è possibile creare solo un determinato numero di sottoscrizioni. Inoltre, indipendentemente dal numero di sottoscrizioni create, esiste un numero massimo di eventi che possono essere generati dall'API ai consumer di terze parti. Se un client raggiunge il numero massimo di sottoscrizioni, dovrà eliminare una sottoscrizione esistente per crearne una nuova. Se un client raggiunge il numero massimo di eventi generati dall'API, il resto dei dati prodotti da Celonis Platform verrà rimosso. Se il client sta raggiungendo la quota giornaliera, questi verranno informati tramite e-mail all'account amministratore. Il primo messaggio di posta elettronica verrà inviato quando vengono superati 80% della quota, consentendo all'account amministratore di sapere che si è oltre tale percentuale. Il secondo messaggio di posta elettronica verrà inviato non appena si superano 100% della quota. Attualmente, l'API presenta i limiti predefiniti seguenti:

Tabella 2. Limiti di frequenza degli eventi predefiniti

| Limite | Valori predefiniti | |--|--|| | Numero massimo di sottoscrizioni/team | 10 | | Numero massimo di eventi/giorno | 100,000 | Consultare il team dell'account per verificare i limiti del team.

Domande frequenti

Fare riferimento alla sezione Domande frequenti nel portale per sviluppatori di Celonis.

Istruzioni per la distribuzione

Obbligatorio. Aggiungere istruzioni su come distribuire questo connettore come connettore personalizzato.

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	TIPO	Description	Obbligatorio
Squadra	corda	Specificare il team di Celonis.	Vero
Cluster	corda	Specificare il cluster Celonis.	Vero
Authorization	securestring	Autorizzazione per questa API	Vero

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Aggiorna una sottoscrizione	Aggiorna una sottoscrizione
Annullare la sottoscrizione a un trigger rimuovendo tutti i dati per la sottoscrizione	Annullare la sottoscrizione a un trigger rimuovendo tutti i dati per la sottoscrizione
Crea una sottoscrizione per il trigger	Crea una sottoscrizione per il trigger
Ottenere i dettagli del servizio di gestione delle chiavi di primo livello	Modello di conoscenza definito in un team EMS
Ottenere i dettagli dello schema dei record km di primo livello	Dettagli dello schema di record di primo livello
Ottenere un elenco dello schema dei record km	Elenco dello schema dei record
Ottenere un elenco di dati del record km	Dati per un record nel modello di conoscenza
Ottenere un elenco di filtri km	Elenco di filtri per il modello di conoscenza
Ottenere un elenco di KMs	Elenco dei modelli di conoscenza definiti in un team EMS
Ottenere un elenco di sottoscrizioni	Elenco di tutte le sottoscrizioni create
Ottenere un elenco di trigger km	Elenco di trigger per il modello di conoscenza
Recupera la pagina successiva di eventi non inoltrati a causa di una sottoscrizione non riuscita	Recupera la pagina successiva di eventi se non sono stati inoltrati a causa di una sottoscrizione non riuscita
Riprende la sottoscrizione per iniziare a ricevere nuovi eventi, ignorando gli eventi della cronologia	Riprende la sottoscrizione sospesa per iniziare a ricevere di nuovo nuovi eventi, ignorando gli eventi della cronologia
Riprende la sottoscrizione sospesa per avviare nuovamente la ricezione di eventi	Riprende la sottoscrizione sospesa per avviare nuovamente la ricezione di eventi
Sospende la sottoscrizione per interrompere la ricezione di eventi	Sospende la sottoscrizione per interrompere la ricezione di eventi

Aggiorna una sottoscrizione

ID operazione:

updateSubscription

Aggiorna una sottoscrizione

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID sottoscrizione	subscription_id	True	string	ID sottoscrizione che verrà completamente aggiornato
headers	headers		object	Le intestazioni di callback possono contenere token di autenticazione, tipo di contenuto e così via.
protocol	protocol	True	string	Solo il valore possibile è HTTPS, il che significa che l'URI di callback deve essere un https valido
URI	uri	True	string	URI per eseguire il callback dall'API intelligence dopo l'attivazione del trigger
configurazioni	configurations		array of string	Configurazione per la sottoscrizione
nome	name	True	string	Nome della sottoscrizione

Annullare la sottoscrizione a un trigger rimuovendo tutti i dati per la sottoscrizione

ID operazione:

unsubscribe

Annullare la sottoscrizione a un trigger rimuovendo tutti i dati per la sottoscrizione

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID sottoscrizione	subscription_id	True	string	L'ID sottoscrizione verrà eliminato

Crea una sottoscrizione per il trigger

ID operazione:

createSubscription

Crea una sottoscrizione per il trigger

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Km Id	km_id	True	string	ID del modello di conoscenza
Trigger Id	trigger_id	True	string	The Trigger Id
headers	headers		object	Le intestazioni di callback possono contenere token di autenticazione, tipo di contenuto e così via.
protocol	protocol	True	string	Solo il valore possibile è HTTPS, il che significa che l'URI di callback deve essere un https valido
URI	uri	True	string	URI per eseguire il callback dall'API intelligence dopo l'attivazione del trigger
configurazioni	configurations		array of string	Configurazione per la sottoscrizione
nome	name	True	string	Nome della sottoscrizione

Restituisce

response

string

Ottenere i dettagli del servizio di gestione delle chiavi di primo livello

ID operazione:

getKnowledgeModelDetails

Modello di conoscenza definito in un team EMS

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID modello di conoscenza	km_id	True	string	ID modello di conoscenza

Restituisce

Struttura dei dati del modello di conoscenza

Modello di conoscenza

knowledgeModelDetailedDTO

Ottenere i dettagli dello schema dei record km di primo livello

ID operazione:

getRecordDetails

Dettagli dello schema di record di primo livello

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID modello di conoscenza	km_id	True	string	ID modello di conoscenza
ID record	record_id	True	string	ID record

Restituisce

Record rappresenta un concetto all'interno di un modello di knowledge base

Tipo di record

recordDTO

Ottenere un elenco dello schema dei record km

ID operazione:

getRecords

Elenco dello schema dei record

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina	page		integer	Numero di pagina del risultato, a partire da 0 (prima pagina)
Dimensioni pagina	pageSize		integer	Numero di elementi restituiti in una pagina.
Ordinamento	sort		string	Definisce la strategia da procedere per l'ordinamento senza distinzione tra maiuscole e minuscole. Deve essere solo un campo e deve iniziare con "+" per applicare l'ordine ASC o "-" per applicare l'ordine DESC. Il prefisso non verrà ordinato come ASC. Un campo non esistente nell'intestazione genererà un errore
ID modello di conoscenza	km_id	True	string	ID modello di conoscenza

Restituisce

Pagina dei risultati dello schema di record

recordSchemaResultPage

Ottenere un elenco di dati del record km

ID operazione:

getRecordDataResult

Dati per un record nel modello di conoscenza

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID modello di conoscenza	km_id	True	string	ID modello di conoscenza
ID record	record_id	True	string	ID record
Filtri	filters		array	ID filtro predefinito
ID campo	fields	True	array	ID filtro predefinito
Pagina	page		integer	Numero di pagina del risultato, a partire da 0 (prima pagina)
Dimensioni pagina	pageSize		integer	Numero di elementi restituiti in una pagina.
Ordinamento	sort		array	Definisce la strategia da procedere per l'ordinamento. Deve essere un elenco delimitato da virgole di campi e deve iniziare con "+" per applicare l'ordine ASC o "-" per applicare l'ordine DESC. I campi senza prefisso verranno ordinati come ASC. I campi non esistenti nell'intestazione genereranno un errore
Espressione filtro	filterExpr		array	Espressioni di filtro dinamiche

Restituisce

Pagina dei risultati dei record

recordResultPageDTO

Ottenere un elenco di filtri km

ID operazione:

getFilters

Elenco di filtri per il modello di conoscenza

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina	page		integer	Numero di pagina del risultato, a partire da 0 (prima pagina)
Dimensioni pagina	pageSize		integer	Numero di elementi restituiti in una pagina.
Ordinamento	sort		string	Definisce la strategia da procedere per l'ordinamento senza distinzione tra maiuscole e minuscole. Deve essere solo un campo e deve iniziare con "+" per applicare l'ordine ASC o "-" per applicare l'ordine DESC. Il prefisso non verrà ordinato come ASC. Un campo non esistente nell'intestazione genererà un errore
ID modello di conoscenza	km_id	True	string	ID modello di conoscenza

Restituisce

Pagina dei risultati dello schema di filtro

filterResultPage

Ottenere un elenco di KMs

ID operazione:

getKnowledgeModel

Elenco dei modelli di conoscenza definiti in un team EMS

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina	page		integer	Numero di pagina del risultato, a partire da 0 (prima pagina)
Dimensioni pagina	pageSize		integer	Numero di elementi restituiti in una pagina.
Ordinamento	sort		string	Definisce la strategia da procedere per l'ordinamento senza distinzione tra maiuscole e minuscole. Deve essere solo un campo e deve iniziare con "+" per applicare l'ordine ASC o "-" per applicare l'ordine DESC. Il prefisso non verrà ordinato come ASC. Un campo non esistente nell'intestazione genererà un errore

Restituisce

Pagina dei risultati di KnowledgeModel

knowledgeModelResultPage

Ottenere un elenco di sottoscrizioni

ID operazione:

getSubscriptions

Elenco di tutte le sottoscrizioni create

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina	page		integer	Numero di pagina del risultato, a partire da 0 (prima pagina)
Dimensioni pagina	pageSize		integer	Numero di elementi restituiti in una pagina.
Ordinamento	sort		string	Definisce la strategia da procedere per l'ordinamento senza distinzione tra maiuscole e minuscole. Deve essere solo un campo e deve iniziare con "+" per applicare l'ordine ASC o "-" per applicare l'ordine DESC. Il prefisso non verrà ordinato come ASC. Un campo non esistente nell'intestazione genererà un errore

Restituisce

Pagina dei risultati dello schema della sottoscrizione

subscriptionResultPage

Ottenere un elenco di trigger km

ID operazione:

getTriggers

Elenco di trigger per il modello di conoscenza

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina	page		integer	Numero di pagina del risultato, a partire da 0 (prima pagina)
Dimensioni pagina	pageSize		integer	Numero di elementi restituiti in una pagina.
Ordinamento	sort		string	Definisce la strategia da procedere per l'ordinamento senza distinzione tra maiuscole e minuscole. Deve essere solo un campo e deve iniziare con "+" per applicare l'ordine ASC o "-" per applicare l'ordine DESC. Il prefisso non verrà ordinato come ASC. Un campo non esistente nell'intestazione genererà un errore
Km Id	km_id	True	string	ID del modello di conoscenza

Restituisce

Pagina dei risultati dello schema trigger

triggerResultPage

Recupera la pagina successiva di eventi non inoltrati a causa di una sottoscrizione non riuscita

ID operazione:

nextPageFromRemainingData

Recupera la pagina successiva di eventi se non sono stati inoltrati a causa di una sottoscrizione non riuscita

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID sottoscrizione	subscription_id	True	string	ID sottoscrizione che recupererà l'evento non riuscito inviato, in un massimo di 50 elementi

Restituisce

Pagina dei risultati del segnale

SignalResultPage

Riprende la sottoscrizione per iniziare a ricevere nuovi eventi, ignorando gli eventi della cronologia

ID operazione:

resumeSubscriptionNoHistory

Riprende la sottoscrizione sospesa per iniziare a ricevere di nuovo nuovi eventi, ignorando gli eventi della cronologia

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID sottoscrizione	subscription_id	True	string	L'ID sottoscrizione verrà ripreso senza ricevere eventi passati

Riprende la sottoscrizione sospesa per avviare nuovamente la ricezione di eventi

ID operazione:

resumeSubscription

Riprende la sottoscrizione sospesa per avviare nuovamente la ricezione di eventi

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID sottoscrizione	subscription_id	True	string	L'ID sottoscrizione verrà ripreso e inizierà a ricevere di nuovo l'evento

Sospende la sottoscrizione per interrompere la ricezione di eventi

ID operazione:

pauseSubscription

Sospende la sottoscrizione per interrompere la ricezione di eventi

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID sottoscrizione	subscription_id	True	string	L'ID sottoscrizione verrà sospeso

Definizioni

SignalResultPage

Nome	Percorso	Tipo	Descrizione
contenuto	content	array of signalDTO
pageSize	pageSize	integer	Dimensioni della pagina, definite dal sistema

filterDTO

Filtro da applicare in un km

Nome	Percorso	Tipo	Descrizione
descrizione	description	string	Descrizione del filtro comprensibile
id	id	string	Identificatore univoco del filtro
nome	name	string	Nome visualizzato filtro comprensibile

filterResultPage

Nome	Percorso	Tipo	Descrizione
page	page	integer	Pagina
pageSize	pageSize	integer	Dimensioni della pagina, definite dal parametro pageSize
sort	sort	string	Campo usato per applicare l'ordinamento ai dati richiesti, + o nessun simbolo significa ASC, - significa DESC
totale	total	integer	Totale elementi restituiti nella pagina
contenuto	content	array of filterDTO

knowledgeModelDetailedDTO

Struttura dei dati del modello di conoscenza

Nome	Percorso	Tipo	Descrizione
id	id	string	Identificatore univoco del modello di conoscenza
nome	name	string	Testo comprensibile umano
extendedKMId	extendedKMId	string	Modello di knowledge base usato come riferimento.

knowledgeModelResultPage

Nome	Percorso	Tipo	Descrizione
page	page	integer	Pagina
pageSize	pageSize	integer	Dimensioni della pagina, definite dal parametro pageSize
sort	sort	string	Campo usato per applicare l'ordinamento ai dati richiesti, + o nessun simbolo significa ASC, - significa DESC
totale	total	integer	Totale elementi restituiti nella pagina
contenuto	content	array of knowledgeModelSimplifiedDTO

knowledgeModelSimplifiedDTO

Struttura dei dati del modello di conoscenza

Nome	Percorso	Tipo	Descrizione
id	id	string	Identificatore univoco del modello di conoscenza
nome	name	string	Testo comprensibile umano
edito	published	string	Data di pubblicazione più recente

recordDTO

Record rappresenta un concetto all'interno di un modello di knowledge base

Nome	Percorso	Tipo	Descrizione
descrizione	description	string	Descrizione record
id	id	string	Identificatore univoco del record
nome	name	string	Nome visualizzato del record, un nome comprensibile
fields	fields	array of recordFieldDTO

recordFieldDTO

Campi per un record

Nome	Percorso	Tipo	Descrizione
format	format	string	Formato da applicare
id	id	string	Importo in sospeso per il pagamento
nome	name	string	nome comprensibile umano
type	type	string
unità	unit	string	Unità aggiunta al valore del campo

recordIdDTO

ID e nome del tipo di record

Nome	Percorso	Tipo	Descrizione
descrizione	description	string	Descrizione record
id	id	string	Identificatore univoco del record
nome	name	string	Nome visualizzato del record, un nome comprensibile

recordItemDTO

Nome	Percorso	Tipo	Descrizione
data	data	array of	Elenco di elementi record, composto con nome e valore
headers	headers	array of recordItemHeaderDTO

recordItemHeaderDTO

Nome	Percorso	Tipo	Descrizione
aggregazione	aggregation	boolean	Indicare se un campo è un'aggregazione/informazioni calcolate(KPI).
filterable	filterable	boolean	Indicare se il campo può essere filtrato.
format	format	string	Espressione di formato
id	id	string	Identità del campo da usare nell'elenco dei campi param e filterExpression param
nome	name	string	Testo comprensibile umano
sortable	sortable	boolean	Indicare se il campo può essere ordinato.
type	type	string	Tipi di dati possibili.
unità	unit	string	Segno complementare per la visualizzazione del valore del formato

recordResultPageDTO

Nome	Percorso	Tipo	Descrizione
page	page	integer	Pagina
pageSize	pageSize	integer	Dimensioni della pagina, definite dal parametro pageSize
sort	sort	array of string
totale	total	integer	Totale elementi restituiti nella pagina
Elemento record	content	recordItemDTO

recordSchemaResultPage

Nome	Percorso	Tipo	Descrizione
page	page	integer	Pagina
pageSize	pageSize	integer	Dimensioni della pagina, definite dal parametro pageSize
sort	sort	string	Campo usato per applicare l'ordinamento ai dati richiesti, + o nessun simbolo significa ASC, - significa DESC
totale	total	integer	Totale elementi restituiti nella pagina
contenuto	content	array of recordIdDTO

signalDTO

Segnale archiviato nella sottoscrizione

Nome	Percorso	Tipo	Descrizione
signal	signal	string	Json non elaborato di un segnale
subscriptionId	subscriptionId	string	Identificatore univoco del Sottoscrittore come SUID
triggerId	triggerId	string	Identificatore univoco del trigger come SUID
data di creazione	creationDate	date-time	Data della creazione del segnale

subscriptionDTO

Schema di sottoscrizione

Nome	Percorso	Tipo	Descrizione
configurazioni	configurations	array of string	Configurazione per la sottoscrizione
id	id	string	Identificatore univoco del Sottoscrittore come SUID
knowledgeModelId	knowledgeModelId	string	Identificatore univoco del modello di conoscenza
latestSucceedEvent	latestSucceedEvent	date-time	Data dell'ultimo evento riuscito
nome	name	string	Nome sottoscrizione comprensibile
status	status	string
triggerId	triggerId	string	Identificatore univoco del trigger come SUID

subscriptionResultPage

Nome	Percorso	Tipo	Descrizione
page	page	integer	Pagina
pageSize	pageSize	integer	Dimensioni della pagina, definite dal parametro pageSize
sort	sort	string	Campo usato per applicare l'ordinamento ai dati richiesti, + o nessun simbolo significa ASC, - significa DESC
totale	total	integer	Totale elementi restituiti nella pagina
contenuto	content	array of subscriptionDTO

triggerDTO

Trigger definito al servizio di gestione delle chiavi

Nome	Percorso	Tipo	Descrizione
id	id	string	Identificatore univoco del trigger come SUID
nome	name	string	Nome trigger comprensibile
Registrazione	record	string	Identificatore univoco del record come SUID

triggerResultPage

Nome	Percorso	Tipo	Descrizione
page	page	integer	Pagina
pageSize	pageSize	integer	Dimensioni della pagina, definite dal parametro pageSize
sort	sort	string	Campo usato per applicare l'ordinamento ai dati richiesti, + o nessun simbolo significa ASC, - significa DESC
totale	total	integer	Totale elementi restituiti nella pagina
contenuto	content	array of triggerDTO

corda

Si tratta del tipo di dati di base 'string'.