Celonis (förhandsversion)

Celonis Platform API för att arbeta med kunskapsmodellelement, till exempel poster, KPI:er, filter, utlösare och deras relaterade data.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	Celonis Support
URL	https://developer.celonis.com/
E-postmeddelande	intelligence-api-feedback-sc@celonis.de

Metadata för anslutningsprogram
Utgivare	Celonis
Webbplats	https://www.celonis.com
Sekretesspolicy	https://www.celonis.com/privacy-policy/
Kategorier	Artificiell intelligens; Företagsledning

Titel

Celonis Intelligence-API:et gör det möjligt för Celonis-kunder att bädda in användbar processinformation på plattformar från tredje part där slutanvändare kan dra nytta av Celonis processinsikter. På så sätt skulle det föra Celonis-intelligens som process-KPI:er eller bearbeta ineffektivitet närmare slutanvändarna och gynna operativa användare utan aktuell åtkomst till Celonis genom att ge värdefulla insikter för bättre beslutsfattande samtidigt som de utför sina dagliga aktiviteter. Förutom datafrågefunktionen stöder Intelligence API även push-överföring av data till plattformar från tredje part genom att tillåta dem att prenumerera på affärsutlösare.

Utgivare: Utgivarens namn

Celonis

Förutsättningar

1. Ett team i Celonis Platform.
2. En kunskapsmodell som är tillgänglig i en klients team.
3. Processbaserad Celonis-prenumeration (kontakta ditt kontoteam för att verifiera).

Åtgärder som stöds

De aktuella API-metoderna gör det möjligt för konsumenter att interagera med kunskapsmodeller som definierats i Celonis Platform genom att tillhandahålla följande funktioner:

Identifieringsmetoder för kunskapsmodeller

Hämta en lista över kunskapsmodeller (KM)

Hämta en lista över KM-poster

Hämta information om KM-postschema

Hämta en lista över KM-filter

Datahämtningsmetoder för kunskapsmodell

Hämta en lista över KM-postdata

Hanteringsmetoder för prenumerationslivscykel

Hämta en lista över prenumerationer

Hämta en lista över KM-utlösare

Skapa en prenumeration på en KM-utlösare

Uppdatera en prenumeration

Pausa en prenumeration

Återuppta en prenumeration

Avsluta en prenumeration

Hämta autentiseringsuppgifter

Authentication

Varje begäran till API:et måste autentiseras med en Celonis API-nyckel. Det finns två sätt att göra detta:

Använda en api-nyckel för användare

Du kan ta reda på hur du skapar en användar-API-nyckel genom att följa guiden Användar-API-nycklar . Celonis API använder autentisering med ägartoken för att verifiera konsumentåtkomst. Autentiseringsuppgifterna måste skickas i ett auktoriseringshuvud i HTTP-begäran. Autentiseringsuppgifter som skickas i URL:en eller brödtexten i begäran ignoreras. Så här autentiserar du med ägartokenautentisering:

1. Skapa token i Celonis: MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
2. Inkludera strängen i HTTP-auktoriseringshuvudet formaterat så här:
   Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM

Använda en API-nyckel för program

Du kan ta reda på hur du skapar en AppKey genom att följa guiden Api-nycklar för program . Så här autentiserar du med AppKey-autentisering:

1. Skapa AppKey i Celonis:
   MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
2. Inkludera strängen i HTTP-auktoriseringshuvudet formaterat så här:
   Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr

Authorization

Du måste ange rätt behörigheter och se till att användar-API-nyckeln eller program-API-nyckeln som används för auktoriseringsändamål har åtkomst till Celonis Studio-paketet som innehåller de kunskapsmodeller som du vill komma åt via API:er för intelligens. Du kan bevilja åtkomstbehörigheter genom att följa dessa steg:

• Gå till Studio-paketet.
• Klicka på de tre punkterna och välj Permissions från popup-menyn.
• Sök efter användaren (om du använder en ägartoken ) eller AppKey (om du använder en AppKey ) och bevilja minst USE PACKAGE rättigheter.

Komma igång

