Define scripted REST API headers

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 1분
  • Define scripted REST API headers to control which headers the API accepts and can respond with.

    시작하기 전에

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

    Role required: web_service_admin

    프로시저

    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. 옵션: From the Request Headers tab, locate the header name and set Is required to "true" to document this request header as required.
      주:
      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.

    다음에 수행할 작업

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