[comment]: # ({2293b018-2293b018})
# action.get
[comment]: # ({/2293b018-2293b018})
[comment]: # ({4ef8f0ed-42834e1b})
### Descrição
`integer/array action.get(object parameters)`
O método permite recuperar ações de acordo com os parâmetros fornecidos.
::: noteclassic
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::
[comment]: # ({/4ef8f0ed-42834e1b})
[comment]: # ({5a2121c5-f6c19c90})
### Parâmetros
`(object)` Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|actionids|ID/array|Retornar apenas ações com os IDs fornecidos.|
|groupids|ID/array|Retornar apenas ações que usam os grupos de hosts fornecidos nas condições da ação.|
|hostids|ID/array|Retornar apenas ações que usam os hosts fornecidos nas condições da ação.|
|triggerids|ID/array|Retornar apenas ações que usam os triggers fornecidos nas condições da ação.|
|mediatypeids|ID/array|Retornar apenas ações que usam os tipos de mídia fornecidos para enviar mensagens.|
|usrgrpids|ID/array|Retornar apenas ações que estão configuradas para enviar mensagens para os grupos de usuários fornecidos.|
|userids|ID/array|Retornar apenas ações que estão configuradas para enviar mensagens para os usuários fornecidos.|
|scriptids|ID/array|Retornar apenas ações que estão configuradas para executar os scripts fornecidos.|
|selectFilter|query|Retornar uma propriedade [`filter`](/manual/api/reference/action/object#action-filter) com o filtro de condição da ação.|
|selectOperations|query|Retornar uma propriedade [`operations`](/manual/api/reference/action/object#action-operation) com as operações da ação.|
|selectRecoveryOperations|query|Retornar uma propriedade [`recovery_operations`](/manual/api/reference/action/object#action-recovery-operation) com as operações de recuperação da ação.|
|selectUpdateOperations|query|Retornar uma propriedade [`update_operations`](/manual/api/reference/action/object#action-update-operation) com as operações de atualização da ação.|
|sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.
Valores possíveis: `actionid`, `name`, `status`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/manual/api/reference_commentary#common-get-method-parameters).|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
[comment]: # ({/5a2121c5-f6c19c90})
[comment]: # ({7223bab1-7223bab1})
### Valores de retorno
`(integer/array)` Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro `countOutput`
tiver sido usado.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Exemplos
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({dabc835c-f7d2e806})
#### Recuperar ações de trigger
Recupera todas as ações de trigger configuradas juntamente com as condições e operações da ação.
[Requisição](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectRecoveryOperations": "extend",
"selectUpdateOperations": "extend",
"selectFilter": "extend",
"filter": {
"eventsource": 0
}
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"actionid": "3",
"name": "Report problems to Zabbix administrators",
"eventsource": "0",
"status": "1",
"esc_period": "1h",
"pause_suppressed": "1",
"filter": {
"evaltype": "0",
"formula": "",
"conditions": [],
"eval_formula": ""
},
"operations": [
{
"operationid": "3",
"actionid": "3",
"operationtype": "0",
"esc_period": "0",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opconditions": [],
"opmessage": [
{
"default_msg": "1",
"subject": "",
"message": "",
"mediatypeid" => "0"
}
],
"opmessage_grp": [
{
"usrgrpid": "7"
}
]
}
],
"recovery_operations": [
{
"operationid": "7",
"actionid": "3",
"operationtype": "11",
"evaltype": "0",
"opconditions": [],
"opmessage": {
"default_msg": "0",
"subject": "{TRIGGER.STATUS}: {TRIGGER.NAME}",
"message": "Trigger: {TRIGGER.NAME}\r\nTrigger state: {TRIGGER.STATUS}\r\nTrigger severity: {TRIGGER.SEVERITY}\r\nTrigger URL: {TRIGGER.URL}\r\n\r\nItem values:\r\n\r\n1. {ITEM.NAME1} ({HOST.NAME1}:{ITEM.KEY1}): {ITEM.VALUE1}\r\n2. {ITEM.NAME2} ({HOST.NAME2}:{ITEM.KEY2}): {ITEM.VALUE2}\r\n3. {ITEM.NAME3} ({HOST.NAME3}:{ITEM.KEY3}): {ITEM.VALUE3}\r\n\r\nOriginal event ID: {EVENT.ID}",
"mediatypeid": "0"
}
}
],
"update_operations": [
{
"operationid": "31",
"operationtype": "12",
"evaltype": "0",
"opmessage": {
"default_msg": "1",
"subject": "",
"message": "",
"mediatypeid": "0"
}
},
{
"operationid": "32",
"operationtype": "0",
"evaltype": "0",
"opmessage": {
"default_msg": "0",
"subject": "Updated: {TRIGGER.NAME}",
"message": "{USER.FULLNAME} updated problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} with the following message:\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nCurrent problem state is {EVENT.STATUS}",
"mediatypeid": "1"
},
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage_usr": []
},
{
"operationid": "33",
"operationtype": "1",
"evaltype": "0",
"opcommand": {
"scriptid": "3"
},
"opcommand_hst": [
{
"hostid": "10084"
}
],
"opcommand_grp": []
}
]
}
],
"id": 1
}
```
[comment]: # ({/dabc835c-f7d2e806})
[comment]: # ({931fc05d-d96da9cf})
#### Recuperar ações de descoberta
Recupere todas as ações de descoberta configuradas juntamente com as condições e operações da ação. O filtro usa o tipo de avaliação "and", portanto, a propriedade `formula` está vazia e `eval_formula` é gerada automaticamente.
[Requisição](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectFilter": "extend",
"filter": {
"eventsource": 1
}
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"actionid": "2",
"name": "Auto discovery. Linux servers.",
"eventsource": "1",
"status": "1",
"esc_period": "0s",
"pause_suppressed": "1",
"filter": {
"evaltype": "0",
"formula": "",
"conditions": [
{
"conditiontype": "10",
"operator": "0",
"value": "0",
"value2": "",
"formulaid": "B"
},
{
"conditiontype": "8",
"operator": "0",
"value": "9",
"value2": "",
"formulaid": "C"
},
{
"conditiontype": "12",
"operator": "2",
"value": "Linux",
"value2": "",
"formulaid": "A"
}
],
"eval_formula": "A and B and C"
},
"operations": [
{
"operationid": "1",
"actionid": "2",
"operationtype": "6",
"esc_period": "0s",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opconditions": [],
"optemplate": [
{
"templateid": "10001"
}
]
},
{
"operationid": "2",
"actionid": "2",
"operationtype": "4",
"esc_period": "0s",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opconditions": [],
"opgroup": [
{
"groupid": "2"
}
]
}
]
}
],
"id": 1
}
```
[comment]: # ({/931fc05d-d96da9cf})
[comment]: # ({7ab40057-755496f7})
### Veja também
- [Filtro de ação](object#action-filter)
- [Operação de ação](object#action-operation)
[comment]: # ({/7ab40057-755496f7})
[comment]: # ({025b824e-025b824e})
### Fonte
CAction::get() em *ui/include/classes/api/services/CAction.php*.
[comment]: # ({/025b824e-025b824e})