Bas-URL:en för Celonis-API:et är https://<team>.<cluster>.celonis.cloud/intelligence/api Om du vill hitta teamet och klustret kontrollerar du url:en som du använder för att komma åt Celonis-plattformen och hämta teamet och klustret från den. Celonis Intelligence API är ett JSON-API och dess slutpunkter returnerar alltid ett JSON-svar, oavsett om begäran lyckas. De aktuella API-metoderna gör det möjligt för konsumenter att interagera med kunskapsmodeller som definierats i Celonis Platform genom att tillhandahålla följande funktioner:

• Lista över tillgängliga kunskapsmodeller och deras information
• Lista över poster och deras information
• Lista över filter
• Data för en specifik post. Information om Celonis Intelligence API-funktioner på Celonis utvecklarportal.

Kända problem och begränsningar

Begränsning av hastighet

Api:et för intelligens skapades inte för massexport av RAW-data, utan för att göra de beräknade resultaten och insikterna från processutvinning tillgängliga för plattformar och program från tredje part. Därför tillämpar Celonis API hastighetsbegränsning. Det innebär att endast ett visst antal begäranden tillåts per dag och att ett visst antal poster kan hämtas i varje anrop. Celonis förbehåller sig rätten att när som helst justera hastighetsgränserna för att garantera högkvalitativ service för alla kunder. Om en klient upprepade gånger överskrider hastighetsgränserna eller ägnar sig åt beteende som anses vara misstänkt förbehåller sig Celonis rätten att tillfälligt eller permanent begränsa eller inaktivera åtkomsten till API:et för klienten. När en klient överskrider antalet begäranden per dag returnerar Celonis API ett 429-svar (för många begäranden) inklusive ett HTTP-huvud (x-ratelimit-reset) som anger den tid (i sekunder) som klienten behöver vänta innan en ny begäran kan bearbetas. Följande HTTP-huvuden returneras också som en del av varje anrop:

• x-ratelimit-limit : Representerar det maximala antalet begäranden som klienten kan utföra i det aktuella tidsfönstret.
• x-ratelimit-remaining : Antal återstående begäranden i det aktuella tidsfönstret. API:et har för närvarande följande standardgränser:

Tabell 1. Standardbegränsningar för frekvens för begäranden

| Gräns | Standardvärden | |--|--| | Maximalt antal begäranden/dag | 6000 begäranden/dag | | | Maximalt antal begäranden/sekund | 20 begäranden/sekund | | | Maximalt antal tillåtna fält per begäran i kunskapsmodellen | 200 fält/begäran | | | Maximalt antal poster per begäran som returneras när slutpunkten anropas /data | 50 poster/begäran | | | Totalt maximalt antal poster som kan hämtas via /data slutpunkten | Första 5.000 posterna per filtrerad/sorterad tabell | Prenumeration på Utlösare framtvingar också hastighetsbegränsning. Det innebär att endast ett visst antal prenumerationer kan skapas för ett team. Oavsett hur många prenumerationer som skapas finns det dessutom ett maximalt antal händelser som kan skickas från API:et till konsumenter från tredje part. Om en klient når det maximala antalet prenumerationer måste de ta bort en befintlig prenumeration för att kunna skapa en ny. Om en klient når det maximala antalet händelser som genereras från API:et tas resten av data som produceras av Celonis Platform bort. Om klienten närmar sig sin dagliga kvot informeras de via e-post till ditt administratörskonto. Det första e-postmeddelandet skickas när 80% av kvoten överskrids, så att ditt administratörskonto vet att du är över den procentandelen. Det andra e-postmeddelandet skickas så snart du överskrider 100% av kvoten. API:et har för närvarande följande standardgränser:

Tabell 2. Standardbegränsningar för händelsefrekvens

| Gräns | Standardvärden | |--|--| | Maximalt antal prenumerationer/team | 10 | | | Maximalt antal händelser/dag | 100,000 | Kontakta ditt kontoteam för att verifiera teamets gränser.

Vanliga frågor och svar

Läs avsnittet Vanliga frågor och svar i Celonis Developer Portal.

Distributionsinstruktioner

