DocsReferencesChangelogCommunity
Docs

filter로 검색하기

"문서 리스트 조회 API" 와 "템플릿 리스트 조회 API"를 이용할 때 filter 파라미터를 이용해 문서를 검색, 필터 할 수 있습니다. 필터 구문을 작성하여, url인코딩하여 filter 파라미터에 적용해 주세요.

 

문서 리스트 조회에서 제공하는 필터 구문

&filter=status%20eq%20'COMPLETED' 를 적용하면 완료된 문서 목록을 불러옵니다.

필터구문 값
문서 상태 필터
특정 상태의 문서를 필터합니다.
  • ON_PROCESSING: 관련 리소스 생성 중
  • PROCESSING_FAILED: 관련 리소스 생성 실패
  • ON_GOING: 서명/열람 진행중
  • ABORTED: 서명/열람이 중단됨
  • COMPLETED: 모든 서명/열람 완료
  • DRAFT : 작성 중
status eq 'COMPLETED'
인코딩 후: status%20eq%20'COMPLETED'
문서 제목 필터
문서 제목에 해당 값이 포함된 문서를 필터합니다.		contains(title, '2021')
인코딩 후: contains(title%2C%20'2021')
문서 생성일 필터
특정 시간구간에 생성된 문서를 가져옵니다.

  • ge : greater or equal than

  • le : less or equal than

  • ge, le, and 를 같이 사용하여 between 처럼 사용할 수 있습니다.

  • 시각 정보는 ISO8601 포맷을 사용합니다.

  • 타임존을 명시하지 않을 경우 UTC를 기준으로 합니다.
    (※ UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고)

createdAt ge '2022-01-01T00:00:00+09:00'
인코딩 후 : createdAt%20ge%20'2022-01-01T00%3A00%3A00%2B09%3A00'
문서 요청일 필터
특정 시간구간에 요청된 문서를 가져옵니다.

  • ge : greater or equal than

  • le : less or equal than

  • ge, le, and 를 같이 사용하여 between 처럼 사용할 수 있습니다.

  • 시각 정보는 ISO8601 포맷을 사용합니다.

  • 타임존을 명시하지 않을 경우 UTC를 기준으로 합니다.
    (※ UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고)

startedAt ge '2022-01-01T00:00:00+09:00'
인코딩 후 : startedAt%20ge%20'2022-01-01T00%3A00%3A00%2B09%3A00'
마지막 활동일 필터
특정 시간구간에 마지막 활동일이 변경된 문서를 가져옵니다.

  • ge : greater or equal than

  • le : less or equal than

  • ge, le, and 를 같이 사용하여 between 처럼 사용할 수 있습니다.

  • 시각 정보는 ISO8601 포맷을 사용합니다.

  • 타임존을 명시하지 않을 경우 UTC를 기준으로 합니다.
    (※ UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고)

updatedAt ge '2022-01-01T00:00:00+09:00'
인코딩 후 : updatedAt%20ge%20'2022-01-01T00%3A00%3A00%2B09%3A00'
라벨 ID 필터
특정 라벨이 적용되어 있는 문서를 가져옵니다.
  • in : 전달된 라벨 ID들을 OR 조건으로 검색합니다.
  • 라벨검색은 동시에 최대 20개까지 허용됩니다.
labelIds in ('labelId1', 'labelId2')
인코딩 후 : labelIds%20in%20('labelId1'%2C%20'labelId2')
동시 조건 검색
각 조건절 사이에 and 를 넣어 사용할 수 있습니다.		status eq 'COMPLETED' and contains(title, '2021')
인코딩 후:
status%20eq%20'COMPLETED'%20
and%20contains(title%2C%20'2021')

 

 

템플릿 리스트 조회에서 제공하는 필터 구문

&filter=contains(title%2C%20'2021') 를 적용하면 "2021" 이 제목에 포함된 템플릿을 불러옵니다.

필터구문 값
템플릿 제목 필터
템플릿 제목에 해당 값이 포함된 문서를 필터합니다.		contains(title, '2021')
인코딩 후: contains(title%2C%20'2021')