목차

Search

  1. 서문
  2. 비즈니스 항목 서비스 소개
  3. Enterprise Java Bean 비즈니스 항목 서비스 호출
  4. Representational State Transfer 비즈니스 항목 서비스 호출
  5. Simple Object Access Protocol 비즈니스 항목 서비스 호출
  6. 교차 참조 레코드 및 BVT 계산을 위한 서비스
  7. 기업 연결 서비스 지원
  8. 데이터 정리, 분석 및 변환을 위한 외부 호출
  9. REST API를 사용하여 레코드 추가
  10. REST API를 사용하여 파일 업로드

비즈니스 항목 서비스 가이드

비즈니스 항목 서비스 가이드

쿼리 매개 변수

쿼리 매개 변수

q 또는 fq 쿼리 매개 변수를 사용하여 검색을 위한 문자열 값을 제공합니다. q 및 fq 쿼리 매개 변수는 함께 사용할 수 없습니다. 필드가 지정된 검색에는 fq 매개 변수를 사용하십시오. AND 논리 연산자를 사용하여 조건을 여러 개 지정할 수 있습니다.
다음 테이블에는 URL에서 사용할 수 있는 매개 변수가 나와 있습니다.
매개 변수
설명
q
문자열 값 또는 검색 용어를 지정합니다. 이 쿼리는 레코드의 모든 위치에서 검색 용어를 검색합니다. 간단한 검색에 사용됩니다.
예를 들어
Person?q=STEVE
쿼리는 STEVE라는 용어가 있는 레코드를 검색합니다.
두 개 이상의 용어를 함께 검색하려면 용어를 큰따옴표로 묶습니다. 검색 결과에 용어를 포함하려면 각 용어 앞에 + 문자를 사용합니다. 필드 값에 공백이 포함된 경우에는 필드 값을 작은따옴표로 묶습니다.
WILLIAM JOHN LAWSON에 대한 정확한 일치 항목을 검색하려면 다음 쿼리를 사용하십시오.
Person?q="WILLIAM JOHN LAWSON"
WILLIAM, JOHN 또는 LAWSON을 검색하려면 다음 쿼리를 사용하십시오.
Person?q=WILLIAM JOHN LAWSON
WILLIAM, JOHN 및 LAWSON을 검색하려면 다음 쿼리를 사용하십시오.
Person?q=WILLIAM JOHN LAWSON&queryOperator=AND
fq
특정 필드의 문자열 값 또는 검색 용어를 지정합니다. 이 쿼리는 레코드의 해당 부분에서만 용어를 검색합니다. 인덱싱된 필드를 기반으로 대상이 지정된 검색에 사용됩니다.
예를 들어
Person?fq=displayname=STEVE
쿼리는 표시 이름이 STEVE인 레코드를 검색합니다.
패싯
검색 결과를 그룹화하는 범주 또는 패싯으로 처리해야 하는 필드를 지정합니다. 검색 가능한 필드만 지정합니다. q 및 fq 매개 변수와 함께 사용됩니다. 구문은
&facets=FieldName1,FieldName2,FieldNameN
입니다.
예를 들어
Person?q=STEVE&facets=department
쿼리는 표시 이름이 STEVE인 개인을 검색하고, 검색 결과를 부서별로 그룹화합니다. 이 검색은 표시 이름이 STEVE인 개인의 레코드를 표시하며, 이러한 레코드는 부서별로 그룹화됩니다.
필터
검색 결과를 좁힐 수 있는 필드를 지정합니다. 필터링 가능한 필드만 지정합니다. q 및 fq 매개 변수와 함께 사용됩니다.
예를 들어
Person?fq=STEVE&filters=birthdate='1980-11-27T08:00:00Z'
쿼리는 표시 이름이 STEVE인 개인을 검색하고, 생일을 기준으로 검색 결과를 필터링합니다. 이 검색은 표시 이름이 STEVE이고 생일이 1980년 11월 27일인 개인의 레코드를 표시합니다.
날짜를 작은따옴표로 묶어서 지정합니다.
depth
반환할 하위 수준 수를 지정합니다. 루트 노드 및 직접 하위 노드를 반환하려면 2를 지정하고 루트 노드, 직접 하위 노드 및 두 수준 하위 노드를 반환하려면 3을 지정하십시오. 루트 노드만 반환하려면 1을 지정합니다. 기본적으로 깊이는 지정되지 않습니다.
깊이를 지정하지 않으면 검색 결과에는 검색 용어와 일치하는 항목이 발견된 루트 노드와 하위 노드가 반환됩니다.
예를 들어
Person?q=STEVE&depth=2
쿼리는 STEVE라는 용어가 포함된 레코드를 검색하고, 루트 레코드와 바로 아래의 하위 레코드에 대한 정보를 반환합니다.
queryOperator
검색에서 검색 용어의 임의 문자열을 검색할지 검색 용어의 모든 문자열을 검색할지 여부를 지정합니다.
이 매개 변수는 다음 값 중 하나를 사용합니다.
  • OR
    .
    f
    또는
    fq
    매개 변수에 나열된 임의 문자열을 검색합니다.
  • AND
    .
    f
    또는
    fq
    매개 변수에 나열된 모든 문자열을 검색합니다.
