Defina os parâmetros de consulta disponíveis

Defina os parâmetros de consulta disponíveis para controlar quais valores um usuário solicitante pode passar no URI de solicitação.

Antes de Iniciar

Função necessária: web_service_admin

Procedimento

1. Navegar até Tudo > Serviços web do sistema > Scripted REST APIs.
2. Selecione um registro de REST API com script.
3. Em Parâmetros de consulta lista relacionada, selecione Novo .
4. Especifique Nome do parâmetro de consulta .
5. Insira um Descrição resumida e. Valor de exemplo explicar como usar o parâmetro.
6. Selecione Enviar.
7. Opcional: Na guia Parâmetros de consulta, localize o parâmetro de consulta e defina É obrigatório "verdadeiro" para documentar este parâmetro de consulta conforme necessário.
   Nota:

   Se você definir É obrigatório Para "verdadeiro", o serviço REST com script não impõe a exigência do parâmetro. Para impor a exigência de um parâmetro de consulta, você deve adicionar lógica ao recurso REST API com script que rejeita solicitações que não têm os parâmetros necessários.

O que Fazer Depois

Depois de definir os parâmetros de consulta disponíveis, associe os parâmetros a um recurso REST com script. Para obter detalhes, consulte Associe parâmetros de consulta a um recurso.