SIGNL4 – Mobila aviseringar

SIGNL4 erbjuder kritiska mobila aviseringar, incidenthantering och tjänstsändning för drift av kritisk infrastruktur. Den varnar dig beständigt via app-push, SMS-sms och röstsamtal, inklusive spårning, eskalering, samarbete och tjänstplanering.

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 Derdack GmbH
URL https://www.signl4.com/feedback-we-love-hear-from-you/
E-postmeddelande success@signl4.com
Metadata för anslutningsprogram
Utgivare Derdack
Webbplats https://www.signl4.com
Sekretesspolicy https://www.signl4.com/privacy-policy/
Kategorier IT-åtgärder; Kommunikation

SIGNL4 erbjuder kritiska aviseringar, incidenthantering och tjänstsändning för drift av kritisk infrastruktur. Den varnar dig beständigt via app-push, SMS-sms och röstsamtal, inklusive spårning, eskalering, samarbete och tjänstplanering.

Du kan integrera SIGNL4 i ditt flöde för att skicka tillförlitliga teamaviseringar när det behövs.

Förutsättningar

Du behöver ett SIGNL4-konto. Om du inte redan har en kan du få en på https://connect.signl4.com/. Du kan också ladda ned mobilappen direkt från Google Play Store eller från Apple App Store.

Hämta autentiseringsuppgifter

För att kunna använda anslutningsappen behöver du din SIGNL4 API-nyckel. I SIGNL4-webbportalen får du din API-nyckel under Integreringar –> API-nyckel. Du kan sedan använda din API-nyckel för att autentisera din SIGNL4-anslutningsapp i Power Automate.

Kom igång med anslutningsappen

Du hittar en detaljerad beskrivning av FUNKTIONERNA i SIGNL4 API här. När du har lagt till SIGNL4-anslutningsappen i ditt Power Automate-flöde måste du hämta SIGNL4 API-nyckeln. Sedan kan du använda API-funktionerna i enlighet med detta. Om du har ytterligare frågor tveka inte att kontakta SIGNL4-teamet.

Det enklaste sättet att starta är att använda åtgärden EventsSend för att skicka en avisering:

  • Hämta först din SIGNL4-grupphemlighet/integreringshemlighet från signl4-webbportalen.
  • När du har grupphemligheten/integreringshemligheten kan du använda den här i funktionen EventsSend för att utlösa en händelse som kan generera en avisering för ditt team. Du behöver bara ange en rubrik och ett meddelande. Du hittar en beskrivning av de andra parametrarna på sidan för inkommande webhookdokumentation.
  • Nu utlöser du en händelse och får en avisering i SIGNL4.

Kända problem och begränsningar

SIGNL4-anslutningsappen för Power Automate kapslar in hela SIGNL4 REST API 2.0. Vissa funktioner beror på din SIGNL4-plan.

Vanliga fel och åtgärder

N/A

Vanliga frågor

Du hittar vanliga frågor och svar om SIGNL4 och onlinehjälp här. Det finns också ett omfattande videobibliotek .

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
API-nyckel securestring API-nyckeln för det här API:et Sann

Begränsningsgränser

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

Åtgärder

Acknowlegde flera aviseringar

Den här metoden bekräftar alla aviseringar som tillhandahålls.

Aktiverar en skriptinstans

Aktiverar en skriptinstans.

Ange en användares plats

Ange en användares plats.

Ange kategoriprenumerationer

Exempelbegäran:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Ange meddelandeprofiler för användare

Ange meddelandeprofiler för användaren.

Ange telefonnummer för en användare

Ange telefonnummer för en användare. Om ett annat telefonnummer sparas skrivs det över.

Anger aviseringsinställningar för ett specifikt team

Anger aviseringsinställningar för ett specifikt team.

Bekräfta en avisering

Bekräfta en avisering.

Bekräftar alla synliga aviseringar

Den här metoden bekräftar alla ohanterade aviseringar som teamet för närvarande har av en specifik användare.

Bjud in användare till ett team

Bjud in användare till ett team.

Dra tillbaka stängning av flera aviseringar

Den här metoden försöker ångra flera aviseringsstängningar. Åtgärden hanteras i bakgrunden.

Eskalera en avisering manuellt till ett team

Eskalera en avisering manuellt till ett team.

Få aviseringar

Få meddelanden om alla användare via aviserings-ID.

Få information om en avisering

Få information om en avisering.

Få semester för teamet

Få semester för teamet.

Hämta alla användare

Returnerar en lista över användarobjekt med information, till exempel deras e-postadress och tjänstinformation. Endast användare som du har åtkomst till returneras.

Hämta alla användare av angivna team

Hämta alla användare av angivna team.

Hämta alla aviseringsmönster från teamet

Hämta alla aviseringsmönster från teamet.

Hämta alla kategorier

Hämta alla kategorier.

Hämta alla kategorier

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
Hämta alla pratbubblans mallar för din prenumeration

Hämta alla pratbubblans mallar för din prenumeration.

Hämta alla team som användaren är medlem i

Returnerar en lista över teamobjekt med information, till exempel deras namn. Endast team som användaren är medlem i returneras.

Hämta alla tillgängliga definitioner

Hämta alla tillgängliga definitioner.

Hämta användare efter ID

Returnerar ett användarobjekt med information som hans e-postadress och tjänstinformation.

Hämta avisering

Hämtar en avisering via ID.

Hämta aviseringsrapport

Returnerar information om den inträffade aviseringsvolymen under olika tidsperioder samt information om svarsbeteendet (mängden bekräftade och ohanterade aviseringar) för gruppmedlemmarna.

Hämta en definition

Hämta en definition.

Hämta en prenumerations aktuella förbetalda inställningar

Hämta en prenumerations aktuella förbetalda inställningar.

Hämta en prenumerations aktuella förbetalda saldo

Hämta en prenumerations aktuella förbetalda saldo.

Hämta en prenumerations förbetalda transaktioner

Hämta en prenumerations förbetalda transaktioner.

Hämta en specifik kategori

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Hämta gruppmedlemskap efter team

Få teammedlemskap per team.

Hämta händelsekälla efter ID

Hämta händelsekälla efter ID.

Hämta händelsekällor från ett eller flera team

Hämta händelsekällor från ett eller flera team.

Hämta händelseparametrar

Hämta parametrar för en händelse efter ID.

Hämta information för alla team i prenumerationen

Hämta information för alla team i prenumerationen.

Hämta information om alla team

Få information om alla team.

Hämta information om alla tillgängliga och hanterade prenumerationer

Hämta information om alla tillgängliga/hanterade prenumerationer.

Hämta information om bifogade filer för en avisering

Hämta bifogade filer för en avisering via ID.

Hämta information om en händelse

Få information om en händelse.

Hämta information om en specifik prenumeration

Hämta information om en specifik prenumeration.

Hämta information om nedladdningsbara aviseringsrapporter

Hämta information om nedladdningsbara aviseringsrapporter.

Hämta information om tjänstassistenten för team

Få information om tjänstassistenten för team.

Hämta inställningar för teamtjänst för flera team

Hämta inställningar för teamtjänst för flera team.

Hämta kategoriprenumerationer

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Hämta meddelandeprofiler för användare

Hämta meddelandeprofiler för användaren.

Hämta mått för alla kategorier

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics
Hämta mått för en specifik kategori

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics
Hämta offentlig information om alla team i en prenumeration

Få offentlig information om alla team i en prenumeration.

Hämta personlig användarbild

Hämta en personlig användarbild.

Hämta prenumerationens aktuella förbetalda inställningar

Hämta prenumerationens aktuella förbetalda inställningar.

Hämta prenumerationens aktuella förbetalda saldo

Hämta prenumerationens aktuella förbetalda saldo.

Hämta prenumerationens förbetalda transaktioner

Hämta prenumerationens förbetalda transaktioner.

Hämta sekretessinställningar för team för ett team

Hämta sekretessinställningar för team för ett team.

Hämta teammedlemskap från en användare

Hämta teammedlemskap från en användare.

Hämta tidslinjeposter för aviseringar

Hämta tidslinjeposter för aviseringar med ID.

Hämta tjänststatus efter användar-ID

Returnerar ett objekt med tullinformation.

Hämta Webhook efter ID

Returnerar information om webhooken som anges av det skickade ID:t.

Hämta Webhooks

Returnerar en samling definierade utgående webhooks i systemet.

Hämta översiktshändelse

Hämta översiktshändelsen efter ID.

Hämta översiktshändelsen sidad

Hämta översiktshändelsen. Om det finns fler resultat får du också en fortsättningstoken som du kan lägga till i händelsefiltret.

Hämtar aviseringsinställningar för ett specifikt team

Hämtar aviseringsinställningar för ett specifikt team.

Hämtar aviseringsinställningar för ett specifikt team

Hämtar aviseringsinställningar för ett specifikt team.

Hämtar bild av ett angivet team

Hämtar bild av ett angivet team.

Hämtar en angiven bifogad fil för en angiven avisering

Hämtar en angiven bifogad fil för en angiven avisering.

Hämtar en prenumerations användarlicenser

Hämtar en prenumerations användarlicenser.

Hämtar en prenumerations röstnummerlicenser

Hämtar en prenumerations röstnummerlicenser.

Hämtar händelsekällor för ett specifikt team

Hämtar händelsekällor för ett specifikt team.

Hämtar information om ett specifikt team

Hämtar information om ett specifikt team.

Hämtar installationsframställningen för en specifik användare

Hämtar installationsframställningen för en viss användare.

Hämtar installationsframställningen för ett specifikt team

Hämtar installationsframställningen för ett specifikt team.

Hämtar namnen på alla aviseringskategoribilder

Hämtar namnen på alla aviseringskategoribilder. Du kan hämta bilden genom att gå till account.signl4.com/images/alerts/categoryImageName.svg.

Hämtar sidiga aviseringar

Hämtar sidiga aviseringar.

Inaktiverar en viss skriptinstans

Inaktiverar en viss skriptinstans.

Kommentera avisering

Kommenterar en avisering med angiven anteckningsinformation.

Kontrollerar om en användare har den angivna behörigheten

Kontrollerar om en användare har den angivna behörigheten.

Kopiera helgdagar från ett team till ett annat

Kopiera helgdagar från ett team till ett annat.

Ladda ned tjänstrapport med ett specifikt fileName

Ladda ned tjänstrapport med ett specifikt fileName.

Laddade upp en profilbild för ett angivet team

En profilbild har laddats upp för ett angivet team.

Lägga till användare i ett team

Lägg till användare i ett team.

Möjlighet att aktivera en webHook

Möjlighet att aktivera en webHook.

Möjlighet att inaktivera en webHook

Möjlighet att inaktivera en webHook.

Returnerar all information om en viss skriptinstans

Hämtar skriptinstansen som anges av det skickade instans-ID:t.

Returnerar alla inventeringsskript

Returnerar alla inventeringsskript.

Returnerar alla skriptinstanser av SIGNL4-teamet

Returnerar alla skriptinstanser i prenumerationen.

Returnerar alla tillgängliga inventeringsskript

Returnerar alla tillgängliga inventeringsskript som kan läggas till i en SIGNL4-prenumeration.

Returnerar aviseringsrapport

Returnerar aviseringsrapport.

Returnerar en fjärråtgärd

Exempelbegäran:

GET /RemoteActions/{actionId}
Returnerar ett fjärrjobb från journalen

Exempelbegäran:

GET /remoteActions/journal/{jobId}
Returnerar ett inventeringsskript med dess ID

Hämtar skriptet som anges av det skickade skript-ID:t.

Returnerar fjärrjobb som är sidiga från journalen

Exempelbegäran:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}
Returnerar fjärråtgärder

Exempelbegäran:

GET /RemoteActions?externalId=12345
Returnerar funktionerna i en angiven prenumeration

Returnerar funktionerna i en angiven prenumeration.

Returnerar information om alla planerade scheman

Returnerar information om alla planerade scheman.

Returnerar information om tullschemat med angivet ID

Returnerar information om tullschemat med det angivna ID:t.

Returnerar prenumerationens kanalprisinformation

Returnerar prenumerationens kanalprisinformation.

Skapa eller uppdatera angivet tullschema

Skapa/uppdatera angivet tjänstschema.

Skapa en ny fjärråtgärd

Exempelbegäran:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}
Skapa en ny kategori

Exempelbegäran:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}
Skapa ett nytt aviseringsmönster

Skapa ett nytt aviseringsmönster.

Skapa ett nytt fjärrjobb

Exempelbegäran:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}
Skapa händelsekälla

Skapa händelsekälla.

Skapa nya mallar för pratbubblan för din prenumeration

Skapa nya pratbubblan mallar för din prenumeration.

Skapa webhook

Skapar en ny utgående webhook som meddelas när vissa händelser inträffar.

Skapar en ny skriptinstans i SIGNL4-teamet

Skapar en ny skriptinstans av skriptet som anges i begärandetexten.

Skicka händelse

Skicka händelse.

Skickar e-post med inbjudan igen om det finns en inbjudan

Skickar e-post med inbjudan igen om det finns en inbjudan.

Skickar ett e-postmeddelande till en angiven användare

