Parâmetros da ação
Os parâmetros de ação são separados e diferentes dos parâmetros de dados porque especificam a ação a ser tomada quando o parâmetro do 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_actionou filtrar os resultados de uma atualização ou consulta no caso de sysparm_query.
sysparm_action
sysparm_action e a ação correspondente acionada pela API.| 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. |
| Resumo do Método | Descrição |
|---|---|
| inserir | Crie um ou mais registros novos para a tabela de destino no URL. |
| inserir vários | Crie vários novos registros para a tabela de destino no 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 no URL especificando seu sys_id no parâmetro de URL sysparm_sys_id. |
| deleteMultiple | Exclua vários registros da tabela de destino no URL, filtrados por uma cadeia de caracteres de consulta codificada. |
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 nenhum 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 (valorsysparm_action ).
sysparm_registro_contagem
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 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 do usuário é enviado.
- verdadeiro: 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_idsão mostrados. Por exemplo, o campo assignedto no registro de Incidente é enviado de volta como assigned_to:1234556, dv_assigned_to:Fred Luddy.
exibirvariáveis
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.