Zabbix Documentation 5.2

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


manual:api:reference:mediatype:get

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:api:reference:mediatype:get [2014/09/26 11:23]
sasha Links adapted because of a move operation
manual:api:reference:mediatype:get [2020/05/05 09:57] (current)
martins-v frontends/php -> ui (ZBX-17667)
Line 18: Line 18:
 | userids | string/​array | Return only media types used by the given users. | | userids | string/​array | Return only media types used by the given users. |
 ^ ||| ^ |||
-selectUsers ​| query | Return ​the users that use the media type in the ''​users''​ property. |+selectMessageTemplates ​| query | Return ​a ''​[[:​manual/​api/​reference/​mediatype/​object#​Message_template|message_templates]]''​ property with an array of media type messages. | 
 +| selectUsers | query | Return a ''​[[:/​manual/​api/​reference/​user/​object|users]]''​ property ​with the users that use the media type. |
 ^ ||| ^ |||
 | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​mediatypeid''​. ​ | | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​mediatypeid''​. ​ |
-| countOutput |flag|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]]. ​ |+| countOutput |boolean|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]]. ​ |
 | editable |boolean|:::​| | editable |boolean|:::​|
-| excludeSearch |flag|:::|+| excludeSearch |boolean|:::|
 | filter | object |:::| | filter | object |:::|
 | limit |integer|:::​| | limit |integer|:::​|
 | output |query|:::| | output |query|:::|
-| preservekeys |flag|:::|+| preservekeys |boolean|:::|
 | search | object |:::| | search | object |:::|
 | searchByAny |boolean|:::​| | searchByAny |boolean|:::​|
 | searchWildcardsEnabled |boolean|:::​| | searchWildcardsEnabled |boolean|:::​|
 | sortorder | string/​array | ::: | | sortorder | string/​array | ::: |
-| startSearch |flag|:::|+| startSearch |boolean|:::|
 ==== Return values ==== ==== Return values ====
  
Line 46: Line 47:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
     "​method":​ "​mediatype.get",​     "​method":​ "​mediatype.get",​
     "​params":​ {     "​params":​ {
-        "​output":​ "​extend"​+        "​output": "​extend",​ 
 +        "​selectMessageTemplates": "​extend"​
     },     },
     "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​     "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
Line 59: Line 61:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 66: Line 68:
             "​mediatypeid":​ "​1",​             "​mediatypeid":​ "​1",​
             "​type":​ "​0",​             "​type":​ "​0",​
-            "description": "​Email",​ +            "name": "​Email",​ 
-            "​smtp_server":​ "mail.company.com",​ +            "​smtp_server":​ "mail.example.com",​ 
-            "​smtp_helo":​ "company.com",​ +            "​smtp_helo":​ "example.com",​ 
-            "​smtp_email":​ "​[email protected]company.com",+            "​smtp_email":​ "​[email protected]example.com",
             "​exec_path":​ "",​             "​exec_path":​ "",​
             "​gsm_modem":​ "",​             "​gsm_modem":​ "",​
             "​username":​ "",​             "​username":​ "",​
             "​passwd":​ "",​             "​passwd":​ "",​
