Associate a request header with a resource

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

    • Define which request headers are expected for each resource within a scripted REST API.

    Antes de Iniciar

    A REST API resource and a request header must already be defined within the scripted REST API.

    Role required: web_service_admin

    Procedimento

    1. Navigate to a new Scripted REST Header Association record in one of the following ways
      OptionProcedure
      Navigate through a scripted REST API record
      1. Navigate to All > System Web Services > Scripted REST APIs.
      2. Select a scripted REST API record.
      3. In the Resources related list, select a resource.
      4. In the Request Header Associations tab, select New.
      Navigate directly to a new Scripted REST Header Association record Navigate to All > Filter and enter sys_ws_header_map.form.
    2. In the API request header field, select or enter the request header to associate with the resource.
    3. Opcional: In the API resource field, select or enter the API resource the request header should be associated with.
      If you navigated to a new Scripted REST Header Association record through a scripted REST API record, API resource is pre-populated.
    4. Select Submit.

    Resultado

    The request headers that you added are included in the exportable OpenAPI specification in the REST API Explorer with a "type: string" schema definition. For more information about exporting OpenAPI specifications, see Export to OpenAPI specification.