Skickar ett e-postmeddelande till en angiven användare som innehåller information om alla händelsekällor i användarens team.

Slå in användare

Den angivna användaren kommer att slås in i tjänst.

Slå in användare som chef

Den angivna användaren kommer att bli instansad i tjänst som chef.

Slå ut användaren

Den angivna användaren kommer att slås ut från tjänsten.

Spara flera scheman

Spara flera scheman. Du kan åsidosätta befintliga scheman om du vill.

Spara helgdagar för ett team

Spara semester för ett team.

Spara upprepade helgdagar för ett team

Spara upprepade helgdagar för ett team.

Stäng alla bekräftade aviseringar

Den här metoden stänger alla bekräftade aviseringar som ditt team för närvarande har.

Stäng en avisering

Stäng en avisering.

Stäng flera aviseringar

Den här metoden stänger alla aviseringar som tillhandahålls.

Ta bort en befintlig kategori

Exempelbegäran:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Ta bort en befintlig pratbubblansmall från din prenumeration

Ta bort den befintliga pratbubblan från din prenumeration.

Ta bort en händelsedistribution

Ta bort en händelsedistribution.

Ta bort en händelsekälla

Ta bort en händelsekälla.

Ta bort en kontaktadress från en användare

Ta bort en kontaktadress från en användare.

Ta bort en personlig användarbild

Ta bort en personlig användarbild.

Ta bort en specifik tull

Ta bort en specifik plikt.

Ta bort ett specifikt aviseringsmönster

Ta bort ett specifikt aviseringsmönster.

Ta bort helgdagar

Ta bort helgdagar.

Ta bort telefonnummer för en användare

Ta bort en användares telefonnummer.

Ta bort tjänstscheman inom intervallet

Ta bort tjänstscheman inom intervallet.

Ta bort Webhook efter ID

Tar bort den angivna webhooken så att den inte längre meddelas.

Tar bort aktuell gruppbild

Tar bort den aktuella gruppbilden.

Tar bort användarkonto

Tar bort användarkontot.

Tar bort en användare eller inbjudan från ett team

Tar bort en användare eller inbjudan från ett team.

Tar bort en fjärråtgärd

Exempelbegäran:

DELETE /eaRemoteActions/{actionId}
Tar bort en skriptinstans

Hämtar skriptinstansen som anges av det skickade instans-ID:t.

Uppdatera användarens teammedlemskap

Uppdaterar användarens gruppmedlemskap. Du kan flytta användaren till ett annat team i prenumerationen och/eller ändra användarens roll.

Uppdatera en befintlig kategori

Exempelbegäran:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}
Uppdatera en befintlig pratbubblans mall för din prenumeration

Uppdatera den befintliga pratbubblan för din prenumeration.

Uppdatera en händelsekälla

Uppdatera en händelsekälla.

Uppdatera en prenumerations aktuella förbetalda inställningar

Uppdatera en prenumerations aktuella förbetalda inställningar.

Uppdatera ett befintligt aviseringsmönster

Uppdatera ett befintligt aviseringsmönster.

Uppdatera prenumerationens aktuella förbetalda inställningar

Uppdatera prenumerationens aktuella förbetalda inställningar.

Uppdatera sekretessinställningar för ett team

Uppdatera sekretessinställningar för ett team.

Uppdatera språkinformation (t.ex. språk, tidszon) för användare

Uppdatera språkinformation (t.ex. språk, tidszon) för användaren.

Uppdatera Webhook efter ID

Uppdaterar den angivna webhooken.

Uppdaterar anpassade data för en viss skriptinstans som innehåller dess visningsnamn

Uppdaterar den angivna skriptinstansen.

Uppdaterar användarprofilen för en användare

Uppdaterar användarens användarprofil.

Uppdaterar en fjärråtgärd

Exempelbegäran:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}
Uppdaterar en prenumerationsprofil

Uppdaterar en prenumerationsprofil.

Uppdaterar en viss skriptinstans

Uppdaterar den angivna skriptinstansen, som vanligtvis används för att uppdatera konfigurationen av ett skript.

Uppdaterar lösenordet för en användare

Uppdaterar lösenordet för en användare.

Uppdaterar teamprofilen för ett team

Uppdaterar teamprofilen för ett team.

Utlösaravisering

Utlöser en ny avisering för ditt team. Alla teammedlemmar i tjänst får aviseringsaviseringar.

Verifiera ett mönsters tidsintervall

Verifiera ett tidsintervall för ett mönster mot alla befintliga tidsintervall för andra mönster.

Verifierar ett tidigare skapat telefonnummer för en användare

Verifierar ett tidigare skapat telefonnummer för en användare.

Ångra bekräftelsen av en avisering

Den här metoden försöker ångra en aviseringsigenkänning.

Ångra flera bekräftelser i kön

Den här metoden försöker ångra bekräftelsen av flera aviseringar via en kö. Åtgärden hanteras i bakgrunden.

Ångra stängningen av en avisering

Den här metoden försöker ångra en aviseringsstängning.

Överförde en profilbild för en angiven användare

En profilbild har laddats upp för en angiven användare.

Acknowlegde flera aviseringar

Den här metoden bekräftar alla aviseringar som tillhandahålls.

Parametrar

Name Nyckel Obligatorisk Typ Description
alertIds
alertIds True array of string
descr
descr string
uid
uid True string

Aktiverar en skriptinstans

Aktiverar en skriptinstans.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skriptinstans-ID
instanceId True string

ID för den instans som ska aktiveras.

Returer

Ange en användares plats

Ange en användares plats.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för användaren.

latitude
latitude double
longitud
longitude double
tidsstämpel
timestamp date-time

Returer

Ange kategoriprenumerationer

Exempelbegäran:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

Kategori-ID
categoryId True string

Kategori som ska uppdateras

status
status True integer

  • 0 = Prenumererad
  • 1 = Avstängt
  • 2 = Dold
userId
userId True string

Returer

Ange meddelandeprofiler för användare

Ange meddelandeprofiler för användaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för den användare som du vill hämta aviseringsprofilerna från.

kanal
channel integer

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS
delayInMinutes (fördröjning) i minuter
delayInMinutes integer
enabled
enabled boolean
options
options integer
persistent
persistent boolean

Returer

Ange telefonnummer för en användare

Ange telefonnummer för en användare. Om ett annat telefonnummer sparas skrivs det över.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID för den användare som du vill lägga till ett telefonnummer i

landskod
countryCode string
telefonnummer
phoneNumber string
sendValidationCode
sendValidationCode boolean
sendValidationCodeVia
sendValidationCodeVia integer

  • 0 = Inga
  • 1 = SMS
  • 2 = Röst

Returer

Anger aviseringsinställningar för ett specifikt team

Anger aviseringsinställningar för ett specifikt team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som inställningarna ska anges för.

escEnabled
escEnabled boolean
escMode
escMode integer

  • 0 = Chef
  • 1 = Team
escRefId
escRefId string
filterAction
filterAction integer

  • 0 = Utelämna
  • 1 = Dölj
  • 2 = Stäng av
filterMode
filterMode integer

  • 0 = Av
  • 1 = WhiteListAllCategories
kanal
channel integer

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS
delay
delay integer
enabled
enabled boolean
optOut
optOut integer

  • 0 = Inga
  • 1 = Inaktiverad
  • 2 = Personlig
overrideNotificationProfiles
overrideNotificationProfiles boolean
persNotInterval
persNotInterval integer
persNotMode
persNotMode integer

  • 0 = Av
  • 1 = Sammanfattning
responseMode
responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
responseTime integer

Returer

Bekräfta en avisering

Bekräfta en avisering.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

Id för att bekräfta en avisering.

descr
descr string
uid
uid True string

Returer

Bekräftar alla synliga aviseringar

Den här metoden bekräftar alla ohanterade aviseringar som teamet för närvarande har av en specifik användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId string

Användar-ID för den användare som ska användas för att bekräfta larmen.

categoryIds
categoryIds array of string
maxDate
maxDate date-time
minDate
minDate date-time
omfattning
scope integer

  • 0 = Standard
  • 1 = AllTeams
  • 2 = SpecificTeams
teamIds
teamIds array of string

Bjud in användare till ett team

Bjud in användare till ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
inviterId
inviterId string
Mejladress
email string
role-id
roleId string
teamId
teamId True string

Returer

Dra tillbaka stängning av flera aviseringar

Den här metoden försöker ångra flera aviseringsstängningar. Åtgärden hanteras i bakgrunden.

Parametrar

Name Nyckel Obligatorisk Typ Description
alertIds
alertIds True array of string
descr
descr string
uid
uid True string

Eskalera en avisering manuellt till ett team

Eskalera en avisering manuellt till ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

Aviserings-ID för aviseringar som du vill eskalera.

targetTeamId
targetTeamId string
userId
userId string

Returer

response
string

Få aviseringar

Få meddelanden om alla användare via aviserings-ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

ID för den begärda aviseringen.

Returer

Få information om en avisering

Få information om en avisering.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

Avisering som du vill få.

Användar-ID
userId string

Användar-ID för användare där api:et beter sig anropas. Den används i filtreringssyfte när det gäller aviseringen.

Returer

Få semester för teamet

Få semester för teamet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som du vill få semester från

Returer

Hämta alla användare

Returnerar en lista över användarobjekt med information, till exempel deras e-postadress och tjänstinformation. Endast användare som du har åtkomst till returneras.

Returer

Hämta alla användare av angivna team

Hämta alla användare av angivna team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Team-ID:t
teamId array

Team-ID:t som ska begäras. Om det är tomt får du alla användare i alla team som du har åtkomst till.

Returer

Hämta alla aviseringsmönster från teamet

Hämta alla aviseringsmönster från teamet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som du vill komma åt

Returer

Hämta alla kategorier

Hämta alla kategorier.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId array

Team-ID.

Returer

Hämta alla kategorier

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorierna tillhör

Returer

Hämta alla pratbubblans mallar för din prenumeration

Hämta alla pratbubblans mallar för din prenumeration.

Returer

Hämta alla team som användaren är medlem i

Returnerar en lista över teamobjekt med information, till exempel deras namn. Endast team som användaren är medlem i returneras.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
userId True string

Team-ID.

Returer

Hämta alla tillgängliga definitioner

Hämta alla tillgängliga definitioner.

Parametrar

Name Nyckel Obligatorisk Typ Description
Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Hämta användare efter ID

Returnerar ett användarobjekt med information som hans e-postadress och tjänstinformation.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Identifierare för användaren som ska hämtas. Använd "Jag" för att få information om den inloggade användaren. Detta är inte möjligt med en API-nyckel. Kan också vara en e-postadress till en användare i teamet eller det unika ID:t för ett enligt användarobjekt."

Returer

Hämta avisering

Hämtar en avisering via ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

ID för den begärda aviseringen.

Användar-ID
userId string

Användar-ID.

Returer

Hämta aviseringsrapport

Returnerar information om den inträffade aviseringsvolymen under olika tidsperioder samt information om svarsbeteendet (mängden bekräftade och ohanterade aviseringar) för gruppmedlemmarna.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId string

Användar-ID för den användare som du vill ha en rapport för.

Team-ID:t
teamId array

Team-ID:t för de team som du vill ha en rapport för. Om du inte anger ett team-ID får du alla resurser för alla team som du har åtkomst till.

Returer

Hämta en definition

Hämta en definition.

Parametrar

Name Nyckel Obligatorisk Typ Description
Definitions-ID
definitionId True string

Definitions-ID

Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Hämta en prenumerations aktuella förbetalda inställningar

Hämta en prenumerations aktuella förbetalda inställningar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen

Returer

Hämta en prenumerations aktuella förbetalda saldo

Hämta en prenumerations aktuella förbetalda saldo.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen

Returer

Hämta en prenumerations förbetalda transaktioner

Hämta en prenumerations förbetalda transaktioner.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen för att hämta transaktioner för

Returer

Hämta en specifik kategori

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

Kategori-ID
categoryId True string

ID för kategorin som ska hämtas

Returer

Hämta gruppmedlemskap efter team

Få teammedlemskap per team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som du vill komma åt.

Returer

Hämta händelsekälla efter ID

Hämta händelsekälla efter ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelsekällans ID
eventSourceId True string

ID för händelsekällan.

Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Hämta händelsekällor från ett eller flera team

Hämta händelsekällor från ett eller flera team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Team-ID:t
teamId array

Team-ID:er för att hämta händelsekällorna från. Om du inte lägger till något team-ID får du händelsekällor som du har åtkomst till från din prenumeration.

Inkludera internt
includeInternal boolean

Om den sanna interna händelsekällans typ (System, Manual, API) inkluderas i resultatet.

Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Hämta händelseparametrar

Hämta parametrar för en händelse efter ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelse-ID
eventId True string

Händelse-ID för den begärda aviseringen.

Returer

Hämta information för alla team i prenumerationen

Hämta information för alla team i prenumerationen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen som ska uppdateras

Returer

Hämta information om alla team

Få information om alla team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Team-ID:t
teamId array

Team-ID:t

Returer

Hämta information om alla tillgängliga och hanterade prenumerationer

