integer/array mediatype.get(object parameters)
El m¨¦todo permite recuperar tipos de medios seg¨²n los par¨¢metros indicados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. 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 Áú»¢¶Ä²© 7.0.4, 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 | ID/matriz | Devuelve solo los tipos de medios con los ID indicados. |
mediaids | ID/matriz | Devuelve solo los tipos de medios utilizados por el medio indicado. |
userids | ID/matriz | Devuelve solo los tipos de medios utilizados por los usuarios indicados. |
selectActions | query | Devuelve una propiedad actions con las acciones que utilizan el tipo de medio. |
selectMessageTemplates | query | Devuelve una propiedad message_templates con una matriz de mensajes de tipo de medio.Comportamiento de los par¨¢metros: - compatible para usuarios de tipo Superadministrador (desde Áú»¢¶Ä²© 7.0.4) |
selectUsers | query | Devuelve una propiedad users con los usuarios que utilizan el tipo de medio. |
sortfield | cadena/matriz | Ordenar el resultado por las propiedades dadas. Valores posibles: mediatypeid . |
filter | objeto | Devolver solo aquellos resultados que coincidan 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 Áú»¢¶Ä²© 7.0.4): mediatypeid , name , type , status , maxattempts . |
output | query | Propiedades de objeto de tipo de medio que se devolver¨¢n. Desde Áú»¢¶Ä²© 7.0.4, 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 Áú»¢¶Ä²© 7.0.4): 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 |
(entero/matriz)
Devuelve:
countOutput
ha sido usado.Recupere todos los tipos de medios configurados. El siguiente ejemplo devuelve dos tipos de medios:
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "mediatype.get",
&±ç³Ü´Ç³Ù;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ&±ç³Ü´Ç³Ù;: {
"salida": "extender",
"selectMessageTemplates": "extender"
},
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}
Respuesta:
{
"jsonrpc": "2.0",
"resultado": [
{
"mediatypeid": "1",
"tipo": "0",
"nombre Correo Electronico",
"smtp_server": "correo.ejemplo.com",
"smtp_helo": "ejemplo.com",
"smtp_email": "[email protected]",
"exec_path": "",
"gsm_modem": "",
"nombre de usuario": "",
"contrase?a": "",
"estado": "0",
"smtp_port": "25",
"smtp_security": "0",
"smtp_verify_peer": "0",
"smtp_verify_host": "0",
"smtp_authentication": "0",
"maxsesiones": "1",
"maxintentos": "3",
"attempt_interval": "10s",
"message_format": "0",
"guion": "",
"tiempo de espera": "30s",
"etiquetas_proceso": "0",
"show_event_menu": "1",
"event_menu_url": "",
"event_menu_name": "",
&±ç³Ü´Ç³Ù;»å±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "",
"plantillas_mensajes": [
{
"fuente de eventos": "0",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "0",
"subject": "Problema: {EVENT.NAME}",
"message": "El problema comenz¨® a las {EVENT.TIME} el {EVENT.DATE}\r\nNombre del problema: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\nSeveridad: {EVENT.SEVERITY} \r\nDatos operativos: {EVENT.OPDATA}\r\nID del problema original: {EVENT.ID}\r\n{TRIGGER.URL}"
},
{
"fuente de eventos": "0",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "1",
"asunto": "Resuelto: {EVENT.NAME}",
"message": "El problema se resolvi¨® a las {EVENT.RECOVERY.TIME} el {EVENT.RECOVERY.DATE}\r\nNombre del problema: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\nSeveridad : {EVENT.SEVERITY}\r\n\r\nID del problema original: {EVENT.ID}\r\n{TRIGGER.URL}"
},
{
"fuente de eventos": "0",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "2",
"subject": "Problema actualizado: {EVENT.NAME}",
"message": "Problema de {USER.FULLNAME} {EVENT.UPDATE.ACTION} en {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.\r\n{EVENT.UPDATE.MESSAGE}\r\n\ r\nEl estado del problema actual es {EVENT.STATUS}, confirmado: {EVENT.ACK.STATUS}."
},
{
"fuente de eventos": "1",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "0",
"subject": "Descubrimiento: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}",
"message": "Regla de descubrimiento: {DISCOVERY.RULE.NAME}\r\n\r\nIP del dispositivo: {DISCOVERY.DEVICE.IPADDRESS}\r\nDNS del dispositivo: {DISCOVERY.DEVICE.DNS}\r\nEstado del dispositivo : {DISCOVERY.DEVICE.STATUS}\r\nTiempo de actividad del dispositivo: {DISCOVERY.DEVICE.UPTIME}\r\n\r\nNombre del servicio del dispositivo: {DISCOVERY.SERVICE.NAME}\r\nPuerto del servicio del dispositivo: {DISCOVERY.SERVICE .PORT}\r\nEstado del servicio del dispositivo: {DISCOVERY.SERVICE.STATUS}\r\nTiempo de actividad del servicio del dispositivo: {DISCOVERY.SERVICE.UPTIME}"
},
{
"fuente de eventos": "2",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "0",
"subject": "Registro autom¨¢tico: {HOST.HOST}",
"message": "Nombre de host: {HOST.HOST}\r\nIP de host: {HOST.IP}\r\nPuerto de agente: {HOST.PORT}"
}
],
&±ç³Ü´Ç³Ù;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ&±ç³Ü´Ç³Ù;: []
},
{
"mediatypeid": "3",
"tipo 2",
"nombre": "SMS",
"servidor SMTP": "",
"smtp_helo": "",
"smtp_email": "",
"exec_path": "",
"gsm_modem": "/dev/ttyS0",
"nombre de usuario": "",
"contrase?a": "",
"estado": "0",
"smtp_port": "25",
"smtp_security": "0",
"smtp_verify_peer": "0",
"smtp_verify_host": "0",
"smtp_authentication": "0",
"maxsesiones": "1",
"maxintentos": "3",
"attempt_interval": "10s",
"message_format": "1",
"guion": "",
"tiempo de espera": "30s",
"etiquetas_proceso": "0",
"show_event_menu": "1",
"event_menu_url": "",
"event_menu_name": "",
&±ç³Ü´Ç³Ù;»å±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "",
"plantillas_mensajes": [
{
"fuente de eventos": "0",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "0",
"sujeto": "",
"mensaje": "{EVENT.SEVERITY}: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
},
{
"fuente de eventos": "0",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "1",
"sujeto": "",
"message": "RESUELTO: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
},
{
"fuente de eventos": "0",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "2",
"sujeto": "",
"message": "Problema de {USER.FULLNAME} {EVENT.UPDATE.ACTION} en {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}"
},
{
"fuente de eventos": "1",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "0",
"sujeto": "",
"mensaje": "Descubrimiento: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}"
},
{
"fuente de eventos": "2",
&±ç³Ü´Ç³Ù;°ù±ð³¦³Ü±è±ð°ù²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: "0",
"sujeto": "",
"message": "Registro autom¨¢tico: {HOST.HOST}\r\nIP del host: {HOST.IP}\r\nPuerto del agente: {HOST.PORT}"
}
],
&±ç³Ü´Ç³Ù;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ&±ç³Ü´Ç³Ù;: []
}
],
&±ç³Ü´Ç³Ù;¾±»å±ð²Ô³Ù¾±´Ú¾±³¦²¹³¦¾±¨®²Ô&±ç³Ü´Ç³Ù;: 1
}
As an Admin type user, retrieve all media types that are enabled, with users that use these media types. The following example returns two media types:
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend",
"filter": {
"status": 0
},
"selectUsers": "extend"
},
"id": 1
}
Response:
{
"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",
"userdirectoryid": "0",
"ts_provisioned": "0"
}
]
},
{
"mediatypeid": "3",
"type": "2",
"name": "SMS",
"status": "0",
"description": "",
"maxattempts": "3",
"users": []
}
],
"id": 1
}
El siguiente ejemplo devuelve tres tipos de medios:
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": ["mediatypeid", "name", "parameters"],
"filter": {
"type": [1, 4]
}
},
"id": 1
}
Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "10",
"name": "Script with parameters",
"parameters": [
{
"sortorder": "0",
"value": "{ALERT.SENDTO}"
},
{
"sortorder": "1",
"value": "{EVENT.NAME}"
},
{
"sortorder": "2",
"value": "{ALERT.MESSAGE}"
},
{
"sortorder": "3",
"value": "Áú»¢¶Ä²© alert"
}
]
},
{
"mediatypeid": "13",
"name": "Script without parameters",
"parameters": []
},
{
"mediatypeid": "11",
"name": "Webhook",
"parameters": [
{
"name": "alert_message",
"value": "{ALERT.MESSAGE}"
},
{
"name": "event_update_message",
"value": "{EVENT.UPDATE.MESSAGE}"
},
{
"name": "host_name",
"value": "{HOST.NAME}"
},
{
"name": "trigger_description",
"value": "{TRIGGER.DESCRIPTION}"
},
{
"name": "trigger_id",
"value": "{TRIGGER.ID}"
},
{
"name": "alert_source",
"value": "Áú»¢¶Ä²©"
}
]
}
],
"id": 1
}
CMediaType::get() en ui/include/classes/api/services/CMediaType.php.