The method allows to retrieve media types according to the given parameters.

    Parameters

    (object) Parameters defining the desired output.

    (integer/array) Returns either:

    • an array of objects;

    Examples

    Retrieving media types

    Retrieve all configured media types.

    Request:

    1. {
    2.     "jsonrpc": "2.0",
    3.     "result": [
    4.         {
    5.             "mediatypeid": "1",
    6.             "type": "0",
    7.             "name": "Email",
    8.             "smtp_server": "mail.example.com",
    9.             "smtp_helo": "example.com",
    10.             "smtp_email": "[email protected]",
    11.             "exec_path": "",
    12.             "gsm_modem": "",
    13.             "username": "",
    14.             "passwd": "",
    15.             "status": "0",
    16.             "smtp_port": "25",
    17.             "smtp_security": "0",
    18.             "smtp_verify_peer": "0",
    19.             "smtp_verify_host": "0",
    20.             "smtp_authentication": "0",
    21.             "exec_params": "",
    22.             "maxsessions": "1",
    23.             "maxattempts": "3",
    24.             "attempt_interval": "10s",
    25.             "content_type": "0",
    26.             "script": "",
    27.             "timeout": "30s",
    28.             "process_tags": "0",
    29.             "show_event_menu": "1",
    30.             "event_menu_url": "",
    31.             "event_menu_name": "",
    32.             "description": "",
    33.             "message_templates": [
    34.                 {
    35.                     "eventsource": "0",
    36.                     "recovery": "0",
    37.                     "subject": "Problem: {EVENT.NAME}",
    39.                 {
    40.                     "eventsource": "0",
    41.                     "recovery": "1",
    42.                     "subject": "Resolved: {EVENT.NAME}",
    43.                     "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}"
    44.                 },
    45.                 {
    46.                     "eventsource": "0",
    47.                     "recovery": "2",
    48.                     "subject": "Updated problem: {EVENT.NAME}",
    49.                     "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}."
    50.                 },
    51.                 {
    52.                     "eventsource": "1",
    53.                     "recovery": "0",
    54.                     "subject": "Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}",
    55.                     "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}"
    56.                 },
    57.                 {
    58.                     "eventsource": "2",
    59.                     "recovery": "0",
    60.                     "subject": "Autoregistration: {HOST.HOST}",
    61.                     "message": "Host name: {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"
    62.                 }
    63.             ],
    64.             "parameters": []
    65.         },
    66.         {
    67.             "mediatypeid": "3",
    68.             "type": "2",
    69.             "name": "SMS",
    70.             "smtp_server": "",
    71.             "smtp_helo": "",
    72.             "smtp_email": "",
    73.             "exec_path": "",
    74.             "gsm_modem": "/dev/ttyS0",
    75.             "username": "",
    76.             "passwd": "",
    77.             "status": "0",
    78.             "smtp_port": "25",
    79.             "smtp_security": "0",
    80.             "smtp_verify_peer": "0",
    81.             "smtp_verify_host": "0",
    82.             "smtp_authentication": "0",
    83.             "exec_params": "",
    84.             "maxattempts": "3",
    85.             "attempt_interval": "10s",
    86.             "content_type": "1",
    87.             "script": "",
    88.             "timeout": "30s",
    89.             "process_tags": "0",
    90.             "show_event_menu": "1",
    91.             "event_menu_url": "",
    92.             "event_menu_name": "",
    93.             "description": "",
    94.             "message_templates": [
    95.                 {
    96.                     "eventsource": "0",
    97.                     "recovery": "0",
    98.                     "subject": "",
    99.                     "message": "{EVENT.SEVERITY}: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
    100.                 },
    101.                 {
    102.                     "eventsource": "0",
    103.                     "recovery": "1",
    104.                     "subject": "",
    105.                     "message": "RESOLVED: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
    106.                 },
    107.                 {
    108.                     "eventsource": "0",
    109.                     "recovery": "2",
    110.                     "subject": "",
    111.                     "message": "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}"
    112.                 },
    113.                 {
    114.                     "eventsource": "1",
    115.                     "recovery": "0",
    116.                     "subject": "",
    117.                     "message": "Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}"
    118.                 },
    119.                 {
    120.                     "eventsource": "2",
    121.                     "recovery": "0",
    122.                     "subject": "",
    123.                     "message": "Autoregistration: {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"
    124.                 }
    125.             ],
    126.             "parameters": []
    127.         }
    128.     ],

    Source

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