Hämta information om alla tillgängliga/hanterade prenumerationer.

Returer

Hämta information om bifogade filer för en avisering

Hämta bifogade filer för en avisering via ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

ID för den begärda aviseringen.

Returer

Hämta information om en händelse

Få information om en händelse.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelse-ID
eventId True string

Händelse-ID för den händelse som du vill få

Returer

Hämta information om en specifik prenumeration

Hämta information om en specifik prenumeration.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för den prenumeration som ska hämtas.

Returer

Hämta information om nedladdningsbara aviseringsrapporter

Hämta information om nedladdningsbara aviseringsrapporter.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för team som du vill ladda ned rapporter från.

Returer

Hämta information om tjänstassistenten för team

Få information om tjänstassistenten för team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Team-ID:t
teamId array

ID:t för teamen att hämta sammanfattningarna för.

De två senaste uppgifterna
lastTwoDuties boolean

Bestäm om du vill ha alla uppgifter eller bara de två sista.

Returer

Hämta inställningar för teamtjänst för flera team

Hämta inställningar för teamtjänst för flera team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Team-ID:t
teamId array

Team-ID:t.

Returer

Hämta kategoriprenumerationer

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

Kategori-ID
categoryId True string

Kategori att hämta prenumerationer för

Returer

Hämta meddelandeprofiler för användare

Hämta meddelandeprofiler för användaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för den användare som du vill hämta aviseringsprofilerna från.

Returer

Hämta mått för alla kategorier

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorierna tillhör

Returer

Hämta mått för en specifik kategori

Exempelbegäran:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

Kategori-ID
categoryId True string

ID för kategorin som ska hämtas

Returer

Hämta offentlig information om alla team i en prenumeration

Få offentlig information om alla team i en prenumeration.

Returer

Hämta personlig användarbild

Hämta en personlig användarbild.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID."

Bildhöjd
height integer

Bildhöjd."

Bildbredd
width integer

Bildbredd."

Returer

Body
UserImage

Hämta prenumerationens aktuella förbetalda inställningar

Hämta prenumerationens aktuella förbetalda inställningar.

Returer

Hämta prenumerationens aktuella förbetalda saldo

Hämta prenumerationens aktuella förbetalda saldo.

Returer

Hämta prenumerationens förbetalda transaktioner

Hämta prenumerationens förbetalda transaktioner.

Returer

Hämta sekretessinställningar för team för ett team

Hämta sekretessinställningar för team för ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team

Returer

Hämta teammedlemskap från en användare

Hämta teammedlemskap från en användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID som du vill komma åt.

Returer

Hämta tidslinjeposter för aviseringar

Hämta tidslinjeposter för aviseringar med ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

ID för den begärda aviseringen.

Användar-ID
userId string

Användar-ID.

Returer

Name Sökväg Typ Description
array of

Hämta tjänststatus efter användar-ID

Returnerar ett objekt med tullinformation.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Identifierare för användaren som ska hämtas. Använd "Jag" för att få information om den inloggade användaren. Detta är inte möjligt med en API-nyckel. Kan också vara en e-postadress till en användare i teamet eller det unika ID:t för ett enligt användarobjekt."

Teamets ID
teamId array

Team-ID."

Returer

Hämta Webhook efter ID

Returnerar information om webhooken som anges av det skickade ID:t.

Parametrar

Name Nyckel Obligatorisk Typ Description
Utgående Webhook-ID
webhookId True string

ID för den utgående webhooken som ska hämtas.

Returer

Hämta Webhooks

Returnerar en samling definierade utgående webhooks i systemet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId string

Team-ID.

Returer

Hämta översiktshändelse

Hämta översiktshändelsen efter ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelse-ID
eventId True string

Id för händelse att hämta.

Returer

Hämta översiktshändelsen sidad

Hämta översiktshändelsen. Om det finns fler resultat får du också en fortsättningstoken som du kan lägga till i händelsefiltret.

Parametrar

Name Nyckel Obligatorisk Typ Description
Limit
maxResults integer

Definierar gränsen för hämtad aviseringsinformation per begäran. 1 till 100 tillåts per begäran. Antalet aviseringar kan vara mindre om de filtreras men minst 1.

nextPartitionKey
nextPartitionKey string
nextRowKey
nextRowKey string
nextTableName
nextTableName string
eventSourceId
eventSourceId string
eventStatusCode
eventStatusCode integer

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel
maxCreationDate
maxCreationDate date-time
minCreationDate
minCreationDate date-time
modifiedSince
modifiedSince date-time
teamid
teamid string
textToSearch
textToSearch string

Returer

Hämtar aviseringsinställningar för ett specifikt team

Hämtar aviseringsinställningar för ett specifikt team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId array

ID för teamet.

Returer

Hämtar aviseringsinställningar för ett specifikt team

Hämtar aviseringsinställningar för ett specifikt team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som inställningarna ska hämtas för.

Returer

Hämtar bild av ett angivet team

Hämtar bild av ett angivet team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID:t för det team som du vill hämta avbildningen från.

Bildhöjd
height integer

Valfri parameter som definierar önskad höjd för den bild som hämtas.

Bildbredd
width integer

Valfri parameter som definierar önskad bredd för den bild som hämtas.

Returer

Hämtar en angiven bifogad fil för en angiven avisering

Hämtar en angiven bifogad fil för en angiven avisering.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

ID för aviseringen som innehåller den önskade bifogade filen.

ID för bifogad fil
attachmentId True string

ID för den bifogade filen som du vill hämta.

Bildbredd
width integer

Valfri parameter som definierar önskad bredd för den bild som hämtas.

Bildhöjd
height integer

Valfri parameter som definierar önskad höjd för den bild som hämtas.

Scale
scale boolean

Valfri parameter som definierar om den vill skala den hämtade avbildningen. Standardvärdet är true.

Returer

response
binary

Hämtar en prenumerations användarlicenser

Hämtar en prenumerations användarlicenser.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen

Returer

Hämtar en prenumerations röstnummerlicenser

Hämtar en prenumerations röstnummerlicenser.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen

Returer

Hämtar händelsekällor för ett specifikt team

Hämtar händelsekällor för ett specifikt team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som källorna ska hämtas för.

Returer

Hämtar information om ett specifikt team

Hämtar information om ett specifikt team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som ska hämtas.

Returer

Body
TeamInfo

Hämtar installationsframställningen för en specifik användare

Hämtar installationsframställningen för en viss användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för användaren som förloppet ska hämtas för.

Returer

Hämtar installationsframställningen för ett specifikt team

Hämtar installationsframställningen för ett specifikt team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som förloppet ska hämtas för.

Returer

Hämtar namnen på alla aviseringskategoribilder

Hämtar namnen på alla aviseringskategoribilder. Du kan hämta bilden genom att gå till account.signl4.com/images/alerts/categoryImageName.svg.

Returer

Name Sökväg Typ Description
array of string

Hämtar sidiga aviseringar

Hämtar sidiga aviseringar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId string

Användar-ID för den användare som du vill få aviseringar för.

Aviseringsgräns
maxResults integer

Definierar gränsen för hämtad aviseringsinformation per begäran. 1 till 100 tillåts per begäran. Antalet aviseringar kan vara mindre om de filtreras men minst 1.

afterId
afterId string
alertIds
alertIds array of string
alertStatusCodes
alertStatusCodes integer

  • 0 = Inga
  • 1 = Öppna
  • 2 = Bekräftad
  • 4 = Stängd
  • 8 = NoReply
  • 16 = Misslyckades
  • 32 = Fel
categoryIds
categoryIds array of string
nextPartitionKey
nextPartitionKey string
nextRowKey
nextRowKey string
nextTableName
nextTableName string
externId
externalId string
maxSkapad
maxCreated date-time
minSkapad
minCreated date-time
modifiedSince
modifiedSince date-time
showPersonalHiddenCategories
showPersonalHiddenCategories boolean
teamIds
teamIds array of string
textToSearch
textToSearch string

Returer

Inaktiverar en viss skriptinstans

Inaktiverar en viss skriptinstans.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skriptinstans-ID
instanceId True string

ID för den instans som ska inaktiveras.

Returer

Kommentera avisering

Kommenterar en avisering med angiven anteckningsinformation.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

ID för aviseringen för att kommentera.

texten
text string
type
type integer

  • 0 = Inga
  • 1 = Text
  • 2 = Bild
userId
userId string

Returer

Kontrollerar om en användare har den angivna behörigheten

Kontrollerar om en användare har den angivna behörigheten.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för användaren att kontrollera behörigheter för.

permissions
permissions array of string
teamIds
teamIds array of string

Returer

Kopiera helgdagar från ett team till ett annat

Kopiera helgdagar från ett team till ett annat.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som du vill kopiera helgdagar till

År
year True integer

År som du vill kopiera från

Teamets ID
sourceTeamId True string

Team-ID för team som du vill kopiera helgdagar från

Returer

Ladda ned tjänstrapport med ett specifikt fileName

Ladda ned tjänstrapport med ett specifikt fileName.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som du vill ladda ned tjänstrapporten för.

Filnamn
fileName True string

Filnamn för csv som ska laddas ned.

Returer

response
binary

Laddade upp en profilbild för ett angivet team

En profilbild har laddats upp för ett angivet team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID där du ställer in teambilden.

Lägga till användare i ett team

Lägg till användare i ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Id för teamet som användaren ska bjudas in till.

Användar-ID
userId True string

ID för användare som du vill lägga till i ett team.

role-id
roleId string
setUserOnDuty
setUserOnDuty boolean

Returer

Möjlighet att aktivera en webHook

Möjlighet att aktivera en webHook.

Parametrar

Name Nyckel Obligatorisk Typ Description
Webhook-ID
webhookId True string

Webhook-ID för webhook som ska inaktiveras.

Returer

Möjlighet att inaktivera en webHook

Möjlighet att inaktivera en webHook.

Parametrar

Name Nyckel Obligatorisk Typ Description
Webhook-ID
webhookId True string

Webhook-ID för webhook som ska vara aktiverat.

Returer

Returnerar all information om en viss skriptinstans

Hämtar skriptinstansen som anges av det skickade instans-ID:t.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skriptinstans-ID
instanceId True string

Instans-ID för skriptinstans som ska returneras.

Returer

Returnerar alla inventeringsskript

Returnerar alla inventeringsskript.

Parametrar

Name Nyckel Obligatorisk Typ Description
Language
language string

Language

Returer

Returnerar alla skriptinstanser av SIGNL4-teamet

Returnerar alla skriptinstanser i prenumerationen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Team-ID:t
teamId array

Team-ID:t.

Ändrad sedan
modifiedSince date-time

Har ändrats sedan dess.

Returer

Returnerar alla tillgängliga inventeringsskript

Returnerar alla tillgängliga inventeringsskript som kan läggas till i en SIGNL4-prenumeration.

Returer

Returnerar aviseringsrapport

Returnerar aviseringsrapport.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som du vill hämta information om tjänstrapportfilen för.

Filnamn
fileName True string

Filnamn för den fil som du vill ladda ned.

Returer

response
binary

Returnerar en fjärråtgärd

Exempelbegäran:

GET /RemoteActions/{actionId}

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
actionId True string

ID:t för åtgärden som ska returneras

Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Returnerar ett fjärrjobb från journalen

Exempelbegäran:

GET /remoteActions/journal/{jobId}

Parametrar

Name Nyckel Obligatorisk Typ Description
Jobb-ID
jobId True string

ID:t för jobbet som ska returneras

Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Returnerar ett inventeringsskript med dess ID

Hämtar skriptet som anges av det skickade skript-ID:t.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skript-ID
scriptId True string

ID:t för skriptet som ska returneras.

Language
language string

Language

Returer

Returnerar fjärrjobb som är sidiga från journalen

Exempelbegäran:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Maximalt resultat
maxResults integer

Maximalt resultat

Language
language integer

  • 0 = EN
  • 1 = DE
actionId
actionId string
continuationToken
continuationToken string
maxCreationDate
maxCreationDate date-time
minCreationDate
minCreationDate date-time
modifiedSince
modifiedSince date-time
statuskoder
statusCodes integer

  • 0 = Inga
  • 1 = Väntar
  • 2 = Klar
  • 4 = Körs
  • 8 = Körd
  • 16 = Fel

Returer

Returnerar fjärråtgärder

Exempelbegäran:

GET /RemoteActions?externalId=12345

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId string

Teamets ID

Externt ID
externalId string

Valfritt filter för externt ID

Typ
type integer

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook
Körtjänst
executorService string

Körtjänst

Language
language integer

  • 0 = EN
  • 1 = DE

Returer

Returnerar funktionerna i en angiven prenumeration

Returnerar funktionerna i en angiven prenumeration.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen som funktionerna måste hämtas från.

Returer

Returnerar information om alla planerade scheman

Returnerar information om alla planerade scheman.

Parametrar

Name Nyckel Obligatorisk Typ Description
limit
limit integer
minDate
minDate date-time
teamIds
teamIds array of string
userId
userId string

Returer

Returnerar information om tullschemat med angivet ID

Returnerar information om tullschemat med det angivna ID:t.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som plikten tillhör

Tjänstschema-ID
scheduleId True string

