요청 매개변수

이 문서는 API 요청 호출 시 API 엔드포인트 또는 대상 리소스에 대해 정의해야 하는 다양한 요청 매개변수를 설명합니다.

API 엔드포인트 또는 대상 리소스에 따라 API 요청 호출에서 다음 매개변수를 정의해야 할 수도 있습니다.

양식 데이터

해당 매개변수를 사용하여 API 클라이언트가 후속 API 요청 호출을 위해 필요로 하는 액세스 토큰을 요청하십시오.

표 1. 양식 데이터 매개변수
매개변수	설명
client_id	API 클라이언트에 지정되는 클라이언트 ID입니다.
client_secret	API 클라이언트에 지정되는 클라이언트 시크릿입니다.
grant_type	이는 `client_credentials`로 설정됩니다.
scope	이 토큰과 연관된 범위의 공백으로 구분된 목록입니다. API 클라이언트의 유효한 범위는 `openid`입니다.

헤더

Verify HTTP 헤더에 다음 정보가 필요합니다:

표 2. 헤더 매개변수
매개변수	설명
Content Type	요청 헤더에서 이는 클라이언트가 서버에 전송된 데이터 유형을 표시합니다. 응답 헤더에서 이는 클라이언트에 리턴되는 데이터 유형을 표시합니다. 예를 들면 다음과 같습니다. `-H "Content-type: application/json"`
Accept	이는 클라이언트가 응답에서 이해하고 채택할 수 있는 컨텐츠 유형을 표시합니다. 예를 들면 다음과 같습니다. `-H "Accept: application/json" -H "Accept: image/png"`
Location	POST HTTP 메소드 헤더에서 새로 작성된 오브젝트의 URL입니다. 예를 들면, `/<resource-noun>/<resource-id>`입니다.
Accept-Language	클라이언트가 이해하거나 선호하는 언어입니다.

조회 매개변수

API 요청의 결과를 리턴하려는 항목 및 방법에 따라 다음 매개변수는 선택사항입니다.

표 3. 쿼리 매개변수
매개변수	설명
pagination	pagination 매개변수가 전달되지 않으면 모든 결과가 리턴됩니다. 한계 또는 수의 최대 허용 값은 1000입니다. `count`는 데이터 저장소에서 리턴할 총 결과 수입니다. `page`는 요청된 페이지입니다. `limit`는 하나의 페이지에서 리턴할 총 결과 수입니다.
sort	각 속성은 + 또는 -(+ 오름차순, - 내림차순)로 접두어가 지정되어야 합니다. 다중 속성은 쉼표(,)로 구분해야 합니다.
search	유효한 연산자: 문자열은 `= , !=` 와 `contains` 부울 값은 `=` 와 `!=` 숫자는 `>=`, `>`, `<=`, `<`, `=`, 그리고 `!=`
filter	유효한 형식은 포함만 또는 제외만입니다. 다중 필터 매개변수는 쉼표(,)로 구분해야 합니다.

본문

POST, PUT 및 PATCH 요청에 대해 이 매개변수를 사용하십시오. 작성되거나 업데이트되는 속성 및 값을 여기에서 정의하십시오. 형식 및 샘플 값을 포함하여 본문에서 정의해야 하는 속성을 보려면 데이터 유형 모델 또는 예제 값을 클릭하십시오.

매개변수 컨텐츠 유형은 application/json입니다. 컨텐츠는 JSON 파일 형식으로 저장됩니다.