Define scripted REST API headersa scripted REST API request header

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 1 min. de leitura

    • Define scripted REST API request headers to control which headers the API accepts and can respond with.

    Antes de Iniciar

    There must be a scripted REST API defined before you can create request headers.

    Role required: web_service_admin

    Procedimento

    1. Navigate to All > System Web Services > Scripted REST APIs.
    2. Select a scripted REST API record.
    3. In the Request Headers related list, select New.
    4. Enter a Header name.
    5. Enter a Short description and Example value to explain how to use the header.
    6. Select Submit.
    7. Opcional: From the Request Headers tab, locate the header name and set Is required to "true" to document this request header as required.
      Nota:
      If you set Is required to "true", the scripted REST service doesn't enforce requiring the header. To enforce requiring a header, you must add logic to the scripted REST API resource that rejects requests that are missing the required headers.

    O que Fazer Depois

    After defining available headers, associate the headers with a scripted REST resource. For more information, see Associate a request header with a resource.