Obligatoriskt. Lägg till instruktioner för hur du distribuerar den här anslutningsappen som anpassad anslutningsapp.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
Grupp	snöre	Ange Celonis-teamet.	Sann
Cluster	snöre	Ange Celonis-klustret.	Sann
Authorization	securestring	Auktoriseringen för det här API:et	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Avsluta prenumerationen från en utlösare och ta bort alla data för prenumerationen	Avsluta prenumerationen från en utlösare och ta bort alla data för prenumerationen
Hämta en lista över KM-filter	Lista över filter för kunskapsmodellen
Hämta en lista över KM-postdata	Data för en post i kunskapsmodellen
Hämta en lista över KM Records-schema	Lista över schema för poster
Hämta en lista över KM-utlösare	Lista över utlösare för kunskapsmodellen
Hämta en lista över KM:er	Lista över kunskapsmodeller som definierats i ett EMS-team
Hämta en lista över prenumerationer	Lista över alla prenumerationer som skapats
Hämta information om km-postschema på den översta nivån	Information om postschema på toppnivå
Hämta km-information på den översta nivån	Kunskapsmodell definierad i ett EMS-team
Hämtar nästa sida med händelser som inte vidarebefordrades på grund av en misslyckad prenumeration	Hämtar nästa sida med händelser om de inte vidarebefordrades på grund av en misslyckad prenumeration
Pausar prenumerationen för att sluta ta emot händelser	Pausar prenumerationen för att sluta ta emot händelser
Skapar en prenumeration för utlösaren	Skapar en prenumeration för utlösaren
Uppdaterar en prenumeration	Uppdaterar en prenumeration
Återupptar pausad prenumeration för att börja ta emot händelser igen	Återupptar pausad prenumeration för att börja ta emot händelser igen
Återupptar prenumerationen för att börja ta emot nya händelser, ignorera historikhändelser	Återupptar pausad prenumeration för att börja ta emot nya händelser igen, ignorera historikhändelser

Avsluta prenumerationen från en utlösare och ta bort alla data för prenumerationen

Åtgärds-ID:

unsubscribe

Avsluta prenumerationen från en utlösare och ta bort alla data för prenumerationen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerations-ID	subscription_id	True	string	Prenumerations-ID tas bort

Hämta en lista över KM-filter

Åtgärds-ID:

getFilters

Lista över filter för kunskapsmodellen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sida	page		integer	Sidnumret för resultatet med början 0 (första sidan)
Sidstorlek	pageSize		integer	Antalet objekt som returneras på en sida.
Sortering	sort		string	Definierar strategin för att fortsätta vid skiftlägesokänslig sortering. Det måste bara vara ett fält och det bör börja med "+" för att tillämpa ASC-ordning eller "-" för att tillämpa DESC-ordning. Icke-prefix sorteras som ASC. Ett fel uppstår när det inte finns ett befintligt fält i rubriken
Kunskapsmodell-ID	km_id	True	string	Kunskapsmodell-ID

Returer

Resultatsida för filterschema

filterResultPage

Hämta en lista över KM-postdata

Åtgärds-ID:

getRecordDataResult

Data för en post i kunskapsmodellen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kunskapsmodell-ID	km_id	True	string	Kunskapsmodell-ID
Post-ID	record_id	True	string	Post-ID
Filterar	filters		array	Ett fördefinierat filter-ID
Fält-ID:t	fields	True	array	Ett fördefinierat filter-ID
Sida	page		integer	Sidnumret för resultatet med början 0 (första sidan)
Sidstorlek	pageSize		integer	Antalet objekt som returneras på en sida.
Sortering	sort		array	Definierar den strategi som ska fortsätta för sortering. Det måste vara en kommaavgränsad lista över fält och de bör börja med "+" för att tillämpa ASC-ordning eller "-" för att tillämpa DESC-ordning. Fält utan prefix sorteras som ASC. Icke-befintliga fält i rubriken utlöser ett fel
Filteruttryck	filterExpr		array	Dynamiska filteruttryck

Returer

Spela in dataresultatsida

recordResultPageDTO

Hämta en lista över KM Records-schema

Åtgärds-ID:

getRecords

Lista över schema för poster

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sida	page		integer	Sidnumret för resultatet med början 0 (första sidan)
Sidstorlek	pageSize		integer	Antalet objekt som returneras på en sida.
Sortering	sort		string	Definierar strategin för att fortsätta vid skiftlägesokänslig sortering. Det måste bara vara ett fält och det bör börja med "+" för att tillämpa ASC-ordning eller "-" för att tillämpa DESC-ordning. Icke-prefix sorteras som ASC. Ett fel uppstår när det inte finns ett befintligt fält i rubriken
Kunskapsmodell-ID	km_id	True	string	Kunskapsmodell-ID

