Definir 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é Todos > Serviços web do sistema > Scripted REST APIs.
2. Selecione um registro de API REST de script.
3. Na lista relacionada Parâmetros de consulta, selecione Novo.
4. Especifique o Nome do parâmetro de consulta.
5. Insira uma Descrição resumida e um valor de Exemplo para 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 É necessário como "verdadeiro" para documentar esse parâmetro de consulta conforme necessário.
   Nota:

   Se você definir É necessário como "verdadeiro", o serviço REST com script não imporá a exigência do parâmetro. Para impor a exigência de um parâmetro de consulta, você deve adicionar lógica ao recurso de API REST de 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 de script. Para obter detalhes, consulte Associar parâmetros de consulta a um recurso.