QueryFilter interface

패키지:

azure-devops-extension-api

쿼리 중에 반환할 확장 집합을 정의하는 데 사용되는 필터입니다.

속성

criteria	필터 값은 이 쿼리의 값 집합을 정의합니다. QueryFilterType을 기반으로 적용됩니다.
direction	PagingDirection은 페이징 토큰이 있는 경우 페이징 토큰에 적용됩니다. 그렇지 않은 경우 방향이 무시되고 결과 집합의 시작부터 Forward가 사용됩니다. 향후 문제를 방지하기 위해 페이징 토큰을 사용하지 않는 한 요청에서 방향을 생략해야 합니다.
pageNumber	사용자가 요청한 페이지 번호입니다. 제공되지 않으면 기본적으로 1이 가정됩니다.
pageSize	페이지 크기는 호출자가 이 필터에 대해 원하는 결과 수를 정의합니다. 개수는 전체 쿼리 크기 제한을 초과할 수 없습니다.
pagingToken	페이징 토큰은 고유한 유형의 필터이며 다른 필터 필드는 무시됩니다. 페이징 토큰은 이전에 실행된 쿼리의 연속을 나타냅니다. 결과의 위치와 필터링되는 필드에 대한 정보가 토큰에 포함됩니다.
sortBy	결과에 적용할 정렬 유형을 정의합니다. 페이지 슬라이스는 정렬된 결과에서만 잘립니다.
sortOrder	정렬 순서를 정의합니다(오름차순은 1, 내림차순은 2), 그렇지 않으면 SortBy 값을 기반으로 기본 순서

속성 세부 정보

criteria

필터 값은 이 쿼리의 값 집합을 정의합니다. QueryFilterType을 기반으로 적용됩니다.

criteria: FilterCriteria[]

속성 값

FilterCriteria[]

direction

PagingDirection은 페이징 토큰이 있는 경우 페이징 토큰에 적용됩니다. 그렇지 않은 경우 방향이 무시되고 결과 집합의 시작부터 Forward가 사용됩니다. 향후 문제를 방지하기 위해 페이징 토큰을 사용하지 않는 한 요청에서 방향을 생략해야 합니다.

direction: PagingDirection

속성 값

PagingDirection

pageNumber

사용자가 요청한 페이지 번호입니다. 제공되지 않으면 기본적으로 1이 가정됩니다.

pageNumber: number

속성 값

number

pageSize

페이지 크기는 호출자가 이 필터에 대해 원하는 결과 수를 정의합니다. 개수는 전체 쿼리 크기 제한을 초과할 수 없습니다.

pageSize: number

속성 값

number

pagingToken

페이징 토큰은 고유한 유형의 필터이며 다른 필터 필드는 무시됩니다. 페이징 토큰은 이전에 실행된 쿼리의 연속을 나타냅니다. 결과의 위치와 필터링되는 필드에 대한 정보가 토큰에 포함됩니다.

pagingToken: string

속성 값

string

sortBy

결과에 적용할 정렬 유형을 정의합니다. 페이지 슬라이스는 정렬된 결과에서만 잘립니다.

sortBy: number

속성 값

number

sortOrder

정렬 순서를 정의합니다(오름차순은 1, 내림차순은 2), 그렇지 않으면 SortBy 값을 기반으로 기본 순서

sortOrder: number

속성 값

number