integer/array mediatype.get(object parameters)
The method allows to retrieve media types according to the given parameters.
(object)
Parameters defining the desired output.
The method supports the following parameters.
Parameter | Type | Description |
---|---|---|
mediatypeids | string/array | Return only media types with the given IDs. |
mediaids | string/array | Return only media types used by the given media. |
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. |
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 reference commentary. |
editable | boolean | |
excludeSearch | flag | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | flag | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | flag |
(integer/array)
Returns either:
countOutput
parameter has been used.Retrieve all configured media types.
Request:
{ "jsonrpc": "2.0", "method": "mediatype.get", "params": { "output": "extend" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": [ { "mediatypeid": "1", "type": "0", "description": "Email", "smtp_server": "mail.company.com", "smtp_helo": "company.com", "smtp_email": "[email protected]", "exec_path": "", "gsm_modem": "", "username": "", "passwd": "", "status": "0", "smtp_port": "25", "smtp_security": "0", "smtp_verify_peer": "0", "smtp_verify_host": "0", "smtp_authentication": "0", "exec_params": "" }, { "mediatypeid": "2", "type": "3", "description": "Jabber", "smtp_server": "", "smtp_helo": "", "smtp_email": "", "exec_path": "", "gsm_modem": "", "username": "[email protected]", "passwd": "zabbix", "status": "0", "smtp_port": "25", "smtp_security": "0", "smtp_verify_peer": "0", "smtp_verify_host": "0", "smtp_authentication": "0", "exec_params": "" }, { "mediatypeid": "3", "type": "2", "description": "SMS", "smtp_server": "", "smtp_helo": "", "smtp_email": "", "exec_path": "", "gsm_modem": "/dev/ttyS0", "username": "", "passwd": "", "status": "0", "smtp_port": "25", "smtp_security": "0", "smtp_verify_peer": "0", "smtp_verify_host": "0", "smtp_authentication": "0", "exec_params": "" } ], "id": 1 }
CMediaType::get() in frontends/php/include/classes/api/services/CMediaType.php.