Você está visualizando a documentação da versão de desenvolvimento, que pode estar incompleta.
Esta página foi traduzida automaticamente. Se você notar um erro, selecione-o e pressione Ctrl+Enter para reportá-lo aos editores.

action.update

Descrição

object action.update(object/array actions)

Este método permite atualizar ações existentes.

Este método está disponível apenas para os tipos de usuário Admin e Super admin. 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 para mais informações.

Parâmetros

(object/array) Propriedades da ação a serem atualizadas.

A propriedade actionid deve ser definida para cada ação, todas as outras propriedades são opcionais. Somente as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas.

Além das propriedades padrão da ação, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
filter object Objeto filtro de ação para substituir o filtro atual.
operations array Operações de ação para substituir as operações existentes.
recovery_operations array Operações de recuperação de ação para substituir as operações de recuperação existentes.

Comportamento do parâmetro:
- suportado se eventsource do objeto Action estiver definido como "evento criado por um trigger", "evento interno" ou "evento criado na atualização do status do serviço"
update_operations array Operações de atualização de ação para substituir as operações de atualização existentes.

Comportamento do parâmetro:
- suportado se eventsource do objeto Action estiver definido como "evento criado por um trigger" ou "evento criado na atualização do status do serviço"

Valores de retorno

(object) Retorna um objeto contendo os IDs das ações atualizadas na propriedade actionids.

Exemplos

Desabilitar ação

Desabilita uma ação, ou seja, define seu status como "1".

Requisição:

{
           "jsonrpc": "2.0",
           "method": "action.update",
           "params": {
               "actionid": "2",
               "status": "1"
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": {
               "actionids": [
                   "2"
               ]
           },
           "id": 1
       }

Veja também

Origem

CAction::update() em ui/include/classes/api/services/CAction.php.