흐름 서비스 API에서 응답 정렬 및 필터링

에서 목록(GET) 요청을 수행할 때 플로우 서비스 API, 쿼리 매개 변수를 사용하여 응답을 정렬하고 필터링할 수 있습니다. 이 안내서에서는 다양한 사용 사례에서 이러한 매개 변수를 사용하는 방법에 대한 참조를 제공합니다.

정렬

다음을 사용하여 응답을 정렬할 수 있습니다. orderby 쿼리 매개 변수. API에서는 다음 리소스를 정렬할 수 있습니다.

매개 변수를 사용하려면 해당 값을 정렬 기준으로 사용할 특정 속성으로 설정해야 합니다(예: ?orderby=name). 값의 앞에 더하기 기호(+)를 사용하여 오름차순 또는 빼기 기호(-) 내림차순입니다. 순서 지정 접두사가 제공되지 않으면 기본적으로 목록이 오름차순으로 정렬됩니다.

GET /flows?orderby=name
GET /flows?orderby=-name

"and" 기호(&).

GET /flows?property=state==enabled&orderby=createdAt

필터링

다음을 사용하여 응답을 필터링할 수 있습니다. property 키-값 표현식이 있는 매개 변수. 예를 들어, ?property=id==12345 은(는) 다음 자원만 반환합니다. id 속성이 정확히 다음과 같음 12345.

필터링은 해당 속성에 대한 유효한 경로가 알려져 있는 한 엔티티의 모든 속성에 일반적으로 적용할 수 있습니다.

NOTE
속성이 배열 항목 내에 중첩된 경우 대괄호( )를 추가해야 합니다.[])를 경로 내 배열로 복사합니다. 의 섹션을 참조하십시오. 배열 속성 필터링 예.

소스 테이블 이름이 인 모든 소스 연결 반환 lead:

GET /sourceConnections?property=params.tableName==lead

특정 세그먼트 ID에 대한 모든 흐름 반환:

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a

필터 결합

복수 property 필터는 "and" 문자로 구분된 경우 쿼리에 포함할 수 있습니다(&). 필터를 결합할 때 AND 관계가 가정되는데, 이것은 엔티티가 응답에 포함되기 위해 모든 필터를 충족해야 함을 의미합니다.

세그먼트 ID에 대해 활성화된 모든 흐름 반환:

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a&property=state==enabled

배열 속성 필터링 arrays

를 추가하여 배열 내의 항목 속성을 기준으로 필터링할 수 있습니다 [] 를 배열 속성의 이름으로 바꿉니다.

특정 소스 연결과 연결된 반환 흐름:

GET /flows?property=sourceConnectionIds[]==9874984,6980696

특정 선택기 값 ID를 포함하는 변환이 있는 반환 흐름:

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a

특정 열이 있는 소스 연결 반환 name 값:

GET /sourceConnections?property=params.columns[].name==firstName

세그먼트 ID를 필터링하여 대상에 대한 흐름 실행 ID를 조회합니다.

GET /runs?property=metrics.recordSummary.targetSummaries[].entitySummaries[].id==segment:068d6e2c-b546-4c73-bfb7-9a9d33375659

count

모든 필터링 쿼리는 다음으로 추가할 수 있습니다. count 값이 인 쿼리 매개 변수 true 를 클릭하여 결과 수를 반환합니다. API 응답에는 count 값이 필터링된 총 항목 수를 나타내는 속성입니다. 이 호출에서는 실제 필터링된 항목이 반환되지 않습니다.

시스템에서 활성화된 흐름 수를 반환합니다.

GET /flows?property=state==enabled&count=true

위의 쿼리에 대한 응답은 다음과 같습니다.

{
  "count": 95
}

리소스별 필터링 가능한 속성

검색 중인 흐름 서비스 엔터티에 따라 필터링에 다른 속성을 사용할 수 있습니다. 아래 표는 필터링 사용 사례에 일반적으로 사용되는 각 리소스에 대한 루트 수준 필드를 설명합니다.

connectionSpec

속성
id
/connectionSpecs?property=id==736873,9485095
name
/connectionSpecs?property=name==TestConn
providerId
/connectionSpecs?property=providerId==3897933
attributes.{ATTRIBUTE_NAME}
/connectionSpecs?property=attributes.sampleAttribute="abc"

flowSpec

속성
id
/flowSpecs?property=id==736873,9485095
name
/flowSpecs?property=name==TestConn
providerId
/flowSpecs?property=providerId==3897933

connection

