Sidebar

获取

Description 描述

integer/array mediatype.get(object parameters)

The method allows to retrieve media types according to the given parameters. 此方法用于检索给定参数和符合条件的媒介类型

Parameters 参数

(object) Parameters defining the desired output. (object) 定义所需输出的参数。

The method supports the following parameters. 此方法支持一下参数。

Parameter Type Description
mediatypeids string/array Return only media types with the given IDs. 仅返回所给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. 返回users属性中使用媒介类型的用户。
sortfield string/array Sort the result by the given properties.

Possible values are: mediatypeid. 根据给定的属性对结果进行排序。

可能的值是: mediatypeid
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary. 这些参数对于所有的“get”方法都是通用的reference commentary
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Return values

(integer/array) Returns either:返回如下:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.
  • 一个对象数组;
  • 如果使用了“countOutput”参数,则检索对象的计数。

Examples 示例如下

Retrieving media types 检索媒介类型

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",
                   "maxsessions": "1",
                   "maxattempts": "7",
                   "attempt_interval": "10s"
               },
               {
                   "mediatypeid": "2",
                   "type": "3",
                   "description": "Jabber",
                   "smtp_server": "",
                   "smtp_helo": "",
                   "smtp_email": "",
                   "exec_path": "",
                   "gsm_modem": "",
                   "username": "[email protected]",
                   "passwd": "zabbix",
                   "status": "0",
                   "maxsessions": "1",
                   "maxattempts": "7",
                   "attempt_interval": "10s"
               },
               {
                   "mediatypeid": "3",
                   "type": "2",
                   "description": "SMS",
                   "smtp_server": "",
                   "smtp_helo": "",
                   "smtp_email": "",
                   "exec_path": "",
                   "gsm_modem": "/dev/ttyS0",
                   "username": "",
                   "passwd": "",
                   "status": "0",
                   "maxsessions": "1",
                   "maxattempts": "7",
                   "attempt_interval": "10s"
               }
           ],
           "id": 1
       }

See also

Source

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