Documentation
Table of Contents
mediatype.get
Description
integer/array mediatype.get(object parameters)
La méthode permet de récupérer des types de média en fonction des paramètres donnés.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| mediatypeids | string/array | Renvoie uniquement les types de média avec les identifiants donnés. |
| mediaids | string/array | Renvoie uniquement les types de média utilisés par le média donné. |
| userids | string/array | Renvoie uniquement les types de média utilisés par les utilisateurs donnés. |
| selectUsers | query | Renvoie les utilisateurs qui utilisent le type de média dans la propriété users. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : mediatypeid. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération de types de média
Récupérer tous les types de média configurés.
Requête :
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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
}Voir également
Source
CMediaType::get() dans frontends/php/include/classes/api/services/CMediaType.php.