Reactor API에서 응답 필터링

Reactor API에서 목록(GET) 끝점을 사용하는 경우 반환된 결과를 레코드의 하위 집합으로 제한해야 할 수 있습니다. 이를 위해 많은 API 목록 엔드포인트가 특정 속성별로 필터링하는 기능을 지원합니다. 대신 API에 대한 구조화된 쿼리를 만들려면 검색에 대한 안내서를 참조하십시오.

필터링 구문

다음 예에서는 GET 요청에 대한 필터를 구현하는 방법을 설명합니다.

API 형식

지정된 목록 끝점에 대한 응답을 필터링하려면 요청 경로에 filter 쿼리 매개 변수를 제공해야 합니다.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME}]={OPERATOR} {VALUE}

요청

아래 예제 요청은 라이브러리의 state 특성이 published과(와) 같아야 하는 필터를 적용하여 게시된 라이브러리 목록을 검색합니다.

URI를 인코딩하기 전에 요청 경로의 이 필터에 대한 구문은 다음과 유사합니다.

https://reactor.adobe.io/properties/PR906238a59bbf4262bcedba248f483600/libraries?filter[state]=EQ published

경로 및 쿼리 매개 변수가 URI로 인코딩되면 아래 요청과 같이 API 요청에 사용할 수 있습니다.

curl -X GET \
  https://reactor.adobe.io/properties/PR906238a59bbf4262bcedba248f483600/libraries?filter%5Bstate%5D=EQ%20published \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

여러 값에 대한 필터링 multiple-values

단일 속성에 대해 여러 값을 기준으로 필터링하려면 값을 쉼표로 구분된 목록으로 제공합니다.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME}]={OPERATOR} {VALUE_1},{VALUE_2}

여러 필터 사용

여러 특성에 필터를 적용하려면 각 특성에 filter 매개 변수를 제공하십시오. 매개 변수는 앰퍼샌드(&) 문자로 구분해야 합니다.

GET {ENDPOINT}?filter[{ATTRIBUTE_NAME_1}]={OPERATOR} {VALUE}&filter[{ATTRIBUTE_NAME_2}]={OPERATOR} {VALUE}

부록

다음 섹션에는 Reactor API의 필터 작업에 대한 추가 정보가 포함되어 있습니다.

지원되는 필터 연산자 operators

다음 표에는 필터 매개 변수에 지원되는 연산자 값이 나와 있습니다. 필터링 기준으로 사용하는 속성에 따라 문자열 속성에 "less than" 또는 "greater than" 연산자를 사용하는 것과 같이 사용 가능한 모든 필터 연산자를 적용할 수 있는 것은 아닙니다.