Documentation
Table of Contents
> Mediatype-object
De volgende objecten zijn direct gerelateerd aan de mediatype API.
Media type
Het mediatype object heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| mediatypeid | string | ID van het mediatype. Eigenschap gedrag: - alleen-lezen - vereist voor update bewerkingen |
| name | string | Naam van het mediatype. Eigenschap gedrag: - vereist voor aanmaak bewerkingen |
| type | integer | Transport gebruikt door het mediatype. Mogelijke waarden: 0 - E-mail; 1 - Script; 2 - SMS; 4 - Webhook. Eigenschap gedrag: - vereist voor aanmaak bewerkingen |
| exec_path | string | Voor script mediatypes bevat exec_path de naam van het uitgevoerde script.Eigenschap gedrag: - vereist als type is ingesteld op "Script" |
| gsm_modem | string | Seriële apparaatnaam van de GSM-modem. Eigenschap gedrag: - vereist als type is ingesteld op "SMS" |
| passwd | string | Authenticatiewachtwoord. Eigenschap gedrag: - ondersteund als type is ingesteld op "E-mail" |
| smtp_email | string | E-mailadres van waaruit meldingen worden verstuurd. Eigenschap gedrag: - vereist als type is ingesteld op "E-mail" |
| smtp_helo | string | SMTP HELO. Eigenschap gedrag: - vereist als type is ingesteld op "E-mail" |
| smtp_server | string | SMTP-server. Eigenschap gedrag: - vereist als type is ingesteld op "E-mail" |
| smtp_port | integer | SMTP-serverpoort om verbinding mee te maken. |
| smtp_security | integer | Beveiligingsniveau van SMTP-verbinding om te gebruiken. Mogelijke waarden: 0 - Geen; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | SSL verifiëren host voor SMTP. Mogelijke waarden: 0 - Nee; 1 - Ja. |
| smtp_verify_peer | integer | SSL verifiëren peer voor SMTP. Mogelijke waarden: 0 - Nee; 1 - Ja. |
| smtp_authentication | integer | SMTP authenticatiemethode om te gebruiken. Mogelijke waarden: 0 - Geen; 1 - Normaal wachtwoord. |
| status | integer | Of het mediatype is ingeschakeld. Mogelijke waarden: 0 - (standaard) Ingeschakeld; 1 - Uitgeschakeld. |
| username | string | Gebruikersnaam. Eigenschap gedrag: - ondersteund als type is ingesteld op "E-mail" |
| maxsessions | integer | Het maximale aantal meldingen dat parallel kan worden verwerkt. Mogelijke waarden als type is ingesteld op "SMS": (standaard) 1.Mogelijke waarden als type is ingesteld op "E-mail", "Script", of "Webhook": 0-100. |
| maxattempts | integer | Het maximale aantal pogingen om een melding te versturen. Mogelijke waarden: 1-100. Standaardwaarde: 3. |
| attempt_interval | string | Het interval tussen herhaalde pogingen. Accepteert seconden en tijdseenheid met suffix. Mogelijke waarden: 0-1u. Standaardwaarde: 10s. |
| content_type | integer | Berichtformaat. Mogelijke waarden: 0 - platte tekst; 1 - (standaard) html. |
| script | string | Script voor mediatype webhook. |
| timeout | string | Timeout voor mediatype webhook script. Accepteert seconden en tijdseenheid met suffix. Mogelijke waarden: 1-60s. Standaard: 30s. |
| process_tags | integer | Definieert of het webhook-scriptantwoord moet worden geïnterpreteerd als tags en deze tags aan het bijbehorende evenement moeten worden toegevoegd. Mogelijke waarden: 0 - (standaard) Negeer webhook-scriptantwoord; 1 - Verwerk webhook-scriptantwoord als tags. |
| show_event_menu | integer | Toon mediatype item in eigenschap urls van problem.get en event.get.Mogelijke waarden: 0 - (standaard) Voeg geen urls item toe;1 - Voeg mediatype toe aan urls eigenschap. |
| event_menu_url | string | Definieer url eigenschap van mediatype item in urls eigenschap van problem.get en event.get. |
| event_menu_name | string | Definieer name eigenschap van mediatype item in urls eigenschap van problem.get en event.get. |
| parameters | array | Array van webhook of script invoerparameters. |
| description | string | Beschrijving van mediatype. |
Webhook parameters
Parameters die aan een webhook-script worden doorgegeven wanneer het wordt aangeroepen, hebben de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| name | string | Parameter naam. Eigenschap gedrag: - vereist |
| value | string | Parameterwaarde, ondersteunt macro's. Ondersteunde macro's worden beschreven op de Ondersteunde macro's pagina. |
Script parameters
Parameters die aan een script worden doorgegeven wanneer het wordt aangeroepen, hebben de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| sortorder | integer | De volgorde waarin de parameters als command-line argumenten aan het script worden doorgegeven, beginnend bij 0 als de eerste parameter. Eigenschap gedrag: - vereist |
| value | string | Parameterwaarde, ondersteunt macro's. Ondersteunde macro's worden beschreven op de Ondersteunde macro's pagina. |
Berichtsjabloon
Het berichtsjabloonobject definieert een sjabloon dat wordt gebruikt als standaardbericht voor actiebewerkingen om een melding te verzenden. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| eventsource | integer | Bron van het evenement. Mogelijke waarden: 0 - triggers; 1 - ontdekkingen; 2 - automatische registratie; 3 - intern; 4 - services. Eigenschap gedrag: - vereist |
| recovery | integer | Bedrijfsmodus. Mogelijke waarden: 0 - operaties; 1 - herstelbewerkingen; 2 - bijwerkingsbewerkingen. Eigenschap gedrag: - vereist |
| subject | string | Onderwerp van het bericht. |
| message | string | Berichttekst. |