List API 호출
GET HTTP 요청을 사용하여 List API에 액세스합니다. List API는 요청 파라미터에 지정된 기준과 일치하는 레코드 목록을 리턴합니다.
REST List 요청은
getNameList API를 사용하며, 여기서 Name은 요청에 지정하는 자원의 유형입니다. 자원 및 API의 전체 목록을 보려면 REST Javadoc 파일을 보십시오.요청 형식
다음 HTTP 요청 형식을 사용하여 List API를 호출하십시오.
GET https://host:port/contextRoot/restapi/Name?parameters다음 예제는 getOrganizationList에 대한 REST 호출을 보여줍니다.
GET https://host:port/contextRoot/restapi/organization?IsNode=Y&OrganizationName=~like~DEMO 조회 필터링
REST List API 호출에서, 조회에 지정된 속성/값 파라미터에 따라 결과를 필터링할 수 있습니다. getOrganizationList 예제에서 IsNode=Y 및 OrganizationName=~like~DEMO는 속성/값 파라미터입니다. 속성/값 파라미터는 요청 URL에서 앰퍼샌드(&)로 구분합니다.
다음의 형식화 옵션을 사용하여 속성과 해당 값 사이의 관계를 지정할 수 있습니다.
| 형식 | 설명 |
|---|---|
attribute=value |
attribute가 value와 같습니다. |
attribute=~neq~value |
attribute가 value와 같지 않습니다. |
attribute=~gt~value |
attribute가 value보다 큽니다. |
attribute=~gteq~value |
attribute가 value보다 크거나 같습니다. |
attribute=~lt~value |
attribute가 value보다 작습니다. |
attribute=~lteq~value |
attribute가 value보다 작거나 같습니다. |
attribute=~ew~value |
attribute가 value로 끝납니다. |
attribute=~sw~value |
attribute가 value로 시작합니다. |
attribute=~like~value |
attribute의 일부가 value와 일치합니다. |
결과 정렬
응답 데이터를 특정 속성에 따라 순서대로 배열하려면
sort 파라미터와 정렬 기준이 될 속성을 요청 URL에 전달하십시오.sort({+ or -}attribute1,{+ or -}attribute2)- + 오름차순으로 정렬
- - 내림차순으로 정렬
다음 예제는 파라미터로 전달된 정렬 함수를 사용하여
getOrganizationList에 대한 REST 호출을 보여줍니다.GET /restapi/organization?sort(+OrganizationName,-Createts)attribute=value 형식을 가지도록 _sort 파라미터를 요청 URL에 전달할 수도 있습니다. 다음 예제는 _sort 파라미터를 사용하는 동일한 순서화 요청의 형식을 보여줍니다.GET /restapi/organization?_sort=+OrganizationName,-Createts페이지 매김
페이지 매김은 HTTP Range 헤더에서 제어합니다. 예를 들어 값이 items=20-39인 Range 헤더를 지정하면 조회에서 20번째와 39번째 아이템 사이의 아이템이 리턴됩니다.
또는 _range 파라미터를 요청 URL에 전달할 수도 있습니다. Range 헤더와 관련된 문제가 발생하는 경우 이 옵션을 사용하십시오.
GET /restapi/organization?_range=20-39