Documentation
Table of Contents
mediatype.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array mediatype.get(object parameters)
El m¨¦todo permite recuperar tipos de medios seg¨²n los par¨¢metros indicados.
Este m¨¦todo solo est¨¢ disponible para los tipos de usuario Admin y Super admin. Los permisos para llamar al m¨¦todo se pueden revocar en la configuraci¨®n de roles de usuario. Consulte Roles de usuario para obtener m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(object) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
Desde Áú»¢¶Ä²© 6.0.34, al solicitar informaci¨®n relacionada con el usuario sobre los tipos de medios, los usuarios de tipo Admin pueden recuperar solo datos sobre su propio usuario. Para ver un ejemplo, consulte Recuperaci¨®n de tipos de medios como Admin.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| mediatypeids | cadena/matriz | Devuelve solo los tipos de medios con los ID indicados. |
| mediaids | cadena/matriz | Devuelve solo los tipos de medios utilizados por el medio indicado. |
| userids | cadena/matriz | Devuelve solo los tipos de medios utilizados por los usuarios indicados. |
| selectMessageTemplates | query | Devuelve una propiedad message_templates con una matriz de mensajes de tipo de medio. Desde Áú»¢¶Ä²© 6.0.34, este par¨¢metro solo es compatible con usuarios de tipo Superadministrador. |
| selectUsers | query | Devuelve una propiedad users con los usuarios que utilizan el tipo de medio. |
| sortfield | cadena/matriz | Ordena el resultado por las propiedades indicadas. Los valores posibles son: mediatypeid. |
| filter | objeto | Devuelve solo aquellos resultados que coinciden exactamente con el filtro dado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor ¨²nico o una matriz de valores con los que comparar. Propiedades admitidas para usuarios de tipo Superadministrador: todas las propiedades de objeto de tipo multimedia, excepto las propiedades de tipo de datos text.Propiedades admitidas para usuarios de tipo Administrador (desde Áú»¢¶Ä²© 6.0.34): mediatypeid, name, type, status, maxattempts. |
| output | query | Propiedades de objeto de tipo de medio que se devolver¨¢n. Desde Áú»¢¶Ä²© 6.0.34, los usuarios de tipo Admin pueden recuperar ¨²nicamente las siguientes propiedades de objeto de tipo de medio: mediatypeid, name, type, status, maxattempts. Para ver un ejemplo, consulte Recuperaci¨®n de tipos de medios como Admin.Valor predeterminado: extend. |
| search | objeto | Devuelve resultados que coinciden con el patr¨®n indicado (sin distinguir entre may¨²sculas y min¨²sculas). Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas para buscar. Si no se proporcionan opciones adicionales, se realizar¨¢ una b¨²squeda LIKE "%¡%".Propiedades admitidas para usuarios de tipo Superadministrador: todas las propiedades de objeto de tipo de medio de tipo de datos string y text.Propiedades admitidas para usuarios de tipo Administrador (desde Áú»¢¶Ä²© 6.0.34): name, description. |
| countOutput | booleano | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| preservekeys | booleano | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperando tipos de medios
Recuperar todos los tipos de medios configurados.
Solicitud:
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend",
"selectMessageTemplates": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"smtp_server": "mail.example.com",
"smtp_helo": "example.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": "",
"maxsessions": "1",
"maxattempts": "3",
"attempt_interval": "10s",
"content_type": "0",
"script": "",
"timeout": "30s",
"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",
"type": "2",
"name": "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": "",
"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": []
}
],
"id": 1
}Recuperaci¨®n de tipos de medios como Admin
Como usuario de tipo Admin, recupera todos los tipos de medios que est¨¦n habilitados, con usuarios que utilicen estos tipos de medios. El siguiente ejemplo devuelve dos tipos de medios:
- tipo de medio de correo electr¨®nico con un usuario (desde Áú»¢¶Ä²© 6.0.34, solo el usuario del tipo Admin);
- tipo de medio de SMS sin usuarios.
Solicitud:
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend",
"filter": {
"status": 0
},
"selectUsers": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"status": "0",
"description": "",
"maxattempts": "3",
"users": [
{
"userid": "3",
"username": "database-admin",
"name": "John",
"surname": "Doe",
"url": "",
"autologin": "0",
"autologout": "0",
"lang": "default",
"refresh": "30s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "2"
}
]
},
{
"mediatypeid": "3",
"type": "2",
"name": "SMS",
"status": "0",
"description": "",
"maxattempts": "3",
"users": []
}
],
"id": 1
}Ver tambi¨¦n
Fuente
CMediaType::get() en ui/include/classes/api/services/CMediaType.php.