Criar um recurso de REST API com script

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

    Antes de Iniciar

    Deve haver uma REST API de script definida antes de criar recursos.

    Função necessária: web_service_admin

    Por Que e Quando Desempenhar Esta Tarefa

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

    Procedimento

    1. Navegar até Todos > Serviços web do sistema > Scripted REST APIs.
    2. Selecione um registro de REST API com script.
    3. Na lista relacionada Recursos, clique em Novo.
    4. Insira um Nome.
      O nome do recurso afeta o URI para enviar solicitações à API.
    5. Selecione o método HTTP que este recurso implementa, como GET.
    6. No campo 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 diferentes configurações de segurança ou tipos de conteúdo válidos.
    8. Opcional: Na guia Documentação, forneça uma Descrição resumida explicando como acessar o recurso.
      Essas informações aparecem ao explorar este recurso usando o Explorador de REST API.
    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 Definir cabeçalhos de REST API de script e Definir parâmetros de consulta disponíveis.