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

사용 가능한 쿼리 매개변수를 정의하여 요청 사용자가 요청 URI에 전달할 수 있는 값을 제어합니다.

시작하기 전에

필요한 역할: web_service_admin

이 태스크 정보

다음 절차는 스크립팅된 REST API 서비스에 대한 쿼리 매개변수를 수동으로 정의하는 프로세스를 설명합니다. 비프로덕션 인스턴스에서 요청에 대한 쿼리 매개변수를 자동으로 생성하는 방법에 대한 자세한 내용은 다음 문서를 참조하십시오 API 요청 정의 자동 생성.

프로시저

1. 다음으로 이동 모두 > 시스템 웹 서비스 > 스크립트 기반 REST API.
2. 스크립팅된 REST API 기록을 선택합니다.
3. 쿼리 매개변수 관련 목록에서 새로 만들기를 선택합니다.
4. 쿼리 매개변수 이름을 지정합니다.
5. 매개변수 사용 방법을 설명하는 간단한 설명 과 예시 값을 입력합니다.
6. 제출을 선택합니다.
7. 옵션: 쿼리 매개변수 탭에서 쿼리 매개변수를 찾고 필요에 따라 이 쿼리 매개변수를 문서화하려면 필수 를 "예"로 설정합니다.
   주:

   필수를 "예"로 설정하면 스크립트된 REST 서비스에서 매개변수 요구를 적용하지 않습니다. 쿼리 매개변수 요구를 적용하려면 필수 매개변수가 누락된 요청을 거부하는 논리를 스크립팅된 REST API 자원에 추가해야 합니다.

다음에 수행할 작업

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