목차

Search

  1. 서문
  2. 비즈니스 항목 서비스 소개
  3. EJB 비즈니스 항목 서비스 호출
  4. REST 비즈니스 항목 서비스 호출
  5. Data Director용 REST API
  6. SOAP 비즈니스 항목 서비스 호출
  7. 교차 참조 레코드 및 BVT 계산 서비스
  8. 기업 연결 서비스 지원
  9. 데이터 정리, 분석 및 변환을 위한 외부 호출
  10. 부록 A: REST API를 사용하여 레코드 추가
  11. 부록 B: REST API를 사용하여 파일 업로드
  12. 부록 C: REST API를 사용하여 보고서 관리

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

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

쿼리 매개 변수

쿼리 매개 변수

쿼리를 필드-값 쌍의 목록으로 정의하십시오.
다음 테이블에는 URL에서 사용할 수 있는 쿼리 매개 변수가 설명되어 있습니다.
매개 변수
설명
action
필수 사항입니다. 지정된 비즈니스 항목 유형의 모든 레코드를 쿼리 결과에 반환합니다.
query
를 설정하고
filter
매개 변수와 함께 매개 변수를 사용합니다.
filter
매개 변수 없이 사용하면 쿼리는 지정된 비즈니스 항목 유형의 모든 레코드를 검색합니다.
예를 들어, 다음 쿼리를 사용하여 모든 Person 비즈니스 항목 레코드를 검색합니다.
Person?action=query
filter
필수 사항입니다. 연산자로 구분된 필드-값 쌍 목록을 지정합니다. 유효한 연산자는 AND, IN 및 Range입니다.
예를 들어, 다음 쿼리를 사용하여 이름이 STEVE이고 성이 SMITH인 Person 레코드를 검색합니다.
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
depth
반환할 하위 레코드 수준 수를 지정합니다. 예를 들어, 다음 수준을 지정할 수 있습니다.
  • 1. 루트 레코드를 반환합니다.
  • 2. 루트 레코드와 직속 하위 레코드를 반환합니다.
  • 3. 루트 레코드, 직속 하위 레코드 및 두 수준 아래의 레코드를 반환합니다.
예를 들어, 다음 쿼리를 사용하여 이름이 STEVE인 레코드를 검색하고 루트 레코드와 직속 하위 레코드에 대한 정보를 반환합니다.
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'&depth=2
suppressLinks
API 응답에 상위-하위 링크가 표시되는지 여부를 나타냅니다. 응답에서 모든 상위-하위 링크를 억제하려면 매개 변수를 true로 설정합니다. 기본값은 false입니다.
예를 들어, 다음 쿼리를 사용하여 이름이 STEVE인 레코드를 검색하고 상위-하위 링크가 표시되지 않는 응답을 반환합니다.
Person?action=query&filter=firstName='STEVE'&suppressLinks=true
readSystemFields
결과에 시스템 필드를 반환할지 여부를 나타냅니다. 기본값은 false입니다.
fields
쿼리 결과에 표시할 필드를 지정합니다.
outputView
쿼리 결과를 표시하는 데 사용할 비즈니스 항목 보기를 지정합니다. 쿼리 결과에 대한 비즈니스 항목 보기를 구성할 때 쿼리 결과에 표시하려는 필드를 포함합니다.
Order
쿼리 결과의 정렬 순서를 지정합니다. 더하기(+) 문자를 접두사로 사용하여 오름차순을 지정하고 빼기(-) 문자를 접두사로 사용하여 내림차순을 지정합니다. 기본적으로, 쿼리 결과는 오름차순입니다.
매개 변수를 두 개 이상 지정하면 결과 집합은 목록의 첫 번째 매개 변수 그리고 그 다음 매개 변수 순서대로 지정됩니다.
resolveLookup
지정된 비즈니스 항목에 대한 전체 조회 필드를 검색합니다. 조회 필드를 로드하고 응답에 포함하려면 매개 변수를 true로 설정합니다. 기본값은 false입니다.
예를 들어 addressType 필드는 Person 비즈니스 항목의 하위 수준에 있는 조회 필드입니다.
resolveLookup 매개 변수를 false로 설정하면 다음과 같은 REST API 응답을 수신할 수 있습니다.
{ "label": "LU Address Type", "addressType": "BILL" }
resolveLookups 매개 변수를 true로 설정하면 REST API 응답에 추가 세부 정보가 포함되며 다음과 같은 REST API 응답을 수신할 수 있습니다.
{ "label": "LU Address Type", "addressType": "BILL", "addressTypeDisp": "BILLING" }

연산자

filter 매개 변수 내에서 다음 연산자를 사용할 수 있습니다.
AND
filter 매개 변수에 나열된 모든 필드 값이 있는 레코드를 검색합니다.
예를 들어, 다음 쿼리를 사용하여 이름이 STEVE이고 성이 SMITH인 레코드를 검색합니다.
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
IN
filter 매개 변수에 나열된 값이 있는 레코드를 검색합니다.
예를 들어, 다음 쿼리를 사용하여 이름이 STEVE 또는 JOHN인 레코드를 검색합니다.
Person?action=query&filter=firstName IN [STEVE,JOHN]
Range
지정된 범위 내의 레코드를 검색합니다. 숫자 및 날짜 데이터 유형 필드의 범위를 지정할 수 있습니다.
정수 데이터 유형의 경우 다음 형식을 사용하십시오.
<business entity field name>=[fromValue,toValue]
범위는 fromValue부터 toValue까지입니다. fromValue은 toValue보다 낮아야 합니다.
예를 들어 다음 쿼리를 사용하여 35~45세 그룹의 레코드를 검색합니다.
Person?action=query&filter=firstName IN [STEVE,JOHN] AND age=[35,45]
날짜 데이터 유형의 경우 다음 형식을 사용하십시오.
<business entity field name>=[fromDate,toDate]
범위는 fromDate부터 toDate까지입니다.
예를 들어, 다음 쿼리를 사용하여 생년월일이 2000년 6월 12일에서 2015년 6월 12일 사이인 레코드를 검색합니다.
Person?action=query&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]
!=
지정된 필드 값 또는 범위와 일치하지 않는 레코드를 검색합니다.
예를 들어 이름이 ADAM이 아닌 레코드를 검색하려면 다음 쿼리를 사용합니다.
Person?action=query&filter=firstName!='ADAM'
예를 들어 이름이 ADAM이 아니고 생년월일이 2017년 11월 16일 이전 및 2020년 11월 16일 이후인 레코드를 검색하려면 다음 쿼리를 사용합니다.
Person?action=query&filter=firstName!='ADAM' AND birthdate!=[2017-11-16T00:00:00,2020-11-16T00:00:00]
와일드카드
텍스트와 별표(*) 와일드카드 연산자를 사용하여 전체 검색 문자열 대신 텍스트 패턴을 지정할 수 있습니다. 별표 와일드카드 연산자를 사용하면 원하는 레코드를 찾을 가능성을 높일 수 있습니다. 별표 와일드카드 연산자는 정확한 텍스트를 모르거나 유사한 텍스트를 검색하려는 경우에 유용합니다.
다음 테이블에는 검색 문자열 예와 작동 방식에 대한 설명이 나와 있습니다.
예제 쿼리 문자열
쿼리 동작
John*
John
으로 시작하는 값을 포함하는 레코드를 쿼리합니다.
Johnson
또는
Johnny
를 예로 들 수 있습니다.
Jo*n
Jo
로 시작하고
n
으로 끝나는 레코드를 쿼리합니다.
Johansson
또는
Jordan
을 예로 들 수 있습니다.
*
모든 레코드를 반환합니다.