[comment]: # ({c7072ca6-c7072ca6}) # triggerprototype.get [comment]: # ({/c7072ca6-c7072ca6}) [comment]: # ({c69d59e4-12701833}) ### Descripción `integer/array triggerprototype.get(object parameters)` El método permite recuperar prototipos de trigger según los parámetros dados. ::: noteclassic Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte [Roles de usuario](/manual/web_interface/frontend_sections/users/user_roles) para más información. ::: [comment]: # ({/c69d59e4-12701833}) [comment]: # ({5c9b64fe-14171778}) ### Parámetros `(object)` Parámetros que definen la salida deseada. El método admite los siguientes parámetros. |Parámetro|[Tipo](/manual/api/reference_commentary#data-types)|Descripción| |--|--|------| |active|flag|Devolver solo prototipos de trigger habilitados que pertenezcan a hosts monitorizados.| |discoveryids|ID/array|Devolver solo prototipos de trigger que pertenezcan a las reglas LLD indicadas.| |functions|string/array|Devolver solo triggers que utilicen las funciones indicadas.

Consulte la página de [Funciones soportadas](/manual/config/triggers/expression#functions) para ver la lista de funciones soportadas.| |group|string|Devolver solo prototipos de trigger que pertenezcan a hosts o templates de los grupos de hosts o grupos de templates con el nombre indicado.| |groupids|ID/array|Devolver solo prototipos de trigger que pertenezcan a hosts o templates de los grupos de hosts o grupos de templates indicados.| |host|string|Devolver solo prototipos de trigger que pertenezcan a hosts con el nombre indicado.| |hostids|ID/array|Devolver solo prototipos de trigger que pertenezcan a los hosts indicados.| |inherited|boolean|Si se establece en `true`, devolver solo prototipos de trigger heredados de un template.| |maintenance|boolean|Si se establece en `true`, devolver solo prototipos de trigger habilitados que pertenezcan a hosts en mantenimiento.| |min\_severity|integer|Devolver solo prototipos de trigger con una severidad mayor o igual a la severidad indicada.| |monitored|flag|Devolver solo prototipos de trigger habilitados que pertenezcan a hosts monitorizados y contengan solo items habilitados.| |templated|boolean|Si se establece en `true`, devolver solo prototipos de trigger que pertenezcan a templates.| |templateids|ID/array|Devolver solo prototipos de trigger que pertenezcan a los templates indicados.| |triggerids|ID/array|Devolver solo prototipos de trigger con los IDs indicados.| |expandExpression|flag|Expandir funciones y macros en la expresión del trigger.| |selectDependencies|query|Devolver prototipos de trigger y triggers de los que depende el prototipo de trigger en la propiedad `dependencies`.| |selectDiscoveryData|query|Devolver una propiedad `discoveryData` con los datos del objeto de descubrimiento del prototipo de trigger. El objeto de descubrimiento del prototipo de trigger vincula un prototipo de trigger descubierto a un prototipo de trigger del que se descubrió.

Tiene las siguientes propiedades:
`parent_triggerid` - `(ID)` ID del prototipo de trigger del que se ha creado el prototipo de trigger;
`status` - `(int)` estado de descubrimiento del prototipo de trigger:
0 - *(por defecto)* el prototipo de trigger está descubierto,
1 - el prototipo de trigger ya no está descubierto;
`ts_delete` - `(timestamp)` hora en la que se eliminará un prototipo de trigger que ya no se descubre;
`ts_disable` - `(timestamp)` hora en la que se deshabilitará un prototipo de trigger que ya no se descubre;
`disable_source` - `(int)` indicador de si el prototipo de trigger fue deshabilitado por una regla LLD o manualmente:
0 - *(por defecto)* deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.| |selectDiscoveryRule|query|Devolver la [regla LLD](/manual/api/reference/discoveryrule/object) a la que pertenece el prototipo de trigger en la propiedad `discoveryRule`.| |selectDiscoveryRulePrototype|query|Devolver una propiedad [`discoveryRulePrototype`](/manual/api/reference/discoveryruleprototype/object) con el prototipo de regla LLD principal al que pertenece el prototipo de trigger.| |selectFunctions|query|Devolver las funciones utilizadas en el prototipo de trigger en la propiedad `functions`.

Los objetos de función representan las funciones utilizadas en la expresión del trigger y tienen las siguientes propiedades:
`functionid` - `(ID)` ID de la función;
`itemid` - `(ID)` ID del item utilizado en la función;
`function` - `(string)` nombre de la función;
`parameter` - `(string)` parámetro pasado a la función. El parámetro de consulta se reemplaza por el símbolo `$` en la cadena devuelta.| |selectHostGroups|query|Devolver los grupos de hosts a los que pertenece el prototipo de trigger en la propiedad [`hostgroups`](/manual/api/reference/hostgroup/object).| |selectHosts|query|Devolver los hosts a los que pertenece el prototipo de trigger en la propiedad [`hosts`](/manual/api/reference/host/object).| |selectInheritedTags|query|Devolver una propiedad [`inheritedTags`](/manual/api/reference/triggerprototype/object#trigger-prototype-tag) con las etiquetas heredadas de templates, templates vinculados y hosts, y de prototipos de item referenciados en expresiones de trigger o de recuperación.| |selectItems|query|Devolver los items y prototipos de item utilizados por el prototipo de trigger en la propiedad [`items`](/manual/api/reference/item/object).| |selectTags|query|Devolver las etiquetas del prototipo de trigger en la propiedad [`tags`](/manual/api/reference/triggerprototype/object#trigger-prototype-tag).| |selectTemplateGroups|query|Devolver los grupos de templates a los que pertenece el prototipo de trigger en la propiedad [`templategroups`](/manual/api/reference/templategroup/object).| |filter|object|Devolver solo aquellos resultados que coincidan exactamente con el filtro indicado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar.

No admite propiedades del tipo de datos `text` [data type](/manual/api/reference_commentary#data-types).

Admite propiedades adicionales:
`host` - nombre técnico del host al que pertenece el prototipo de trigger;
`hostid` - ID del host al que pertenece el prototipo de trigger.| |limitSelects|integer|Limita el número de registros devueltos por subconsultas.

Se aplica a las siguientes subconsultas:
`selectHosts` - los resultados se ordenarán por `host`.| |sortfield|string/array|Ordenar el resultado por las propiedades indicadas.

Valores posibles: `triggerid`, `description`, `status`, `priority`, `discovered`.| |countOutput|boolean|Estos parámetros se describen en el [comentario de referencia](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/5c9b64fe-14171778}) [comment]: # ({07ca11ca-7223bab1}) ### Valores de retorno `(integer/array)` Devuelve: - un array de objetos; - el número de objetos recuperados, si se ha utilizado el parámetro `countOutput`. [comment]: # ({/07ca11ca-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Ejemplos [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({582baf6f-81de28c1}) #### Recuperar prototipos de trigger de una regla LLD Recuperar todos los prototipos de trigger y sus funciones de una regla LLD. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "triggerprototype.get", "params": { "output": "extend", "selectFunctions": "extend", "discoveryids": "22450" }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": [ { "triggerid": "13272", "expression": "{12598}<20", "description": "Free inodes is less than 20% on volume {#FSNAME}", "url": "", "status": "0", "value": "0", "priority": "2", "lastchange": "0", "comments": "", "error": "", "templateid": "0", "type": "0", "state": "0", "flags": "2", "recovery_mode": "0", "recovery_expression": "", "correlation_mode": "0", "correlation_tag": "", "manual_close": "0", "opdata": "", "discover": "0", "event_name": "", "uuid": "6ce467d05e8745409a177799bed34bb3", "url_name": "", "functions": [ { "functionid": "12598", "itemid": "22454", "triggerid": "13272", "parameter": "$", "function": "last" } ] }, { "triggerid": "13266", "expression": "{13500}<20", "description": "Free disk space is less than 20% on volume {#FSNAME}", "url": "", "status": "0", "value": "0", "priority": "2", "lastchange": "0", "comments": "", "error": "", "templateid": "0", "type": "0", "state": "0", "flags": "2", "recovery_mode": "0", "recovery_expression": "", "correlation_mode": "0", "correlation_tag": "", "manual_close": "0", "opdata": "", "discover": "0", "event_name": "", "uuid": "74a1fc62bfe24b7eabe4e244c70dc384", "url_name": "", "functions": [ { "functionid": "13500", "itemid": "22686", "triggerid": "13266", "parameter": "$", "function": "last" } ] } ], "id": 1 } ``` [comment]: # ({/582baf6f-81de28c1}) [comment]: # ({af95a04d-2cb80f2d}) #### Recuperar una prototipo de disparador específica con etiquetas [Solicitud](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "triggerprototype.get", "params": { "output": [ "triggerid", "description" ], "selectTags": "extend", "triggerids": [ "17373" ] }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": [ { "triggerid": "17373", "description": "El espacio libre en disco es menor al 20% en el volumen {#FSNAME}", "tags": [ { "tag": "volume", "value": "{#FSNAME}" }, { "tag": "type", "value": "{#FSTYPE}" } ] } ], "id": 1 } ``` [comment]: # ({/af95a04d-2cb80f2d}) [comment]: # ({cf0cf439-222d46a0}) ### Ver también - [Regla de descubrimiento](/manual/api/reference/discoveryrule/object#discovery-rule) - [Item](/manual/api/reference/item/object#item) - [Host](/manual/api/reference/host/object#host) - [Grupo de hosts](/manual/api/reference/hostgroup/object#host-group) - [Grupo de templates](/manual/api/reference/templategroup/object#template-group) [comment]: # ({/cf0cf439-222d46a0}) [comment]: # ({526ca55d-1136c1c7}) ### Fuente CTriggerPrototype::get() en *ui/include/classes/api/services/CTriggerPrototype.php*. [comment]: # ({/526ca55d-1136c1c7})