mediatype.create

Beschrijving

object mediatype.create(object/array mediaTypes)

Deze methode maakt het mogelijk om nieuwe mediatypen te maken.

Deze methode is alleen beschikbaar voor gebruikerstype Superadmin. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Mediatypes om te maken.

Naast de standaardeigenschappen van mediatype, accepteert de methode de volgende parameters.

Parameter Type Omschrijving
parameters array Scriptparameters of webhookparameters die moeten worden gemaakt voor het mediatype.
message_templates array Berichtsjablonen die moeten worden gemaakt voor het mediatype.

Retourwaarden

(object) Retourneert een object dat de ID's van de gemaakte media bevat typen onder de eigenschap mediatypeids. De volgorde van de geretourneerde ID's komt overeen met de volgorde van de doorgegeven mediatypen.

Voorbeelden

Een e-mail mediatype creëren

Creëer een nieuw e-mail mediatype met een aangepoorte SMTP-poort en berichtsjablonen.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "mediatype.create",
           "params": {
               "type": "0",
               "name": "E-mail",
               "smtp_server": "mail.example.com",
               "smtp_helo": "example.com",
               "smtp_email": "[email protected]",
               "smtp_port": "587",
               "content_type": "1",
               "message_templates": [
                   {
                       "eventsource": "0",
                       "recovery": "0",
                       "subject": "Probleem: {EVENT.NAME}",
                       "message": "Probleem \"{EVENT.NAME}\" op host \"{HOST.NAME}\" gestart om {EVENT.TIME}."
                   },
                   {
                       "eventsource": "0",
                       "recovery": "1",
                       "subject": "Opgelost in {EVENT.DURATION}: {EVENT.NAME}",
                       "message": "Probleem \"{EVENT.NAME}\" op host \"{HOST.NAME}\" is opgelost om {EVENT.RECOVERY.TIME} op {EVENT.RECOVERY.DATE}."
                   },
                   {
                       "eventsource": "0",
                       "recovery": "2",
                       "subject": "Bijgewerkt probleem in {EVENT.AGE}: {EVENT.NAME}",
                       "message": "{USER.FULLNAME} heeft het probleem \"{EVENT.NAME}\" op host \"{HOST.NAME}\" bijgewerkt op {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}."
                   }
               ]
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "mediatypeids": [
                   "7"
               ]
           },
           "id": 1
       }

Een script mediatype creëren

Creëer een nieuw script mediatype met een aangepaste waarde voor het aantal pogingen en het interval daartussen.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "mediatype.create",
           "params": {
               "type": "1",
               "name": "Pushmeldingen",
               "exec_path": "push-notification.sh",
               "maxattempts": "5",
               "attempt_interval": "11s",
               "parameters": [
                   {
                       "sortorder": "0",
                       "value": "{ALERT.SENDTO}"
                   },
                   {
                       "sortorder": "1",
                       "value": "{ALERT.SUBJECT}"
                   },
                   {
                       "sortorder": "2",
                       "value": "{ALERT.MESSAGE}"
                   }
               ]
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "mediatypeids": [
                   "8"
               ]
           },
           "id": 1
       }

Een webhook mediatype creëren

Creëer een nieuw webhook mediatype.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "mediatype.create",
           "params": {
               "type": "4",
               "name": "Webhook",
               "script": "var Webhook = {\r\n    token: null,\r\n    to: null,\r\n    subject: null,\r\n    message: null,\r\n\r\n    sendMessage: function() {\r\n        // some logic\r\n    }\r\n}",
               "parameters": [
                   {
                       "name": "Message",
                       "value": "{ALERT.MESSAGE}"
                   },
                   {
                       "name": "Subject",
                       "value": "{ALERT.SUBJECT}"
                   },
                   {
                       "name": "To",
                       "value": "{ALERT.SENDTO}"
                   },
                   {
                       "name": "Token",
                       "value": "<Token>"
                   }
               ]
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "mediatypeids": [
                   "9"
               ]
           },
           "id": 1
       }

Bron

CMediaType::create() in ui/include/classes/api/services/CMediaType.php.