Id för det begärda tullschemat.

Returer

Returnerar prenumerationens kanalprisinformation

Returnerar prenumerationens kanalprisinformation.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för den prenumeration som måste hämtas.

Returer

Skapa eller uppdatera angivet tullschema

Skapa/uppdatera angivet tjänstschema.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Id för teamet som uppgiften är att tilldelas till.

ände
end date-time
Id-nummer
id string
options
options integer
start
start date-time
userId
userId string

Returer

Skapa en ny fjärråtgärd

Exempelbegäran:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Language
language integer

  • 0 = EN
  • 1 = DE
name
name True string
värde
value string
canEdit
canEdit boolean
canExecute
canExecute boolean
teamId
teamId string
definitionId
definitionId string
beskrivning
description string
enabled
enabled boolean
name
name string
teamId
teamId string

Returer

Skapa en ny kategori

Exempelbegäran:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

enabled
enabled boolean
Id-nummer
id string
name
name string
type
type True integer

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats
värde
value string
color
color True string
Id-nummer
id string
name
name string
type
type True integer

  • 0 = Parameter
  • 1 = Hyperlänk
värde
value string
Id-nummer
id string
imageName (på engelska)
imageName True string
isDefault
isDefault boolean
keywordMatching
keywordMatching True integer

  • 0 = Alla
  • 1 = Alla
nyckelord
keywords True array of string
keywordsExcluded
keywordsExcluded array of string
name
name True string
options
options integer

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
order integer
teamId
teamId string

Returer

Skapa ett nytt aviseringsmönster

Skapa ett nytt aviseringsmönster.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som du vill skapa mönstret för

categories
categories array of string
enabled
enabled boolean
mode
mode integer

  • 0 = Chef
  • 1 = Team
referenceId
referenceId string
Id-nummer
id string
name
name string
kanal
channel integer

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS
delayInMinutes (fördröjning) i minuter
delayInMinutes integer
enabled
enabled boolean
overrideEscalationSettings
overrideEscalationSettings boolean
overrideNotificationProfiles
overrideNotificationProfiles boolean
overrideResponseSettings
overrideResponseSettings boolean
responseMode
responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
responseTime integer
suppressSignl
suppressSignl boolean
timme
hour integer
minutes
minutes integer
vardag
weekday integer

  • 0 = Helgdag
  • 1 = måndag
  • 2 = tisdag
  • 3 = onsdag
  • 4 = torsdag
  • 5 = fredag
  • 6 = lördag
  • 7 = söndag
Id-nummer
id string

Returer

Skapa ett nytt fjärrjobb

Exempelbegäran:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
actionId True string

Åtgärds-ID

name
name True string
värde
value string
alertId
alertId string
options
options integer

  • 0 = Inga
remoteActionPin
remoteActionPin string

Returer

Skapa händelsekälla

Skapa händelsekälla.

Parametrar

Name Nyckel Obligatorisk Typ Description
beskrivning
description string
funktionshindrad
disabled boolean
Språk
language integer

  • 0 = EN
  • 1 = DE
name
name string
sharedTeams
sharedTeams array of string
teamId
teamId string
type
type integer

  • 0 = Inga
  • 1 = E-post
  • 2 = Webhook

Returer

Skapa nya mallar för pratbubblan för din prenumeration

Skapa nya pratbubblan mallar för din prenumeration.

Parametrar

Name Nyckel Obligatorisk Typ Description
categoryId
categoryId string
externId
externalId string
Id-nummer
id string
location
location string
name
name string
ämne
subject string
targetAllTeams
targetAllTeams boolean
targetTeamId
targetTeamId string
texten
text string
workflowType
workflowType integer

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

Returer

Skapa webhook

Skapar en ny utgående webhook som meddelas när vissa händelser inträffar.

Parametrar

Name Nyckel Obligatorisk Typ Description
beskrivning
description string
extUrl
extUrl True string
name
name True string
teamId
teamId string

Returer

response
string

Skapar en ny skriptinstans i SIGNL4-teamet

Skapar en ny skriptinstans av skriptet som anges i begärandetexten.

Parametrar

Name Nyckel Obligatorisk Typ Description
config
config
customScriptDescription
customScriptDescription string
customScriptName
customScriptName string
enabled
enabled boolean
instanceId
instanceId string
scriptId
scriptId string
scriptName
scriptName string
sharedTeams
sharedTeams array of string
teamId
teamId string

Returer

Skicka händelse

Skicka händelse.

Parametrar

Name Nyckel Obligatorisk Typ Description
Grupphemlighet
teamSecret True string

Teamhemlighet.

Titel
Title True string
Message
Message True string
X-S4-Service
X-S4-Service string

X-S4-Service: : Tilldelar signl till kategorin tjänst/system med det angivna namnet.

X-S4-Location
X-S4-Location string

X-S4-Plats: Överföra platsinformation (latitud, longitud) med din händelse och visa en karta i mobilappen.

X-S4-AlertingScenario
X-S4-AlertingScenario string

X-S4-AlertingScenario: Om den här händelsen utlöser en Signl kan du styra hur SIGNL4 meddelar teamet. Värden som stöds är: single_ack, multi_ack, nödsituationer.

X-S4-ExternalID
X-S4-ExternalID string

X-S4-ExternalID: Om händelsen kommer från en post i ett tredjepartssystem använder du den här parametern för att skicka postens unika ID. Det ID:t kommer att kommuniceras i utgående webhook-meddelanden från SIGNL4, vilket är bra för korrelation/synkronisering av posten med Signl.

X-S4-Status
X-S4-Status string

X-S4-Status: Om du vill matcha en befintlig signl med ett externt ID (X-S4-ExternalID) kan du lägga till den här statusparametern. Den har tre möjliga värden: ny, bekräftad, löst.

X-S4-Filtering
X-S4-Filtering boolean

X-S4-filtrering: Ange ett booleskt värde för sant eller falskt för att tillämpa händelsefiltrering för den här händelsen eller inte. Om värdet är true utlöser händelsen bara ett meddelande till teamet, om den innehåller minst ett nyckelord från en av dina tjänster och systemkategorier (dvs. den är vitlistad).

Parameter för externt ID
ExtIdParam string

Parameter för externt ID.

Extern statusparameter
ExtStatusParam string

Extern statusparameter.

Ny status
NewStatus string

Ny status.

Matchad statusparameter
ResolvedStatus string

Matchad statusparameter.

Ack-status
AckStatus string

Ack Status.

Returer

Skickar e-post med inbjudan igen om det finns en inbjudan

Skickar e-post med inbjudan igen om det finns en inbjudan.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team med inbjuden användare.

inviterId
inviterId string
userMail
userMail True string

Returer

response
string

Skickar ett e-postmeddelande till en angiven användare

Skickar ett e-postmeddelande till en angiven användare som innehåller information om alla händelsekällor i användarens team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID: t.

Teamets ID
teamId string

Det team-ID som användaren ska hämta slutpunktsinformationen från.

Slå in användare

Den angivna användaren kommer att slås in i tjänst.

Parametrar

Name Nyckel Obligatorisk Typ Description
teamIds
teamIds array of string
userId
userId True string

Returer

Slå in användare som chef

Den angivna användaren kommer att bli instansad i tjänst som chef.

Parametrar

Name Nyckel Obligatorisk Typ Description
teamIds
teamIds array of string
userId
userId True string

Returer

Slå ut användaren

Den angivna användaren kommer att slås ut från tjänsten.

Parametrar

Name Nyckel Obligatorisk Typ Description
teamIds
teamIds array of string
userId
userId True string

Returer

Spara flera scheman

Spara flera scheman. Du kan åsidosätta befintliga scheman om du vill.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som ska anges

Åsidosätta
overrideExisting boolean

Åsidosätt eller klipp ut befintliga scheman om de är inställda på true.

ände
end date-time
Id-nummer
id string
options
options integer
start
start date-time
userId
userId string

Returer

Spara helgdagar för ett team

Spara semester för ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som du vill spara helgdagar för

År
year True integer

År som du vill spara helgdagar för

dag
day integer
månad
month integer

  • 0 = Ta bort
  • 1 = januari
  • 2 = februari
  • 3 = mars
  • 4 = april
  • 5 = maj
  • 6 = juni
  • 7 = juli
  • 8 = augusti
  • 9 = september
  • 10 = oktober
  • 11 = november
  • 12 = december

Returer

Spara upprepade helgdagar för ett team

Spara upprepade helgdagar för ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som du vill spara helgdagar för

dag
day integer
månad
month integer

  • 0 = Ta bort
  • 1 = januari
  • 2 = februari
  • 3 = mars
  • 4 = april
  • 5 = maj
  • 6 = juni
  • 7 = juli
  • 8 = augusti
  • 9 = september
  • 10 = oktober
  • 11 = november
  • 12 = december

Returer

Stäng alla bekräftade aviseringar

Den här metoden stänger alla bekräftade aviseringar som ditt team för närvarande har.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId string

Användar-ID för den användare som ska användas för att stänga larmen.

categoryIds
categoryIds array of string
maxDate
maxDate date-time
minDate
minDate date-time
omfattning
scope integer

  • 0 = Standard
  • 1 = AllTeams
  • 2 = SpecificTeams
teamIds
teamIds array of string

Stäng en avisering

Stäng en avisering.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

Id för att bekräfta en avisering.

descr
descr string
uid
uid True string

Returer

Stäng flera aviseringar

Den här metoden stänger alla aviseringar som tillhandahålls.

Parametrar

Name Nyckel Obligatorisk Typ Description
alertIds
alertIds True array of string
descr
descr string
uid
uid True string

Ta bort en befintlig kategori

Exempelbegäran:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

Kategori-ID
categoryId True string

ID för kategorin som ska tas bort

Ta bort en befintlig pratbubblansmall från din prenumeration

Ta bort den befintliga pratbubblan från din prenumeration.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mall-id
templateId True string

Mall-ID.

Ta bort en händelsedistribution

Ta bort en händelsedistribution.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelsekällans ID
distributionId True string

ID för händelsekälla

Ta bort en händelsekälla

Ta bort en händelsekälla.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelsekällans ID
eventSourceId True string

ID för händelsekälla

Ta bort en kontaktadress från en användare

Ta bort en kontaktadress från en användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID för användare att ta bort adress från

Adress-ID
addressId True string

ID för kontaktadress

Ta bort en personlig användarbild

Ta bort en personlig användarbild.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID eller mig

Ta bort en specifik tull

Ta bort en specifik plikt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som plikten tillhör.

Tjänstschema-ID
dutyId True string

ID för den skyldighet som ska tas bort.

Ta bort ett specifikt aviseringsmönster

Ta bort ett specifikt aviseringsmönster.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som du vill komma åt

Mönster-ID
patternId True string

Mönster-ID för mönster som du vill komma åt

Ta bort helgdagar

Ta bort helgdagar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som du vill ta bort helgdagar från

dag
day integer
månad
month integer

  • 0 = Ta bort
  • 1 = januari
  • 2 = februari
  • 3 = mars
  • 4 = april
  • 5 = maj
  • 6 = juni
  • 7 = juli
  • 8 = augusti
  • 9 = september
  • 10 = oktober
  • 11 = november
  • 12 = december
år
year integer

Ta bort telefonnummer för en användare

Ta bort en användares telefonnummer.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användarens ID

Ta bort tjänstscheman inom intervallet

Ta bort tjänstscheman inom intervallet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som du vill ta bort

från
from date-time
till
to date-time

Returer

Ta bort Webhook efter ID

Tar bort den angivna webhooken så att den inte längre meddelas.

Parametrar

Name Nyckel Obligatorisk Typ Description
Utgående Webhook-ID
webhookId True string

ID för den utgående webhooken som ska tas bort.

Tar bort aktuell gruppbild

Tar bort den aktuella gruppbilden.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som du vill ta bort teambilden från.

Tar bort användarkonto

Tar bort användarkontot.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för den användare som ska tas bort.

Tar bort en användare eller inbjudan från ett team

Tar bort en användare eller inbjudan från ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som användaren ska tas bort från

Användar-ID
userId True string

ID för den användare som ska tas bort

Användar-ID
requesterUserId string

Användar-ID för användaren som tar bort den andra användaren.

Tar bort en fjärråtgärd

Exempelbegäran:

DELETE /eaRemoteActions/{actionId}

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
actionId True string

ID:t för åtgärden som ska tas bort

Tar bort en skriptinstans

Hämtar skriptinstansen som anges av det skickade instans-ID:t.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skriptinstans-ID
instanceId True string

Instans-ID för skriptinstans som ska returneras.

Uppdatera användarens teammedlemskap

Uppdaterar användarens gruppmedlemskap. Du kan flytta användaren till ett annat team i prenumerationen och/eller ändra användarens roll.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team användaren som du vill uppdatera tillhör just nu.

Användar-ID
userId True string

Användar-ID för användare som du vill uppdatera.

Användar-ID
requesterUserId string