Returer

Resultatsida för postschema

recordSchemaResultPage

Hämta en lista över KM-utlösare

Åtgärds-ID:

getTriggers

Lista över utlösare för kunskapsmodellen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sida	page		integer	Sidnumret för resultatet med början 0 (första sidan)
Sidstorlek	pageSize		integer	Antalet objekt som returneras på en sida.
Sortera	sort		string	Definierar strategin för att fortsätta vid skiftlägesokänslig sortering. Det måste bara vara ett fält och det bör börja med "+" för att tillämpa ASC-ordning eller "-" för att tillämpa DESC-ordning. Icke-prefix sorteras som ASC. Ett fel uppstår när det inte finns ett befintligt fält i rubriken
Km-ID	km_id	True	string	Kunskapsmodell-ID

Returer

Resultatsida för utlösarschema

triggerResultPage

Hämta en lista över KM:er

Åtgärds-ID:

getKnowledgeModel

Lista över kunskapsmodeller som definierats i ett EMS-team

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sida	page		integer	Sidnumret för resultatet med början 0 (första sidan)
Sidstorlek	pageSize		integer	Antalet objekt som returneras på en sida.
Sortering	sort		string	Definierar strategin för att fortsätta vid skiftlägesokänslig sortering. Det måste bara vara ett fält och det bör börja med "+" för att tillämpa ASC-ordning eller "-" för att tillämpa DESC-ordning. Icke-prefix sorteras som ASC. Ett fel uppstår när det inte finns ett befintligt fält i rubriken

Returer

Resultatsida för KnowledgeModel

knowledgeModelResultPage

Hämta en lista över prenumerationer

Åtgärds-ID:

getSubscriptions

Lista över alla prenumerationer som skapats

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sida	page		integer	Sidnumret för resultatet med början 0 (första sidan)
Sidstorlek	pageSize		integer	Antalet objekt som returneras på en sida.
Sortera	sort		string	Definierar strategin för att fortsätta vid skiftlägesokänslig sortering. Det måste bara vara ett fält och det bör börja med "+" för att tillämpa ASC-ordning eller "-" för att tillämpa DESC-ordning. Icke-prefix sorteras som ASC. Ett fel uppstår när det inte finns ett befintligt fält i rubriken

Returer

Resultatsida för prenumerationsschema

subscriptionResultPage

Hämta information om km-postschema på den översta nivån

Åtgärds-ID:

getRecordDetails

Information om postschema på toppnivå

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kunskapsmodell-ID	km_id	True	string	Kunskapsmodell-ID
Post-ID	record_id	True	string	Post-ID

Returer

Posten representerar ett koncept i en kunskapsmodell

Posttyp

recordDTO

Hämta km-information på den översta nivån

Åtgärds-ID:

getKnowledgeModelDetails

Kunskapsmodell definierad i ett EMS-team

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kunskapsmodell-ID	km_id	True	string	Kunskapsmodell-ID

Returer

Kunskapsmodelldatas struktur

Kunskapsmodell

knowledgeModelDetailedDTO

Hämtar nästa sida med händelser som inte vidarebefordrades på grund av en misslyckad prenumeration

Åtgärds-ID:

nextPageFromRemainingData

Hämtar nästa sida med händelser om de inte vidarebefordrades på grund av en misslyckad prenumeration

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerations-ID	subscription_id	True	string	Prenumerations-ID:t som hämtar den misslyckade händelsen som skickas, i högst 50 objekt

Returer

Signalresultatsida

SignalResultPage

Pausar prenumerationen för att sluta ta emot händelser

Åtgärds-ID:

pauseSubscription

Pausar prenumerationen för att sluta ta emot händelser

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerations-ID	subscription_id	True	string	Prenumerations-ID:t pausas

Skapar en prenumeration för utlösaren

Åtgärds-ID:

createSubscription