이 매개 변수를 지정하지 않은 경우 기본값은
OR
입니다.
예를 들어
Person?q=WILLIAM JOHN LAWSON&queryOperator=AND
쿼리는 WILLIAM, JOHN 및 LAWSON이 포함된 레코드를 검색합니다.
suppressLinks
API 응답에 상위-하위 링크가 표시되는지 여부를 나타냅니다. 응답에서 모든 상위-하위 링크를 억제하려면 매개 변수를 true로 설정합니다. 기본값은 false입니다.
예를 들어
Person?q=STEVE&suppressLinks=true
쿼리는 STEVE라는 용어가 포함된 레코드를 검색한 후 상위-하위 링크가 표시되지 않는 응답을 반환합니다.
readSystemFields
결과에 시스템 필드를 반환할지 여부를 나타냅니다. 기본값은 false입니다.
order
필드 이름의 쉼표로 구분된 목록입니다(선택적 접두사
+
또는
-
).
+
접두사는 결과를 오름차순으로 정렬함을 나타내고
-
접두사는 결과를 내림차순으로 정렬함을 나타냅니다. 기본값은
+
입니다.
하위 필드를 사용하여 결과를 정렬하려면 필드의 전체 이름을 사용합니다. 예:
BillAddresses.Address.cityName
매개 변수를 두 개 이상 지정하면 결과 집합은 목록의 첫 번째 매개 변수부터 차례대로 순서가 지정됩니다. 예를 들어
Person?order=displayName,-BillAddresses.Address.cityName
쿼리는 결과를 표시 이름을 기준으로 오름차순으로 정렬한 다음 도시 이름을 기준으로 내림차순으로 정렬합니다.
maxRecordsToSort
정렬할 검색 결과의 최대 수입니다. 기본값은 1000입니다.
filters
매개 변수와 함께 범위 지정
:
filters 매개 변수를 사용하여 지정된 범위 내로 검색 결과를 좁힐 수 있습니다. 숫자 및 날짜 데이터 유형의 필터링 가능한 필드에 대해 범위를 지정할 수 있습니다.
정수 데이터 유형의 경우 다음 형식을 사용하십시오.
fieldName1=[fromValue,toValue]
범위는 fromValue부터 toValue까지입니다. fromValue은 toValue보다 낮아야 합니다. 예를 들어
filters=age=[35,45]
쿼리는 검색 결과를 좁혀서 연령대가 35 -45인 레코드를 검색합니다.
날짜 데이터 유형의 경우 다음 형식을 사용하십시오.
fieldName1=[fromDate,toDate]
범위는 fromDate부터 toDate까지입니다. 예를 들어
filters=birthdate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]
쿼리는 생일을 2000년 6월 12일 - 2015년 6월 12일로 지정합니다.
정확히 일치하는 날짜 필터를 지정할 경우에는 해당 필터를 작은따옴표로 묶으십시오. 날짜 범위를 지정할 때는 따옴표를 사용하지 마십시오.