사용 가능한 쿼리 매개변수 정의

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기1분
  • 사용 가능한 쿼리 매개변수를 정의하여 요청하는 사용자가 요청 URI에 전달할 수 있는 값을 제어합니다.

    시작하기 전에

    필요한 역할: web_service_admin

    프로시저

    1. 다음으로 이동 모두 > 시스템 웹 서비스 > 스크립트 기반 REST API.
    2. 스크립팅된 REST API 기록을 선택합니다.
    3. 쿼리 매개변수 관련 목록에서 새로 만들기를 선택합니다.
    4. 쿼리 매개변수 이름을 지정합니다.
    5. 매개변수를 사용하는 방법을 설명하는 짧은 설명예시 값을 입력합니다.
    6. 제출을 선택합니다.
    7. 옵션: Query Parameters(쿼리 매개변수) 탭에서 쿼리 매개변수를 찾아 Is required(필수 항목)를 "true"로 설정하여 필요에 따라 이 쿼리 매개변수를 문서화합니다.
      주:
      Is required를 "true"로 설정하면 스크립트된 REST 서비스는 매개 변수 필요를 적용하지 않습니다. 쿼리 매개변수를 요구하도록 강제하려면 필수 매개변수가 누락된 요청을 거부하는 논리를 스크립트된 REST API 자원에 추가해야 합니다.

    다음에 수행할 작업

    사용 가능한 쿼리 매개변수를 정의한 후 매개변수를 스크립팅된 REST 자원에 연결합니다. 자세한 내용은 자원에 쿼리 매개변수 연결 문서를 참조하십시오.