Skapar en prenumeration för utlösaren

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Km-ID	km_id	True	string	Kunskapsmodell-ID
Utlösar-ID	trigger_id	True	string	Utlösar-ID
headers	headers		object	Motringningshuvuden kan innehålla autentiseringstoken, innehållstyp osv.
protocol	protocol	True	string	Det enda värde som är möjligt är faktiskt HTTPS, vilket innebär att återanrops-URI:n måste vara en giltig https
URI	uri	True	string	Uri för att utföra återanropet från Intelligence API när utlösaren har utlösts
configurations	configurations		array of string	Konfiguration för prenumerationen
name	name	True	string	Namn på prenumerationen

Returer

response

string

Uppdaterar en prenumeration

Åtgärds-ID:

updateSubscription

Uppdaterar en prenumeration

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerations-ID	subscription_id	True	string	Prenumerations-ID:t som kommer att uppdateras helt
headers	headers		object	Motringningshuvuden kan innehålla autentiseringstoken, innehållstyp osv.
protocol	protocol	True	string	Det enda värde som är möjligt är faktiskt HTTPS, vilket innebär att återanrops-URI:n måste vara en giltig https
URI	uri	True	string	Uri för att utföra återanropet från Intelligence API när utlösaren har utlösts
configurations	configurations		array of string	Konfiguration för prenumerationen
name	name	True	string	Namn på prenumerationen

Återupptar pausad prenumeration för att börja ta emot händelser igen

Åtgärds-ID:

resumeSubscription

Återupptar pausad prenumeration för att börja ta emot händelser igen

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerations-ID	subscription_id	True	string	Prenumerations-ID:t återupptas och börjar ta emot händelsen igen

Återupptar prenumerationen för att börja ta emot nya händelser, ignorera historikhändelser

Åtgärds-ID:

resumeSubscriptionNoHistory

Återupptar pausad prenumeration för att börja ta emot nya händelser igen, ignorera historikhändelser

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerations-ID	subscription_id	True	string	Prenumerations-ID:t återupptas utan att skickas

Definitioner

SignalResultPage

Name	Sökväg	Typ	Description
innehåll	content	array of signalDTO
pageSize	pageSize	integer	Sidstorlek, definierad av systemet

filterDTO

Filter som ska tillämpas i en KM

Name	Sökväg	Typ	Description
beskrivning	description	string	Beskrivning av mänskligt begripligt filter
Id-nummer	id	string	Filtrets unika identifierare
name	name	string	Visningsnamn för mänskligt begripligt filter

filterResultPage

Name	Sökväg	Typ	Description
sida	page	integer	Sida
pageSize	pageSize	integer	Sidstorlek, definierad av parametern pageSize
sort	sort	string	Fält som används för att tillämpa sortering på begärda data, + eller ingen symbol betyder ASC, - betyder DESC
summa	total	integer	Totalt antal element som returneras på sidan
innehåll	content	array of filterDTO

knowledgeModelDetailedDTO

Kunskapsmodelldatas struktur

Name	Sökväg	Typ	Description
Id-nummer	id	string	Unik identifierare för kunskapsmodell
name	name	string	Mänsklig begriplig text
extendedKMId	extendedKMId	string	Kunskapsmodell som används som referens, KM-bas.

knowledgeModelResultPage

Name	Sökväg	Typ	Description
sida	page	integer	Sida
pageSize	pageSize	integer	Sidstorlek, definierad av parametern pageSize
sort	sort	string	Fält som används för att tillämpa sortering på begärda data, + eller ingen symbol betyder ASC, - betyder DESC
summa	total	integer	Totalt antal element som returneras på sidan
innehåll	content	array of knowledgeModelSimplifiedDTO

knowledgeModelSimplifiedDTO

Kunskapsmodelldatas struktur

Name	Sökväg	Typ	Description
Id-nummer	id	string	Unik identifierare för kunskapsmodell
name	name	string	Mänsklig begriplig text
publicerad	published	string	Senaste publicerade datum

recordDTO

Posten representerar ett koncept i en kunskapsmodell

Name	Sökväg	Typ	Description
beskrivning	description	string	Postbeskrivning
Id-nummer	id	string	Postens unika identifierare
name	name	string	Postvisningsnamn, ett mänskligt begripligt namn
Fält	fields	array of recordFieldDTO

