---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Parâmetros da ação

# Parâmetros da ação {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

Os parâmetros de ação são separados e diferentes dos parâmetros de dados porque especificam a ação a ser executada quando o parâmetro de objeto JSON faz parte de uma solicitação HTTP GET ou POST.

Os parâmetros também podem ser especificados como um campo no objeto JSON fornecido. Eles têm o efeito de acionar uma ação no caso de `sysparm_action`ou filtrar os resultados de uma atualização ou consulta no caso de `sysparm_query`.

## sysparm_action

A seguir estão os valores válidos para `sysparm_action` e a ação correspondente acionada pela API.{#c_ActionParameters__table_ess_ybj_bp__entry__2}

| Resumo do Método | Descrição |
|-|-|
| getKeys | Consulte a tabela de destino usando uma cadeia de caracteres de consulta codificada e retorne uma lista delimitada por vírgulas de valores de `sys_id`. |
| obterRegistros | Consulte a tabela de destino usando uma cadeia de caracteres de consulta codificada e retorne todos os registros correspondentes e seus campos. |
| obter | Consulte um único registro da tabela de destino especificando o `sys_id` no parâmetro de URL `sysparm_sys_id` e retorne o registro e seus campos. |
[Tabela 1. Recuperação de dados]

{#c_ActionParameters__table_ess_ybj_bp} {#c_ActionParameters__table_jtf_3cj_bp__entry__2}

| Resumo do Método | Descrição |
|-|-|
| inserir | Crie um ou mais novos registros para a tabela de destino no URL. |
| inserirvários | Crie vários novos registros para a tabela de destino na URL. |
| atualizar | Atualize os registros existentes na tabela de destino no URL, filtrados por uma cadeia de caracteres de consulta codificada. |
| excluirRegistro | Exclua um registro da tabela de destino na URL especificando seu `sys_id` no parâmetro de URL `sysparm_sys_id`. |
| excluirvários | Exclua vários registros da tabela de destino no URL, filtrados por uma cadeia de caracteres de consulta codificada. |
[Tabela 2. Modificação de dados]

{#c_ActionParameters__table_jtf_3cj_bp}

## sysparm_query

Especifique uma cadeia de caracteres de consulta codificada a ser usada no valor get, getRecords, update ou deleteMultiplesysparm_action.

## sysparm_view

Especifique uma exibição de formulário para personalizar os valores de retorno para chamadas de função get e getRecords. Ao usar uma exibição, a consulta retorna somente os campos definidos na exibição, incluindo valores referenciados. Se não houver um nome de exibição ou se o nome de exibição não for válido, a consulta retornará todos os nomes de campo marcados como ativos no dicionário.

## sysparm_sys_id

Especifique um sys_id de destino durante uma chamada de função de obtenção ou exclusão (valor`sysparm_action` ).

## sysparm_record_count

Especifique um valor inteiro para limitar o número de registros recuperados para esta solicitação. Observe que este valor é limitado pela propriedade do sistema glide.processor.json.row_limit.

## exibirvalor

Obtenha o valor de exibição de um campo de referência, se houver algum no registro. Por exemplo, o registro de Incidente pode ter um campo `assigned_to` que é uma referência a um registro de usuário. Em vez de enviar o sys_id do registro do usuário, o nome de usuário é enviado.  
O parâmetro displayvalue pode ter três valores: true, falseou all.

* true: todos os campos de referências mostram o valor de exibição em vez de `sys_id`.
* falso (padrão): todos os campos de referência mostram `sys_ids`.
* all: o valor de exibição e o `sys_id` são mostrados. Por exemplo, o campo assignedto no registro de Incidente é enviado de volta como assigned_to:1234556, dv_assigned_to:Fred Luddy.
{#c_ActionParameters__ul_unp_vdj_bp}

## variáveis de exibição

Defina este valor booliano como verdadeiro durante uma chamada de função get ou getRecords para recuperar todas as variáveis anexadas a este registro.