Crie um recurso de REST API com script

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 1 min. de leitura
  • Crie um recurso da REST API com script para definir o método HTTP, o script de processamento e substituir as configurações do serviço primário.

    Antes de Iniciar

    Deve haver uma REST API com script definida para que você possa criar recursos.

    Função necessária: web_service_admin

    Por Que e Quando Desempenhar Esta Tarefa

    Por padrão, qualquer novo recurso de REST API com script que você criar contém uma ACL que proíbe usuários com a função snc_external de fazer solicitações à API.

    Procedimento

    1. Navegar até Tudo > Serviços web do sistema > Scripted REST APIs.
    2. Selecione um registro da REST API com script.
    3. Em Recursos lista relacionada, clique em Novo .
    4. Insira um Nome.
      O nome do recurso afeta o URI para enviar solicitações para a API.
    5. Selecione Método HTTP este recurso implementa, como OBTER .
    6. Em Script defina como a operação analisa e responde às solicitações.
    7. Opcional: Substitua as configurações da REST API primária conforme necessário, por exemplo, especificando configurações de segurança diferentes ou tipos de conteúdo válidos.
    8. Opcional: Em Documentação , forneça um Descrição resumida explicando como acessar o recurso.
      Essas informações aparecem ao explorar este recurso usando o Explorador da API REST.
    9. Clique em Enviar.

    O que Fazer Depois

    Depois de criar o recurso, você pode associar cabeçalhos e parâmetros de consulta. Para obter detalhes, consulte Defina cabeçalhos da REST API com script e. Defina os parâmetros de consulta disponíveis .