recordFieldDTO

Fält för en post

Name	Sökväg	Typ	Description
format	format	string	Format som ska användas
Id-nummer	id	string	Belopp som väntar på att betalas
name	name	string	mänskligt begripligt namn
type	type	string
enhet	unit	string	Enhet som har lagts till i fältvärdet

recordIdDTO

Posttypens ID och namn

Name	Sökväg	Typ	Description
beskrivning	description	string	Postbeskrivning
Id-nummer	id	string	Postens unika identifierare
name	name	string	Postvisningsnamn, ett mänskligt begripligt namn

recordItemDTO

Name	Sökväg	Typ	Description
data	data	array of	Lista över postobjekt, sammansatt med namn och värde
headers	headers	array of recordItemHeaderDTO

recordItemHeaderDTO

Name	Sökväg	Typ	Description
aggregering	aggregation	boolean	Ange om ett fält är en aggregering/beräknad information (KPI).
filtrerbart	filterable	boolean	Ange om fältet kan filtreras.
format	format	string	Formatera uttryck
Id-nummer	id	string	Fältidentitet som ska användas i param för fältlista och filterExpression-param
name	name	string	Mänsklig begriplig text
sorterbar	sortable	boolean	Ange om fältet kan sorteras.
type	type	string	Möjliga datatyper.
enhet	unit	string	Ett kompletterande tecken för formatvärdesvyn

recordResultPageDTO

Name	Sökväg	Typ	Description
sida	page	integer	Sida
pageSize	pageSize	integer	Sidstorlek, definierad av parametern pageSize
sort	sort	array of string
summa	total	integer	Totalt antal element som returneras på sidan
Postobjekt	content	recordItemDTO

recordSchemaResultPage

Name	Sökväg	Typ	Description
sida	page	integer	Sida
pageSize	pageSize	integer	Sidstorlek, definierad av parametern pageSize
sort	sort	string	Fält som används för att tillämpa sortering på begärda data, + eller ingen symbol betyder ASC, - betyder DESC
summa	total	integer	Totalt antal element som returneras på sidan
innehåll	content	array of recordIdDTO

signalDTO

Signal lagrad i prenumerationen

Name	Sökväg	Typ	Description
signal	signal	string	Rå json för en signal
subscriptionId	subscriptionId	string	Prenumerantens unika identifierare som suid
triggerId	triggerId	string	Utlösarens unika identifierare som ett SUID
skapelsedatum	creationDate	date-time	Datum då signalen skapades

subscriptionDTO

Prenumerationsschema

Name	Sökväg	Typ	Description
configurations	configurations	array of string	Konfiguration för prenumerationen
Id-nummer	id	string	Prenumerantens unika identifierare som suid
knowledgeModelId	knowledgeModelId	string	Unik identifierare för kunskapsmodell
latestSucceedEvent	latestSucceedEvent	date-time	Datum för den senast lyckade händelsen
name	name	string	Mänskligt begripligt prenumerationsnamn
status	status	string
triggerId	triggerId	string	Utlösarens unika identifierare som ett SUID

subscriptionResultPage

Name	Sökväg	Typ	Description
sida	page	integer	Sida
pageSize	pageSize	integer	Sidstorlek, definierad av parametern pageSize
sort	sort	string	Fält som används för att tillämpa sortering på begärda data, + eller ingen symbol betyder ASC, - betyder DESC
summa	total	integer	Totalt antal element som returneras på sidan
innehåll	content	array of subscriptionDTO

triggerDTO

Utlösare definierad vid KM

Name	Sökväg	Typ	Description
Id-nummer	id	string	Utlösarens unika identifierare som ett SUID
name	name	string	Mänskligt begripligt utlösarnamn
rekord	record	string	Postens unika identifierare som ett SUID

triggerResultPage

Name	Sökväg	Typ	Description
sida	page	integer	Sida
pageSize	pageSize	integer	Sidstorlek, definierad av parametern pageSize
sort	sort	string	Fält som används för att tillämpa sortering på begärda data, + eller ingen symbol betyder ASC, - betyder DESC
summa	total	integer	Totalt antal element som returneras på sidan
innehåll	content	array of triggerDTO

snöre

Det här är den grundläggande datatypen "string".