속성
id
/connections?property=id==736873,9485095
name
/connections?property=name==TestConn
description
/connections?property=description==Test%20description
connectionSpec.id
/connections?property=connectionSpec.id==938903,849048
state
/connections?property=state==enabled

sourceConnection

속성
id
/sourceConnections?property=id==736873,9485095
connectionSpec.id
/sourceConnections?property=connectionSpec.id==938903,849048
baseConnectionId
/sourceConnections?property=baseConnectionId==983908,4908095

targetConnection

속성
id
/targetConnections?property=id==736873,9485095
connectionSpec.id
/targetConnections?property=connectionSpec.id==938903,849048
baseConnectionId
/targetConnections?property=baseConnectionId==983908,4908095

flow

속성
id
/flows?property=id==736873,9485095
name
/flows?property=name==TestFlow
description
/flows?property=description==Test%20description
flowSpec.id
/flows?property=flowSpec.id==938903,849048
state
/flows?property=state==enabled
sourceConnectionIds
/flows?property=sourceConnectionIds[]==9874984,6980696
targetConnectionIds
/flows?property=targetConnectionIds[]==598590,690666

run

속성
id
/runs?property=id==736873,9485095
flowId
/runs?property=flowId==8749844
state
/runs?property=state==inProgress

사용 사례 use-cases

필터링 및 정렬을 사용하여 특정 커넥터에 대한 정보를 반환하거나 문제 디버깅을 지원하는 방법에 대한 몇 가지 특정 예를 보려면 이 섹션을 참조하십시오. Adobe에서 추가하고자 하는 추가 사용 사례가 있는 경우 자세한 피드백 옵션 페이지를 방문하여 요청을 제출하십시오.

특정 대상에 대한 연결만 반환하도록 필터링

필터를 사용하여 특정 대상에만 연결을 반환할 수 있습니다. 먼저 을(를) 쿼리합니다 connectionSpecs 아래와 같은 엔드포인트:

GET /connectionSpecs

그런 다음 원하는 을 검색합니다 connectionSpec 다음의 물품을 검사함 name 매개 변수. 예를 들어에서 Amazon Ads, Pega, SFTP 등을 검색합니다. name 매개 변수. 해당 id 은(는) connectionSpec 다음 API 호출에서 검색할 수 있습니다.

예를 들어 Amazon S3 연결에 대한 기존 연결만 반환하도록 대상을 필터링할 수 있습니다.

GET /connections?property=connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81

대상으로만 데이터 흐름을 반환하도록 필터링

쿼리 시 /flows endpoint에서는 모든 소스 및 대상 데이터 흐름을 반환하는 대신 필터를 사용하여 데이터 흐름을 대상으로만 반환할 수 있습니다. 이렇게 하려면 다음을 사용합니다. isDestinationFlow 쿼리 매개 변수로 다음과 같이 지정합니다.

GET /flows?property=inheritedAttributes.properties.isDestinationFlow==true

특정 소스 또는 대상으로만 데이터 흐름을 반환하도록 필터링

데이터 흐름을 필터링하여 특정 대상 또는 특정 소스에서만 데이터 흐름을 반환할 수 있습니다. 예를 들어 Amazon S3 연결에 대한 기존 연결만 반환하도록 대상을 필터링할 수 있습니다.

GET /flows?property=inheritedAttributes.targetConnections[].connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81

특정 기간 동안 데이터 흐름의 모든 실행을 가져오도록 필터링

다음과 같이 데이터 흐름의 데이터 흐름 실행을 필터링하여 특정 시간 간격의 실행만 볼 수 있습니다.

GET /runs?property=flowId==<flow-id>&property=metrics.durationSummary.startedAtUTC>1593134665781&property=metrics.durationSummary.startedAtUTC<1653134665781

실패한 데이터 흐름만 반환하도록 필터링

디버깅 목적으로 아래와 같이 특정 소스 또는 대상 데이터 흐름에 대해 실패한 모든 데이터 흐름을 필터링하고 볼 수 있습니다.

GET /runs?property=flowId==<flow-id>&property=metrics.statusSummary.status==Failed

다음 단계

이 안내서에서는 사용 방법을 다룹니다 orderbyproperty 흐름 서비스 API에서 응답을 정렬 및 필터링하기 위한 쿼리 매개 변수입니다. Platform의 일반적인 워크플로에 API를 사용하는 방법에 대한 단계별 안내서는 다음에포함된 API 튜토리얼을 참조하십시오. 소스대상 설명서를 참조하십시오.

recommendation-more-help
d4f38c9a-ed8e-4b74-98e7-57b4df1b999f