Användar-ID för användare som du vill ändra roll med. Detta måste anges när du använder en API-nyckel. Den här användaren måste ha rolladministratör (för att ange administratörsroll) eller gruppadministratör (för att ange rättigheter.

Ange användare i tjänst
setUserOnDuty boolean

Anger ny tjänststatus för användaren om användaren flyttas till ett annat team. Användaren är i tjänst som standard.

isValid
isValid boolean
role-id
roleId string
teamId
teamId string

Returer

Body
UserInfo

Uppdatera en befintlig kategori

Exempelbegäran:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

ID för teamet som kategorin tillhör

Kategori-ID
categoryId True string

Kategori-ID

enabled
enabled boolean
Id-nummer
id string
name
name string
type
type True integer

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats
värde
value string
color
color True string
Id-nummer
id string
name
name string
type
type True integer

  • 0 = Parameter
  • 1 = Hyperlänk
värde
value string
Id-nummer
id string
imageName (på engelska)
imageName True string
isDefault
isDefault boolean
keywordMatching
keywordMatching True integer

  • 0 = Alla
  • 1 = Alla
nyckelord
keywords True array of string
keywordsExcluded
keywordsExcluded array of string
name
name True string
options
options integer

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
order integer
teamId
teamId string

Returer

Uppdatera en befintlig pratbubblans mall för din prenumeration

Uppdatera den befintliga pratbubblan för din prenumeration.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mall-id
templateId True string

ID för mall som du vill uppdatera

categoryId
categoryId string
externId
externalId string
Id-nummer
id string
location
location string
name
name string
ämne
subject string
targetAllTeams
targetAllTeams boolean
targetTeamId
targetTeamId string
texten
text string
workflowType
workflowType integer

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

Returer

Uppdatera en händelsekälla

Uppdatera en händelsekälla.

Parametrar

Name Nyckel Obligatorisk Typ Description
Händelsekällans ID
eventSourceId True string

ID för händelsekälla

beskrivning
description string
funktionshindrad
disabled boolean
name
name string
teamId
teamId string

Returer

Uppdatera en prenumerations aktuella förbetalda inställningar

Uppdatera en prenumerations aktuella förbetalda inställningar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen

topUpAmount
topUpAmount integer
topUpEnabled
topUpEnabled boolean
topUpLimit
topUpLimit integer

Returer

Uppdatera ett befintligt aviseringsmönster

Uppdatera ett befintligt aviseringsmönster.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID som du vill skapa mönstret för

Mönster-ID
patternId True string

Mönster-ID för mönster som ska uppdateras

categories
categories array of string
enabled
enabled boolean
mode
mode integer

  • 0 = Chef
  • 1 = Team
referenceId
referenceId string
Id-nummer
id string
name
name string
kanal
channel integer

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS
delayInMinutes (fördröjning) i minuter
delayInMinutes integer
enabled
enabled boolean
overrideEscalationSettings
overrideEscalationSettings boolean
overrideNotificationProfiles
overrideNotificationProfiles boolean
overrideResponseSettings
overrideResponseSettings boolean
responseMode
responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
responseTime integer
suppressSignl
suppressSignl boolean
timme
hour integer
minutes
minutes integer
vardag
weekday integer

  • 0 = Helgdag
  • 1 = måndag
  • 2 = tisdag
  • 3 = onsdag
  • 4 = torsdag
  • 5 = fredag
  • 6 = lördag
  • 7 = söndag
Id-nummer
id string

Returer

Uppdatera prenumerationens aktuella förbetalda inställningar

Uppdatera prenumerationens aktuella förbetalda inställningar.

Parametrar

Name Nyckel Obligatorisk Typ Description
topUpAmount
topUpAmount integer
topUpEnabled
topUpEnabled boolean
topUpLimit
topUpLimit integer

Returer

Uppdatera sekretessinställningar för ett team

Uppdatera sekretessinställningar för ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team

hideContactAddresses
hideContactAddresses boolean
hideDutyData
hideDutyData boolean
hideForEscalation
hideForEscalation boolean

Returer

Uppdatera språkinformation (t.ex. språk, tidszon) för användare

Uppdatera språkinformation (t.ex. språk, tidszon) för användaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID, e-post eller "mig" för användare som du vill uppdatera

Språk
language string
timeZone
timeZone string

Returer

Uppdatera Webhook efter ID

Uppdaterar den angivna webhooken.

Parametrar

Name Nyckel Obligatorisk Typ Description
Utgående Webhook-ID
webhookId True string

Id för den utgående webhooken som ska uppdateras.

beskrivning
description string
extUrl
extUrl True string
name
name True string
teamId
teamId string

Returer

Uppdaterar anpassade data för en viss skriptinstans som innehåller dess visningsnamn

Uppdaterar den angivna skriptinstansen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skriptinstans-ID
instanceId True string

Instans-ID för skriptet som ska uppdateras.

customScriptDescription
customScriptDescription string
customScriptName
customScriptName string
instanceId
instanceId string
scriptName
scriptName string

Returer

Uppdaterar användarprofilen för en användare

Uppdaterar användarens användarprofil.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

ID för användare som ska uppdateras.

name
name string
timeZone
timeZone string

Returer

Body
UserInfo

Uppdaterar en fjärråtgärd

Exempelbegäran:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
actionId True string

ID för fjärråtgärd som ska uppdateras

Åtgärds-ID
language integer

  • 0 = EN
  • 1 = DE
name
name True string
värde
value string
canEdit
canEdit boolean
canExecute
canExecute boolean
teamId
teamId string
definitionId
definitionId string
beskrivning
description string
enabled
enabled boolean
name
name string
teamId
teamId string

Returer

Uppdaterar en prenumerationsprofil

Uppdaterar en prenumerationsprofil.

Parametrar

Name Nyckel Obligatorisk Typ Description
Prenumerations-ID
subscriptionId True string

ID för prenumerationen som ska uppdateras

name
name string

Returer

Uppdaterar en viss skriptinstans

Uppdaterar den angivna skriptinstansen, som vanligtvis används för att uppdatera konfigurationen av ett skript.

Parametrar

Name Nyckel Obligatorisk Typ Description
Skriptinstans-ID
instanceId True string

Instans-ID för skriptet som ska uppdateras.

config
config
customScriptDescription
customScriptDescription string
customScriptName
customScriptName string
enabled
enabled boolean
teamId
teamId string

Returer

Uppdaterar lösenordet för en användare

Uppdaterar lösenordet för en användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID för användare vars lösenord ska ändras.

currentPassword
currentPassword string
newPassword
newPassword string

Uppdaterar teamprofilen för ett team

Uppdaterar teamprofilen för ett team.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för team som ska uppdateras.

name
name string

Returer

Body
TeamInfo

Utlösaravisering

Utlöser en ny avisering för ditt team. Alla teammedlemmar i tjänst får aviseringsaviseringar.

Parametrar

Name Nyckel Obligatorisk Typ Description
name
name string
order
order integer
type
type integer

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html
värde
value string
innehåll
content string
innehållstyp
contentType string
encoding
encoding integer

  • 0 = Inga
  • 1 = Base64
Id-nummer
id string
name
name string
kategori
category string
externId
externalId string
flags
flags integer

  • 0 = Inga
  • 1 = HasAttachments
  • 2 = HasAnnotationer
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
severity
severity integer

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk
teamId
teamId True string
texten
text True string
title
title True string

Returer

Verifiera ett mönsters tidsintervall

Verifiera ett tidsintervall för ett mönster mot alla befintliga tidsintervall för andra mönster.

Parametrar

Name Nyckel Obligatorisk Typ Description
Teamets ID
teamId True string

Team-ID för aviseringsmönster

Mönster-ID
patternId string

Aviseringsmönster-ID för mönster som du vill spara tidsintervall för. Kan vara null

Kategori-ID:t
categoryIds array

Kategori-ID:t för det mönster som du vill verifiera. Kan vara null.

timme
hour integer
minutes
minutes integer
vardag
weekday integer

  • 0 = Helgdag
  • 1 = måndag
  • 2 = tisdag
  • 3 = onsdag
  • 4 = torsdag
  • 5 = fredag
  • 6 = lördag
  • 7 = söndag
Id-nummer
id string

Returer

Verifierar ett tidigare skapat telefonnummer för en användare

Verifierar ett tidigare skapat telefonnummer för en användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användar-ID för användare som du vill verifiera tidigare skapat telefonnummer

telefonnummer
phoneNumber string
validationCode
validationCode string

Ångra bekräftelsen av en avisering

Den här metoden försöker ångra en aviseringsigenkänning.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

Aviserings-ID.

descr
descr string
uid
uid True string

Returer

Ångra flera bekräftelser i kön

Den här metoden försöker ångra bekräftelsen av flera aviseringar via en kö. Åtgärden hanteras i bakgrunden.

Parametrar

Name Nyckel Obligatorisk Typ Description
alertIds
alertIds True array of string
descr
descr string
uid
uid True string

Ångra stängningen av en avisering

Den här metoden försöker ångra en aviseringsstängning.

Parametrar

Name Nyckel Obligatorisk Typ Description
Aviserings-ID
alertId True string

Aviserings-ID.

descr
descr string
uid
uid True string

Returer

Överförde en profilbild för en angiven användare

En profilbild har laddats upp för en angiven användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
userId True string

Användarens ID.

Definitioner

AlertAuditReportFileInfo

Name Sökväg Typ Description
fileName
fileName string
fileSizeInBytes
fileSizeInBytes integer
lastRecord
lastRecord date-time
sistUppdaterad
lastUpdated date-time
månad
month integer
år
year integer

AlertEscalationModes

  • 0 = Chef
  • 1 = Team

  • 0 = Chef
  • 1 = Team

AlertFilterActions

  • 0 = Utelämna
  • 1 = Dölj
  • 2 = Stäng av

  • 0 = Utelämna
  • 1 = Dölj
  • 2 = Stäng av

AlertFilterModes

  • 0 = Av
  • 1 = WhiteListAllCategories

  • 0 = Av
  • 1 = WhiteListAllCategories

AlertNotificationInfo

Name Sökväg Typ Description
address
address string
deviceName
deviceName string
lastUpdate
lastUpdate date-time
messageStatus
messageStatus AlertNotificationInfoMessageStatus

  • 0 = Inga
  • 1 = Avvisad
  • 2 = Misslyckades
  • 3 = I kö
  • 4 = Överförd
  • 5 = Buffrad
  • 6 = Levereras
  • 7 = Avbruten
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 10 = Fördröjd
messageStatusErrorCode
messageStatusErrorCode integer
notificationChannelType
notificationChannelType AlertNotificationInfoChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS
userId
userId string
userStatus
userStatus AlertNotificationInfoUserStatus

  • 0 = Inga
  • 1 = MeddelandeSkapat
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

AlertNotificationInfoChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS

AlertNotificationInfoMessageStatus

  • 0 = Inga
  • 1 = Avvisad
  • 2 = Misslyckades
  • 3 = I kö
  • 4 = Överförd
  • 5 = Buffrad
  • 6 = Levereras
  • 7 = Avbruten
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 10 = Fördröjd

  • 0 = Inga
  • 1 = Avvisad
  • 2 = Misslyckades
  • 3 = I kö
  • 4 = Överförd
  • 5 = Buffrad
  • 6 = Levereras
  • 7 = Avbruten
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 10 = Fördröjd

AlertNotificationInfoUserStatus

  • 0 = Inga
  • 1 = MeddelandeSkapat
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

  • 0 = Inga
  • 1 = MeddelandeSkapat
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge

AlertSettings

Name Sökväg Typ Description
escEnabled
escEnabled boolean
escMode
escMode AlertEscalationModes

  • 0 = Chef
  • 1 = Team
escRefId
escRefId string
filterAction
filterAction AlertFilterActions

  • 0 = Utelämna
  • 1 = Dölj
  • 2 = Stäng av
filterMode
filterMode AlertFilterModes

  • 0 = Av
  • 1 = WhiteListAllCategories
notificationProfileOverrides
notificationProfileOverrides array of AlertSettingsNotificationProfile
optOut
optOut TeamCategoryOptOutModes

  • 0 = Inga
  • 1 = Inaktiverad
  • 2 = Personlig
overrideNotificationProfiles
overrideNotificationProfiles boolean
persNotInterval
persNotInterval integer
persNotMode
persNotMode PersistentNotificationModes

  • 0 = Av
  • 1 = Sammanfattning
responseMode
responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
responseTime integer

AlertSettingsChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS

AlertSettingsNotificationProfile

Name Sökväg Typ Description
kanal
channel AlertSettingsChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS
delay
delay integer
enabled
enabled boolean

CategoryAugmentation

Name Sökväg Typ Description
enabled
enabled boolean
Id-nummer
id string
name
name string
type
type CategoryAugmentationType

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats
värde
value string

CategoryAugmentationType

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats

CategoryEnrichment

Name Sökväg Typ Description
Id-nummer
id string
name
name string
type
type CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlänk
värde
value string

CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlänk

  • 0 = Parameter
  • 1 = Hyperlänk

CategoryInfo

Name Sökväg Typ Description
augmentations
augmentations array of CategoryAugmentation
color
color string
berikningar
enrichments array of CategoryEnrichment
Id-nummer
id string
imageName (på engelska)
imageName string
isDefault
isDefault boolean
keywordMatching
keywordMatching KeywordMatchingType

  • 0 = Alla
  • 1 = Alla
nyckelord
keywords array of string
keywordsExcluded
keywordsExcluded array of string
name
name string
options
options CategoryInfoOptions

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
order integer
teamId
teamId string

CategoryInfoOptions

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

CategoryMetrics

Name Sökväg Typ Description
categoryId
categoryId string
last24h
last24h integer
lastAlert
lastAlert date-time
subscriberCount
subscriberCount integer

CategorySubscriptionInfo

Name Sökväg Typ Description
status
status CategorySubscriptionStatus

  • 0 = Prenumererad
  • 1 = Avstängt
  • 2 = Dold
userId
userId string

CategorySubscriptionStatus

  • 0 = Prenumererad
  • 1 = Avstängt
  • 2 = Dold

  • 0 = Prenumererad
  • 1 = Avstängt
  • 2 = Dold

ChannelPriceInfo

Name Sökväg Typ Description
sms
sms integer
voicePerMinute
voicePerMinute integer

DutySummaryInfo

Name Sökväg Typ Description
dutyEnd
dutyEnd date-time
dutyId
dutyId string
dutyStart
dutyStart date-time

EventParameterInfo

Name Sökväg Typ Description
name
name string
order
order integer
type
type EventParameterTypes

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html
värde
value string

EventParameterTypes

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html

EventSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk

EventSourceEndpointInfo

Name Sökväg Typ Description
address
address string
beskrivning
description string
funktionshindrad
disabled boolean
groupId
groupId string
Id-nummer
id string
lastEvent
lastEvent date-time
name
name string
Subtyp
subType string
subscriptionId
subscriptionId string
teamId
teamId string
type
type EventSourceTypes

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API

EventSourceTypes

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API

EventStatusCodes

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel

InventoryScriptInfo

Name Sökväg Typ Description
config
config
data
data ScriptDescriptionData
händelsemönster
eventPattern
localizationDetails
localizationDetails array of ScriptLocalizationDetail
scriptId
scriptId string
scriptName
scriptName string
synlighet
visibility string

KeywordMatchingType

  • 0 = Alla
  • 1 = Alla

  • 0 = Alla
  • 1 = Alla

LocationInfo

Name Sökväg Typ Description
latitude
latitude double
longitud
longitude double
tidsstämpel
timestamp date-time

MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Name Sökväg Typ Description
data
data array of EventSourceEndpointInfo
Felaktigheter
errors array of V2.EventSourceEndpointError

MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Name Sökväg Typ Description
data
data array of TeamDutySummaryInfo
Felaktigheter
errors array of V2.TeamDutySummaryError

MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Name Sökväg Typ Description
data
data array of UserDutyInfo
Felaktigheter
errors array of V2.DutyError

MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Name Sökväg Typ Description
data
data array of V2.AlertCountsDetails
Felaktigheter
errors array of V2.AlertReportError

MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

Name Sökväg Typ Description
data
data array of V2.AlertSettingsDetails
Felaktigheter
errors array of V2.AlertSettingsError

MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Name Sökväg Typ Description
data
data array of V2.CategoryDetails
Felaktigheter
errors array of V2.CategoryError

MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Name Sökväg Typ Description
data
data array of V2.TeamDutySettingsDetails
Felaktigheter
errors array of V2.TeamDutySettingsError

MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Name Sökväg Typ Description
data
data array of V2.TeamPermissions
Felaktigheter
errors array of V2.PermissionError

MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Name Sökväg Typ Description
data
data array of V2.UserDetails
Felaktigheter
errors array of V2.TeamUserError

MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Name Sökväg Typ Description
data
data array of V2.UserDutyDetails
Felaktigheter
errors array of V2.DutyChangeError

ÖversiktEvent

Name Sökväg Typ Description
acknowledgedAlerts
acknowledgedAlerts array of string
alertId
alertId string
categoryId
categoryId string
closedAlerts
closedAlerts array of string
skapandetid
creationTime date-time
eventSourceGroupId
eventSourceGroupId string
eventSourceId
eventSourceId string
eventSourceTeamId
eventSourceTeamId string
eventSourceType
eventSourceType EventSourceTypes

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API
eventStatus
eventStatus EventStatusCodes

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel
Id-nummer
id string
senast ändrad
lastModified date-time
severity
severity EventSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk
teamId
teamId string
texten
text string
title
title string

PagedResultsPublicContinuationToken

Name Sökväg Typ Description
nextPartitionKey
nextPartitionKey string
nextRowKey
nextRowKey string
nextTableName
nextTableName string

PagedResultsPublic-1-OverviewEvent-

Name Sökväg Typ Description
continuationToken
continuationToken PagedResultsPublicContinuationToken
hasMore
hasMore boolean
results
results array of OverviewEvent

PagedResultsPublic-1-V2.AlertInfo-

Name Sökväg Typ Description
continuationToken
continuationToken PagedResultsPublicContinuationToken
hasMore
hasMore boolean
results
results array of V2.AlertInfo

PagedResultsPublic-1-V2.RemoteJob-

Name Sökväg Typ Description
continuationToken
continuationToken PagedResultsPublicContinuationToken
hasMore
hasMore boolean
results
results array of V2.RemoteJob

PersistentNotificationModes

  • 0 = Av
  • 1 = Sammanfattning

  • 0 = Av
  • 1 = Sammanfattning

PrepaidBalanceInfo

Name Sökväg Typ Description
balans
balance integer
latestTopUp
latestTopUp date-time
pendingTransactions
pendingTransactions boolean

PrepaidSettingsInfo

Name Sökväg Typ Description
topUpAmount
topUpAmount integer
topUpEnabled
topUpEnabled boolean
topUpLimit
topUpLimit integer

PrepaidTransactionInfo

Name Sökväg Typ Description
belopp
amount integer
autoTopUpId
autoTopUpId string
skapad
created date-time
skapadAv
createdBy string
valuta
currency string
modified
modified date-time
packageCode
packageCode string
status
status string
statuskod
statusCode integer
subscriptionId
subscriptionId string
transaktion-ID
transactionId string

ScheduleInfo

Name Sökväg Typ Description
ände
end date-time
Id-nummer
id string
options
options integer
start
start date-time
userId
userId string

ScriptDescriptionData

Name Sökväg Typ Description
beskrivning
description string
name
name string
scriptType
scriptType string
kort beskrivning
shortDescription string

ScriptInstanceDetails

Name Sökväg Typ Description
config
config
customScriptDescription
customScriptDescription string
customScriptName
customScriptName string
enabled
enabled boolean
händelsemönster
eventPattern
eventSourceId
eventSourceId string
instanceId
instanceId string
senast ändrad
lastModified date-time
runtimeInformation
runtimeInformation ScriptInstanceInfoRuntimeInformationModel
scriptId
scriptId string
scriptName
scriptName string
subscriptionId
subscriptionId string
teamId
teamId string
webhookUrl
webhookUrl string

ScriptInstanceInfo

Name Sökväg Typ Description
customScriptDescription
customScriptDescription string
customScriptName
customScriptName string
enabled
enabled boolean
händelsemönster
eventPattern
eventSourceId
eventSourceId string
instanceId
instanceId string
senast ändrad
lastModified date-time
runtimeInformation
runtimeInformation ScriptInstanceInfoRuntimeInformationModel
scriptId
scriptId string
scriptName
scriptName string
subscriptionId
subscriptionId string
teamId
teamId string

ScriptInstanceInfoRuntimeInformationModel

Name Sökväg Typ Description
runtimeStatus
runtimeStatus ScriptInstanceInfoRuntimeStatus

  • 0 = Okänd
  • 1 = Startar
  • 2 = OK
  • 3 = Stoppa
  • 4 = Stoppad
  • -1 = Fel
runtimeStatusMessage
runtimeStatusMessage string

ScriptInstanceInfoRuntimeStatus

  • 0 = Okänd
  • 1 = Startar
  • 2 = OK
  • 3 = Stoppa
  • 4 = Stoppad
  • -1 = Fel

  • 0 = Okänd
  • 1 = Startar
  • 2 = OK
  • 3 = Stoppa
  • 4 = Stoppad
  • -1 = Fel

ScriptLocalizationDetail

Name Sökväg Typ Description
config
config
data
data ScriptDescriptionData
Språk
language string

SubscriptionFeature

Name Sökväg Typ Description
name
name string
type
type integer
värde
value string

SubscriptionInfo

Name Sökväg Typ Description
branchId
branchId string
country
country string
valuta
currency string
externalAccountId
externalAccountId string
Id-nummer
id string
name
name string
nextBilling
nextBilling date-time
ownerId
ownerId string
planCode
planCode string
planState
planState integer
referralEnabled
referralEnabled boolean
status
status integer

TeamCategoryOptOutModes

  • 0 = Inga
  • 1 = Inaktiverad
  • 2 = Personlig

  • 0 = Inga
  • 1 = Inaktiverad
  • 2 = Personlig

TeamDutySummaryInfo

Name Sökväg Typ Description
dutyAssistEnabled
dutyAssistEnabled boolean
dutySummaries
dutySummaries array of DutySummaryInfo
teamId
teamId string

TeamInfo

Name Sökväg Typ Description
Id-nummer
id string
imageLastModified
imageLastModified date-time
memberIds
memberIds array of string
name
name string
setupProgressEnabled
setupProgressEnabled boolean
subscriptionId
subscriptionId string
timezone
timezone string

TeamSetupProgress

Name Sökväg Typ Description
completedSteps
completedSteps array of string
teamId
teamId string
tidsstämpel
timestamp date-time

UserDutyInfo

Name Sökväg Typ Description
lastChange
lastChange date-time
onDuty
onDuty boolean
onManagerDuty
onManagerDuty boolean
förfallen
overdue boolean
teamId
teamId string
userId
userId string

UserImage

Name Sökväg Typ Description
innehåll
content byte
contentDispostion
contentDispostion string
contentEncoding
contentEncoding string
innehållstyp
contentType string
senast ändrad
lastModified date-time
name
name string

Användarinfo

Name Sökväg Typ Description
colorIndex
colorIndex integer
contactAddresses
contactAddresses array of
dutyInfos
dutyInfos UserDutyInfo
externalAuthProvider
externalAuthProvider string
Id-nummer
id string
isDeactivated
isDeactivated boolean
isInvite
isInvite boolean
isRemoteActionPinSet
isRemoteActionPinSet boolean
lastSeen
lastSeen date-time
e-post
mail string
name
name string
role-id
roleId string
subscriptionId
subscriptionId string
timeZone
timeZone string
userImageLastModified
userImageLastModified date-time

UserLicenseInfo

Name Sökväg Typ Description
currentUsers
currentUsers integer
isFree
isFree boolean
isTrial
isTrial boolean
licensedUsers
licensedUsers integer
planCode
planCode string

UserPermission

Name Sökväg Typ Description
tillåten
allowed boolean
tillåtelse
permission string

UserSetupProgress

Name Sökväg Typ Description
completedSteps
completedSteps array of string
tidsstämpel
timestamp date-time
userId
userId string

V2. AlertAnnotationDetails

Name Sökväg Typ Description
Id-nummer
id string
teamId
teamId string
texten
text string
tidsstämpel
timestamp date-time
type
type V2.AlertAnnotationTypes

  • 0 = Inga
  • 1 = Text
  • 2 = Bild
userId
userId string

V2. AlertAnnotationTypes

  • 0 = Inga
  • 1 = Text
  • 2 = Bild

  • 0 = Inga
  • 1 = Text
  • 2 = Bild

V2. AlertAttachmentInfo

Name Sökväg Typ Description
innehållstyp
contentType string
Id-nummer
id string
name
name string

V2. AlertCategoryCountsDetails

Name Sökväg Typ Description
Erkänt
acknowledged integer
categoryId
categoryId string
stängd
closed integer
Ohanterat
unhandled integer

V2. AlertCountTypes

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours

V2. AlertCountsDetails

Name Sökväg Typ Description
Erkänt
acknowledged integer
categoryCounts
categoryCounts array of V2.AlertCategoryCountsDetails
stängd
closed integer
ände
end date-time
senast ändrad
lastModified date-time
start
start date-time
subscriptionId
subscriptionId string
teamId
teamId string
type
type V2.AlertCountTypes

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours
typeString
typeString string
Ohanterat
unhandled integer
userId
userId string

V2. AlertDeliveryStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Misslyckades
  • 4 = Överförd
  • 6 = Levereras
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 22 = DelvisFailed
  • 24 = Delvisöversatt
  • 26 = Delvis levererad
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified

  • 0 = Inga
  • 1 = Öppna
  • 2 = Misslyckades
  • 4 = Överförd
  • 6 = Levereras
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 22 = DelvisFailed
  • 24 = Delvisöversatt
  • 26 = Delvis levererad
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified

V2. AlertDeliveryStatusDetails

Name Sökväg Typ Description
alertId
alertId string
statuskod
statusCode V2.AlertDeliveryStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Misslyckades
  • 4 = Överförd
  • 6 = Levereras
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 22 = DelvisFailed
  • 24 = Delvisöversatt
  • 26 = Delvis levererad
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified
userDeliveryStatus
userDeliveryStatus array of V2.UserDeliveryStatus

V2. AlertDetails

Name Sökväg Typ Description
parameters
parameters array of V2.EventParameterDetails
attachments
attachments array of V2.AlertAttachmentInfo
categoryId
categoryId string
Upptrappning
escalations array of V2.AlertEscalationDetails
eventId
eventId string
externId
externalId string
flags
flags V2.AlertFlags

  • 0 = Inga
  • 1 = HasAttachments
  • 2 = HasAnnotationer
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
historia
history V2.AlertHistoryInfo
Id-nummer
id string
senast ändrad
lastModified date-time
requiredAcknowledgements
requiredAcknowledgements integer
severity
severity V2.AlertSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk
status
status V2.AlertStatusDetails
subscriptionId
subscriptionId string
teamId
teamId string
texten
text string
timelineEntries
timelineEntries array of
title
title string
workflowType
workflowType V2.AlertWorkflowTypes

  • 0 = Inga
  • 1 = Användare
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2. AlertEscalationDetails

Name Sökväg Typ Description
alertId
alertId string
alertStatus
alertStatus V2.AlertStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Bekräftad
  • 4 = Stängd
  • 8 = NoReply
  • 16 = Misslyckades
  • 32 = Fel
escType
escType V2.AlertEscalationType

  • 0 = Inga
  • 1 = Chef
  • 2 = Team
status
status V2.AlertEscalationStatus

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = Filtrerad
  • 5 = Undertryckt
teamId
teamId string
teamName
teamName string
tidsstämpel
timestamp date-time

V2. AlertEscalationStatus

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = Filtrerad
  • 5 = Undertryckt

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = Filtrerad
  • 5 = Undertryckt

V2. AlertEscalationType

  • 0 = Inga
  • 1 = Chef
  • 2 = Team

  • 0 = Inga
  • 1 = Chef
  • 2 = Team

V2. AlertFlags

  • 0 = Inga
  • 1 = HasAttachments
  • 2 = HasAnnotationer
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation

  • 0 = Inga
  • 1 = HasAttachments
  • 2 = HasAnnotationer
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation

V2. AlertHistoryInfo

Name Sökväg Typ Description
acknowledgedAt
acknowledgedAt date-time
Bekräftelser
acknowledgements array of string
closedAt
closedAt date-time
closedBy
closedBy string
skapad
created date-time

V2. AlertInfo

Name Sökväg Typ Description
categoryId
categoryId string
eventId
eventId string
externId
externalId string
flags
flags V2.AlertFlags

  • 0 = Inga
  • 1 = HasAttachments
  • 2 = HasAnnotationer
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
historia
history V2.AlertHistoryInfo
Id-nummer
id string
senast ändrad
lastModified date-time
requiredAcknowledgements
requiredAcknowledgements integer
severity
severity V2.AlertSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk
status
status V2.AlertStatusDetails
subscriptionId
subscriptionId string
teamId
teamId string
texten
text string
title
title string
workflowType
workflowType V2.AlertWorkflowTypes

  • 0 = Inga
  • 1 = Användare
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2. AlertReportError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. AlertSettingsChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS

V2. AlertSettingsDetails

Name Sökväg Typ Description
escEnabled
escEnabled boolean
escMode
escMode AlertEscalationModes

  • 0 = Chef
  • 1 = Team
escRefId
escRefId string
filterAction
filterAction AlertFilterActions

  • 0 = Utelämna
  • 1 = Dölj
  • 2 = Stäng av
filterMode
filterMode AlertFilterModes

  • 0 = Av
  • 1 = WhiteListAllCategories
notificationProfileOverrides
notificationProfileOverrides array of V2.AlertSettingsNotificationProfileDetails
optOut
optOut TeamCategoryOptOutModes

  • 0 = Inga
  • 1 = Inaktiverad
  • 2 = Personlig
overrideNotificationProfiles
overrideNotificationProfiles boolean
persNotInterval
persNotInterval integer
persNotMode
persNotMode PersistentNotificationModes

  • 0 = Av
  • 1 = Sammanfattning
responseMode
responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
responseTime integer
teamId
teamId string

V2. AlertSettingsError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. AlertSettingsNotificationProfileDetails

Name Sökväg Typ Description
kanal
channel V2.AlertSettingsChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS
delayInMinutes (fördröjning) i minuter
delayInMinutes integer
enabled
enabled boolean

V2. AlertSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk

V2. AlertStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Bekräftad
  • 4 = Stängd
  • 8 = NoReply
  • 16 = Misslyckades
  • 32 = Fel

  • 0 = Inga
  • 1 = Öppna
  • 2 = Bekräftad
  • 4 = Stängd
  • 8 = NoReply
  • 16 = Misslyckades
  • 32 = Fel

V2. AlertStatusDetails

Name Sökväg Typ Description
alertDeliveryStatus
alertDeliveryStatus V2.AlertDeliveryStatusDetails
statuskod
statusCode V2.AlertStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Bekräftad
  • 4 = Stängd
  • 8 = NoReply
  • 16 = Misslyckades
  • 32 = Fel

V2. AlertWorkflowTypes

  • 0 = Inga
  • 1 = Användare
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

  • 0 = Inga
  • 1 = Användare
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2. AlertingPatternChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS

V2. AlertingPatternDetails

Name Sökväg Typ Description
categories
categories array of string
escalationSettings
escalationSettings V2.AlertingPatternEscalationSettings
Id-nummer
id string
name
name string
notificationProfileOverrides
notificationProfileOverrides array of V2.AlertingPatternNotificationProfileDetails
overrideEscalationSettings
overrideEscalationSettings boolean
overrideNotificationProfiles
overrideNotificationProfiles boolean
overrideResponseSettings
overrideResponseSettings boolean
responseSettings
responseSettings V2.AlertingPatternResponseSettings
suppressSignl
suppressSignl boolean
timeSlots
timeSlots array of V2.TimeSlotDetails

V2. AlertingPatternEscalationSettings

Name Sökväg Typ Description
enabled
enabled boolean
mode
mode AlertEscalationModes

  • 0 = Chef
  • 1 = Team
referenceId
referenceId string

V2. AlertingPatternNotificationProfileDetails

Name Sökväg Typ Description
kanal
channel V2.AlertingPatternChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = Röst
  • 3 = SMS
delayInMinutes (fördröjning) i minuter
delayInMinutes integer
enabled
enabled boolean

V2. AlertingPatternResponseSettings

Name Sökväg Typ Description
responseMode
responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
responseTime integer

V2. CalloutTemplateDetails

Name Sökväg Typ Description
categoryId
categoryId string
externId
externalId string
Id-nummer
id string
location
location string
name
name string
ämne
subject string
targetAllTeams
targetAllTeams boolean
targetTeamId
targetTeamId string
texten
text string
workflowType
workflowType V2.CalloutTemplateWorkflowType

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2. CalloutTemplateWorkflowType

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2. CategoryAugmentationDetails

Name Sökväg Typ Description
enabled
enabled boolean
Id-nummer
id string
name
name string
type
type V2.CategoryAugmentationType

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats
värde
value string

V2. CategoryAugmentationType

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats

  • 0 = Parameter
  • 1 = Ämne
  • 2 = Text
  • 3 = Plats

V2. CategoryDetails

Name Sökväg Typ Description
augmentations
augmentations array of V2.CategoryAugmentationDetails
color
color string
berikningar
enrichments array of V2.CategoryEnrichmentDetails
Id-nummer
id string
imageName (på engelska)
imageName string
isDefault
isDefault boolean
keywordMatching
keywordMatching V2.KeywordMatchingType

  • 0 = Alla
  • 1 = Alla
nyckelord
keywords array of string
keywordsExcluded
keywordsExcluded array of string
name
name string
options
options V2.CategoryOptions

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
order integer
teamId
teamId string

V2. CategoryEnrichmentDetails

Name Sökväg Typ Description
Id-nummer
id string
name
name string
type
type V2.CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlänk
värde
value string

V2. CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlänk

  • 0 = Parameter
  • 1 = Hyperlänk

V2. CategoryError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. CategoryOptions

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

  • 0 = Inga
  • 1 = Dold
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

V2. ChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS

V2. DutyChangeError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string
userId
userId string

V2. DutyError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. DutyModes

  • 0 = Inga
  • 1 = Primär
  • 100 = Chef

  • 0 = Inga
  • 1 = Primär
  • 100 = Chef

V2. EventDetails

Name Sökväg Typ Description
parameters
parameters array of V2.EventParameterDetails
acknowledgedAlerts
acknowledgedAlerts array of string
closedAlerts
closedAlerts array of string
skapandetid
creationTime date-time
eventSourceGroupId
eventSourceGroupId string
eventSourceId
eventSourceId string
eventSourceTeamId
eventSourceTeamId string
eventSourceType
eventSourceType V2.EventSourceTypes

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API
eventStatus
eventStatus V2.EventStatusCodes

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel
externId
externalId string
från
from string
Id-nummer
id string
senast ändrad
lastModified date-time
severity
severity V2.EventSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk
targets
targets array of V2.EventTargetDetails
texten
text string
title
title string

V2. EventParameterDetails

Name Sökväg Typ Description
Id-nummer
id string
name
name string
options
options V2.EventParameterOptions

  • 0 = Inga
  • 1 = ExcludeFromCategorization
order
order integer
type
type V2.EventParameterTypes

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html
värde
value string

V2. EventParameterOptions

  • 0 = Inga
  • 1 = ExcludeFromCategorization

  • 0 = Inga
  • 1 = ExcludeFromCategorization

V2. EventParameterTypes

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html

  • 0 = Inga
  • 1 = Objekt
  • 2 = Matris
  • 3 = Konstruktor
  • 4 = Egenskap
  • 5 = Kommentar
  • 6 = Heltal
  • 7 = Flyttal
  • 8 = Sträng
  • 9 = Booleskt värde
  • 10 = Null
  • 11 = Odefinierad
  • 12 = Datum
  • 13 = Rå
  • 14 = Byte
  • 15 = Guid
  • 16 = Uri
  • 17 = Tidsintervall
  • 100 = Html

V2. EventSeverities

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk

  • 0 = Låg
  • 1 = Huvud
  • 2 = Kritisk

V2. EventSourceEndpointError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. EventSourceTypes

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API

  • 0 = Inga
  • 1 = E-post
  • 2 = WebHook
  • 3 = Skript
  • 4 = System
  • 5 = Manuell
  • 6 = Röst
  • 7 = API

V2. EventStatusCodes

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Fel

V2. EventTargetDetails

Name Sökväg Typ Description
alertId
alertId string
categoryId
categoryId string
skapandetid
creationTime date-time
distributionId
distributionId string
eventId
eventId string
eventTargetStatus
eventTargetStatus V2.EventTargetStatusCode

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 1000 = Fel
Id-nummer
id string
senast ändrad
lastModified date-time
teamId
teamId string

V2. EventTargetStatusCode

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 1000 = Fel

  • 0 = Inga
  • 1 = Bearbetning
  • 2 = Signerad
  • 3 = Filtrerad
  • 4 = Löst
  • 5 = Ignorerad
  • 6 = Bekräftad
  • 7 = Undertryckt
  • 1000 = Fel

V2. HolidayDetails

Name Sökväg Typ Description
dag
day integer
månad
month V2.Month

  • 0 = Ta bort
  • 1 = januari
  • 2 = februari
  • 3 = mars
  • 4 = april
  • 5 = maj
  • 6 = juni
  • 7 = juli
  • 8 = augusti
  • 9 = september
  • 10 = oktober
  • 11 = november
  • 12 = december
upprepande
repeating boolean
år
year integer

V2. InvitationResult

Name Sökväg Typ Description
felkod
errorCode integer
errorMessage
errorMessage string
invitedUser
invitedUser V2.InvitedUserInfo
framgång
success boolean

V2. InvitedUserInfo

Name Sökväg Typ Description
mailAddress
mailAddress string
role-id
roleId string
status
status V2.UserStatus

  • 0 = Inga
  • 1 = Borttagen
  • 2 = Inbjuden
  • 3 = Aktiv
userId
userId string

V2. KeywordMatchingType

  • 0 = Alla
  • 1 = Alla

  • 0 = Alla
  • 1 = Alla

V2. Månad

  • 0 = Ta bort
  • 1 = januari
  • 2 = februari
  • 3 = mars
  • 4 = april
  • 5 = maj
  • 6 = juni
  • 7 = juli
  • 8 = augusti
  • 9 = september
  • 10 = oktober
  • 11 = november
  • 12 = december

  • 0 = Ta bort
  • 1 = januari
  • 2 = februari
  • 3 = mars
  • 4 = april
  • 5 = maj
  • 6 = juni
  • 7 = juli
  • 8 = augusti
  • 9 = september
  • 10 = oktober
  • 11 = november
  • 12 = december

V2. NotificationProfileDetails

Name Sökväg Typ Description
kanal
channel V2.ChannelType

  • 0 = Inga
  • 1 = Push
  • 2 = E-post
  • 4 = Robot
  • 8 = Röst
  • 16 = SMS
delayInMinutes (fördröjning) i minuter
delayInMinutes integer
enabled
enabled boolean
options
options integer
persistent
persistent boolean

V2. OverlappingTimeSlotsDetails

Name Sökväg Typ Description
refId
refId string
timeSlots
timeSlots array of V2.TimeSlotDetails

V2. PermissionError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. PhoneNumberValidationStatus

  • 0 = NotValidated
  • 1 = Verifierad
  • 2 = CountryNotSupported

  • 0 = NotValidated
  • 1 = Verifierad
  • 2 = CountryNotSupported

V2. RemoteActionDefinitionDetails

Name Sökväg Typ Description
parameters
parameters array of V2.RemoteActionDefinitionParameterDetails
createdAt
createdAt date-time
beskrivning
description string
executorService
executorService string
externId
externalId string
Id-nummer
id string
name
name string
statuskod
statusCode V2.RemoteActionDefinitionStatus

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig
statusDescription
statusDescription string
type
type V2.RemoteActionTypes

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook
version
version integer

V2. RemoteActionDefinitionParameterDetails

Name Sökväg Typ Description
controlType
controlType V2.RemoteActionParameterControlTypes

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Heltal
  • 3 = Dubbelt
  • 4 = Bool
  • 5 = Tid
  • 6 = Datum
  • 7 = Tidszon
  • 8 = Lösenord
  • 9 = PIN-kod
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Förslag
defaultValue
defaultValue string
beskrivning
description string
visningsnamn
displayName string
name
name string
options
options V2.RemoteActionParameterOptions

  • 0 = Inga
  • 1 = Krävs
  • 2 = Låst
  • 4 = Krypterad
order
order integer
values
values array of string

V2. RemoteActionDefinitionStatus

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig

V2. RemoteActionDetails

Name Sökväg Typ Description
parameters
parameters array of V2.RemoteActionParameter
tillträde
access array of V2.RemoteActionTeamAccessDetails
createdAt
createdAt date-time
currentPrincipal
currentPrincipal V2.RemoteActionPrincipalAccessDetails
definitionId
definitionId string
definitionVersion
definitionVersion integer
beskrivning
description string
enabled
enabled boolean
executorService
executorService string
externId
externalId string
Id-nummer
id string
name
name string
statuskod
statusCode V2.RemoteActionStatus

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig
  • 4 = ProviderDisabled
statusDescription
statusDescription string
subscriptionId
subscriptionId string
teamId
teamId string
type
type V2.RemoteActionTypes

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2. RemoteActionInfo

Name Sökväg Typ Description
tillträde
access array of V2.RemoteActionTeamAccessDetails
createdAt
createdAt date-time
currentPrincipal
currentPrincipal V2.RemoteActionPrincipalAccessDetails
definitionId
definitionId string
beskrivning
description string
enabled
enabled boolean
Id-nummer
id string
name
name string
statuskod
statusCode V2.RemoteActionStatus

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig
  • 4 = ProviderDisabled
statusDescription
statusDescription string
subscriptionId
subscriptionId string
teamId
teamId string
type
type V2.RemoteActionTypes

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2. RemoteActionParameter

Name Sökväg Typ Description
controlType
controlType V2.RemoteActionParameterControlTypes

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Heltal
  • 3 = Dubbelt
  • 4 = Bool
  • 5 = Tid
  • 6 = Datum
  • 7 = Tidszon
  • 8 = Lösenord
  • 9 = PIN-kod
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Förslag
visningsnamn
displayName string
name
name string
options
options V2.RemoteActionParameterOptions

  • 0 = Inga
  • 1 = Krävs
  • 2 = Låst
  • 4 = Krypterad
order
order integer
värde
value string
values
values array of string

V2. RemoteActionParameterControlTypes

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Heltal
  • 3 = Dubbelt
  • 4 = Bool
  • 5 = Tid
  • 6 = Datum
  • 7 = Tidszon
  • 8 = Lösenord
  • 9 = PIN-kod
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Förslag

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Heltal
  • 3 = Dubbelt
  • 4 = Bool
  • 5 = Tid
  • 6 = Datum
  • 7 = Tidszon
  • 8 = Lösenord
  • 9 = PIN-kod
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Förslag

V2. RemoteActionParameterOptions

  • 0 = Inga
  • 1 = Krävs
  • 2 = Låst
  • 4 = Krypterad

  • 0 = Inga
  • 1 = Krävs
  • 2 = Låst
  • 4 = Krypterad

V2. RemoteActionPrincipalAccessDetails

Name Sökväg Typ Description
canEdit
canEdit boolean
canExecute
canExecute boolean

V2. RemoteActionStatus

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig
  • 4 = ProviderDisabled

  • 0 = Inaktiverad
  • 1 = Aktiverad
  • 2 = Ogiltig
  • 4 = ProviderDisabled

V2. RemoteActionTeamAccessDetails

Name Sökväg Typ Description
canEdit
canEdit boolean
canExecute
canExecute boolean
teamId
teamId string

V2. RemoteActionTypes

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2. Fjärrjobb

Name Sökväg Typ Description
parameters
parameters array of V2.RemoteJobParameter
actionId
actionId string
activatedAt
activatedAt date-time
createdAt
createdAt date-time
creatorInfo
creatorInfo V2.RemoteJobCreatorDetails
definitionId
definitionId string
externId
externalId string
Id-nummer
id string
lastUpdate
lastUpdate date-time
options
options V2.RemoteJobOptions

  • 0 = Inga
startedAt
startedAt date-time
statuskod
statusCode V2.RemoteJobStatusCodes

  • 0 = Inga
  • 1 = Väntar
  • 2 = Klar
  • 4 = Körs
  • 8 = Körd
  • 16 = Fel
statusDescription
statusDescription string
statusdetaljer
statusDetails string
type
type V2.RemoteActionTypes

  • 0 = Okänd
  • 1 = Skript
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2. RemoteJobCreatorDetails

Name Sökväg Typ Description
referenceId
referenceId string
referenceName
referenceName string
type
type V2.RemoteJobCreatorType

  • 0 = Inga
  • 1 = Användare
  • 2 = ApiKey
  • 3 = System

V2. RemoteJobCreatorType

  • 0 = Inga
  • 1 = Användare
  • 2 = ApiKey
  • 3 = System

  • 0 = Inga
  • 1 = Användare
  • 2 = ApiKey
  • 3 = System

V2. RemoteJobOptions

  • 0 = Inga

  • 0 = Inga

V2. RemoteJobParameter

Name Sökväg Typ Description
name
name string
värde
value string

V2. RemoteJobStatusCodes

  • 0 = Inga
  • 1 = Väntar
  • 2 = Klar
  • 4 = Körs
  • 8 = Körd
  • 16 = Fel

  • 0 = Inga
  • 1 = Väntar
  • 2 = Klar
  • 4 = Körs
  • 8 = Körd
  • 16 = Fel

V2. ScheduleDetails

Name Sökväg Typ Description
ände
end date-time
Id-nummer
id string
options
options integer
start
start date-time
teamId
teamId string
userId
userId string

V2. TeamDutySettingsDetails

Name Sökväg Typ Description
autosnapEnabled
autosnapEnabled boolean
dutyAssistantEnabled
dutyAssistantEnabled boolean
dutyChangeNotificationsEnabled
dutyChangeNotificationsEnabled boolean
dutyLength
dutyLength integer
handoverDate
handoverDate date-time
handoverTime
handoverTime integer
handoverWeekDay
handoverWeekDay integer
minMemberOnDuty
minMemberOnDuty integer
schedulingEnabled
schedulingEnabled boolean
shiftReportCarbonCopyMail
shiftReportCarbonCopyMail string
shiftReportEnabled
shiftReportEnabled boolean
teamId
teamId string
timezone
timezone string

V2. TeamDutySettingsError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. TeamDutySummaryError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
userId
userId string

V2. TeamHolidayDetails

Name Sökväg Typ Description
ferier
holidays array of V2.HolidayDetails
teamId
teamId string

V2. TeamImageDetails

Name Sökväg Typ Description
innehåll
content byte
contentDispostion
contentDispostion string
contentEncoding
contentEncoding string
innehållstyp
contentType string
senast ändrad
lastModified date-time
name
name string

V2. TeamMembershipDetails

Name Sökväg Typ Description
mailAddress
mailAddress string
memberSince
memberSince date-time
role-id
roleId string
status
status V2.UserStatus

  • 0 = Inga
  • 1 = Borttagen
  • 2 = Inbjuden
  • 3 = Aktiv
teamId
teamId string
userId
userId string

V2. TeamPermissions

Name Sökväg Typ Description
permissions
permissions array of UserPermission
teamId
teamId string

V2. TeamPrivacySettingsDetails

Name Sökväg Typ Description
hideContactAddresses
hideContactAddresses boolean
hideDutyData
hideDutyData boolean
hideForEscalation
hideForEscalation boolean
teamId
teamId string

V2. TeamPublicDetails

Name Sökväg Typ Description
Id-nummer
id string
name
name string
privacySettings
privacySettings V2.TeamPrivacySettingsDetails

V2. TeamUserError

Name Sökväg Typ Description
felkod
errorCode integer
felsbeskrivning
errorDescription string
teamId
teamId string

V2. TimeSlotDetails

Name Sökväg Typ Description
ände
end V2.WeekTimeDetails
Id-nummer
id string
start
start V2.WeekTimeDetails

V2. TimeSlotValidationResultDetails

Name Sökväg Typ Description
isOverlapping
isOverlapping boolean
item
item V2.TimeSlotDetails
overlappingTimeSlots
overlappingTimeSlots array of V2.OverlappingTimeSlotsDetails
giltig
valid boolean

V2. UserDeliveryStatus

Name Sökväg Typ Description
statuskod
statusCode V2.UserDeliveryStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Misslyckades
  • 4 = Överförd
  • 6 = Levereras
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 24 = Delvisöversatt
  • 26 = Delvis levererad
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent
userId
userId string

V2. UserDeliveryStatusCodes

  • 0 = Inga
  • 1 = Öppna
  • 2 = Misslyckades
  • 4 = Överförd
  • 6 = Levereras
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 24 = Delvisöversatt
  • 26 = Delvis levererad
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent

  • 0 = Inga
  • 1 = Öppna
  • 2 = Misslyckades
  • 4 = Överförd
  • 6 = Levereras
  • 8 = Skyddad
  • 9 = AbuseProtected
  • 24 = Delvisöversatt
  • 26 = Delvis levererad
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent

V2. UserDetails

Name Sökväg Typ Description
colorIndex
colorIndex integer
contactAddresses
contactAddresses array of
dutyInfos
dutyInfos array of V2.UserDutyDetails
externalAuthProvider
externalAuthProvider string
Id-nummer
id string
isDeactivated
isDeactivated boolean
isInvite
isInvite boolean
lastSeen
lastSeen date-time
e-post
mail string
name
name string
remoteActionPinSet
remoteActionPinSet boolean
subscriptionId
subscriptionId string
timeZone
timeZone string
userImageLastModified
userImageLastModified date-time

V2. UserDutyDetails

Name Sökväg Typ Description
dutyMode
dutyMode V2.DutyModes

  • 0 = Inga
  • 1 = Primär
  • 100 = Chef
lastChange
lastChange date-time
onDutyTime
onDutyTime integer
förfallen
overdue boolean
teamId
teamId string
userId
userId string

V2. UserLocaleResponseDetails

Name Sökväg Typ Description
Id-nummer
id string
Språk
language string
timeZone
timeZone string

V2. UserPhoneNumberDetails

Name Sökväg Typ Description
landskod
countryCode string
telefonnummer
phoneNumber string
validationStatus
validationStatus V2.PhoneNumberValidationStatus

  • 0 = NotValidated
  • 1 = Verifierad
  • 2 = CountryNotSupported

V2. UserStatus

  • 0 = Inga
  • 1 = Borttagen
  • 2 = Inbjuden
  • 3 = Aktiv

  • 0 = Inga
  • 1 = Borttagen
  • 2 = Inbjuden
  • 3 = Aktiv

V2. WeekTimeDetails

Name Sökväg Typ Description
timme
hour integer
minutes
minutes integer
vardag
weekday V2.Weekday

  • 0 = Helgdag
  • 1 = måndag
  • 2 = tisdag
  • 3 = onsdag
  • 4 = torsdag
  • 5 = fredag
  • 6 = lördag
  • 7 = söndag

V2. Vardag

  • 0 = Helgdag
  • 1 = måndag
  • 2 = tisdag
  • 3 = onsdag
  • 4 = torsdag
  • 5 = fredag
  • 6 = lördag
  • 7 = söndag

  • 0 = Helgdag
  • 1 = måndag
  • 2 = tisdag
  • 3 = onsdag
  • 4 = torsdag
  • 5 = fredag
  • 6 = lördag
  • 7 = söndag

WebhookInfo

Name Sökväg Typ Description
beskrivning
description string
enabled
enabled boolean
extUrl
extUrl string
Id-nummer
id string
name
name string
subId
subId string
teamId
teamId string

snöre

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

binär

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