-            "​status":​ "​0"​ +            "​status":​ "​0"​, 
-        }+            "​smtp_port":​ "​25"​
-        { +            "​smtp_security":​ "​0",​ 
-            "mediatypeid": "2", +            "smtp_verify_peer": "0", 
-            "type": "​3",​ +            "smtp_verify_host":​ "​0",​ 
-            "description": "Jabber", +            "​smtp_authentication":​ "​0",​ 
-            "smtp_server": "",​ +            "​exec_params":​ "",​ 
-            "smtp_helo": "",​ +            "​maxsessions":​ "​1",​ 
-            "smtp_email": "",​ +            "​maxattempts": "​3",​ 
-            "exec_path": "",​ +            "attempt_interval": "10s", 
-            "gsm_modem": "",​ +            "content_type": "0", 
-            "username": "[email protected]", +            "script": "",​ 
-            "passwd": "zabbix", +            "timeout": "30s", 
-            "​status":​ "​0"​+            "process_tags": "0", 
 +            "show_event_menu": "1", 
 +            "event_menu_url": "",​ 
 +            "event_menu_name": "",​ 
 +            "description":​ "",​ 
 +            "​message_templates":​ [ 
 +                { 
 +                    "​eventsource":​ "​0",​ 
 +                    "​recovery":​ "​0",​ 
 +                    "​subject":​ "​Problem:​ {EVENT.NAME}",​ 
 +                    "​message":​ "​Problem started at {EVENT.TIME} on {EVENT.DATE}\r\nProblem name: {EVENT.NAME}\r\nHost:​ {HOST.NAME}\r\nSeverity:​ {EVENT.SEVERITY}\r\nOperational data: {EVENT.OPDATA}\r\nOriginal problem ID: {EVENT.ID}\r\n{TRIGGER.URL}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​0",​ 
 +                    "​recovery":​ "​1",​ 
 +                    "​subject":​ "​Resolved:​ {EVENT.NAME}",​ 
 +                    "​message":​ "​Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}\r\nProblem name: {EVENT.NAME}\r\nHost:​ {HOST.NAME}\r\nSeverity:​ {EVENT.SEVERITY}\r\n\r\nOriginal problem ID: {EVENT.ID}\r\n{TRIGGER.URL}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​0",​ 
 +                    "​recovery":​ "​2",​ 
 +                    "​subject":​ "​Updated problem: {EVENT.NAME}",​ 
 +                    "​message":​ "​{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nCurrent problem ​status ​is {EVENT.STATUS},​ acknowledged:​ {EVENT.ACK.STATUS}."​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​1",​ 
 +                    "​recovery": "​0"​
 +                    "​subject":​ "​Discovery:​ {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}",​ 
 +                    "​message":​ "​Discovery rule: {DISCOVERY.RULE.NAME}\r\n\r\nDevice IP: {DISCOVERY.DEVICE.IPADDRESS}\r\nDevice DNS: {DISCOVERY.DEVICE.DNS}\r\nDevice status: {DISCOVERY.DEVICE.STATUS}\r\nDevice uptime: {DISCOVERY.DEVICE.UPTIME}\r\n\r\nDevice service name: {DISCOVERY.SERVICE.NAME}\r\nDevice service port: {DISCOVERY.SERVICE.PORT}\r\nDevice service status: {DISCOVERY.SERVICE.STATUS}\r\nDevice service uptime: {DISCOVERY.SERVICE.UPTIME}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​2",​ 
 +                    "​recovery":​ "​0",​ 
 +                    "​subject":​ "​Autoregistration:​ {HOST.HOST}",​ 
 +                    "​message":​ "Host name: {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"​ 
 +                } 
 +            ], 
 +            "​parameters":​ []
         },         },
         {         {
             "​mediatypeid":​ "​3",​             "​mediatypeid":​ "​3",​
             "​type":​ "​2",​             "​type":​ "​2",​
-            "description": "​SMS",​+            "name": "​SMS",​
             "​smtp_server":​ "",​             "​smtp_server":​ "",​
             "​smtp_helo":​ "",​             "​smtp_helo":​ "",​
Line 100: Line 139:
             "​username":​ "",​             "​username":​ "",​
             "​passwd":​ "",​             "​passwd":​ "",​
-            "​status":​ "​0"​+            "​status":​ "​0"​
 +            "​smtp_port":​ "​25",​ 
 +            "​smtp_security":​ "​0",​ 
 +            "​smtp_verify_peer":​ "​0",​ 
 +            "​smtp_verify_host":​ "​0",​ 
 +            "​smtp_authentication":​ "​0",​ 
 +            "​exec_params":​ "",​ 
 +            "​maxsessions":​ "​1",​ 
 +            "​maxattempts":​ "​3",​ 
 +            "​attempt_interval":​ "​10s",​ 
 +            "​content_type":​ "​1",​ 
 +            "​script":​ "",​ 
 +            "​timeout":​ "​30s",​ 
 +            "​process_tags":​ "​0",​ 
 +            "​show_event_menu":​ "​1",​ 
 +            "​event_menu_url":​ "",​ 
 +            "​event_menu_name":​ "",​ 
 +            "​description":​ "",​ 
 +            "​message_templates":​ [ 
 +                { 
 +                    "​eventsource":​ "​0",​ 
 +                    "​recovery":​ "​0",​ 
 +                    "​subject":​ "",​ 
 +                    "​message":​ "​{EVENT.SEVERITY}:​ {EVENT.NAME}\r\nHost:​ {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​0",​ 
 +                    "​recovery":​ "​1",​ 
 +                    "​subject":​ "",​ 
 +                    "​message":​ "​RESOLVED:​ {EVENT.NAME}\r\nHost:​ {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​0",​ 
 +                    "​recovery":​ "​2",​ 
 +                    "​subject":​ "",​ 
 +                    "​message":​ "​{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​1",​ 
 +                    "​recovery":​ "​0",​ 
 +                    "​subject":​ "",​ 
 +                    "​message":​ "​Discovery:​ {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}"​ 
 +                }, 
 +                { 
 +                    "​eventsource":​ "​2",​ 
 +                    "​recovery":​ "​0",​ 
 +                    "​subject":​ "",​ 
 +                    "​message":​ "​Autoregistration:​ {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"​ 
 +                } 
 +            ], 
 +            "​parameters":​ []
         }         }
     ],     ],
Line 113: Line 202:
 ==== Source ==== ==== Source ====
  
-CMediaType::​get() in //frontends/php/api/classes/​CMediaType.php//​.+CMediaType::​get() in //ui/include/​classes/api/services/​CMediaType.php//​.