Sortera och filtrera svar i API:t för Flow Service
Vid listning (GET) i dialogrutan API för flödestjänstkan du använda frågeparametrar för att sortera och filtrera svaren. Den här handboken innehåller en referens för hur du använder de här parametrarna för olika användningsområden.
Sortering
Du kan sortera svar med en orderby
frågeparam. Följande resurser kan sorteras i API:
Om du vill använda parametern måste du ange dess värde till den specifika egenskap som du vill sortera efter (till exempel ?orderby=name
). Du kan lägga till ett plustecken (+
) för stigande ordning eller minustecken (-
) för fallande ordning. Om inget ordningsprefix anges sorteras listan som standard i stigande ordning.
GET /flows?orderby=name
GET /flows?orderby=-name
Du kan också kombinera en sorteringsparameter med en filterparameter genom att använda symbolen "och" (&
).
GET /flows?property=state==enabled&orderby=createdAt
Filtrering
Du kan filtrera svar med en property
parameter med ett nyckelvärdesuttryck. Till exempel: ?property=id==12345
returnerar bara resurser vars id
egenskapen är exakt lika med 12345
.
Filtrering kan tillämpas generellt på alla egenskaper i en entitet så länge som den giltiga sökvägen till den egenskapen är känd.
[]
) till arrayen i sökvägen. Se avsnittet om filtrera på arrayegenskaper till exempel.Returnera alla källanslutningar där källtabellens namn är lead
:
GET /sourceConnections?property=params.tableName==lead
Returnera alla flöden för ett specifikt segment-ID:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a
Kombinera filter
Flera property
filter kan inkluderas i en fråga förutsatt att de avgränsas med"och"-tecken (&
). En AND-relation antas när filter kombineras, vilket innebär att en enhet måste uppfylla alla filter för att den ska kunna inkluderas i svaret.
Returnera alla aktiverade flöden för ett segment-ID:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a&property=state==enabled
Filtrera på arrayegenskaper arrays
Du kan filtrera baserat på egenskaperna för objekt i arrayer genom att lägga till []
till arrayegenskapens namn.
Returflöden som är associerade med specifika källanslutningar:
GET /flows?property=sourceConnectionIds[]==9874984,6980696
Returflöden som har en omformning som innehåller ett specifikt väljarvärde-ID:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a
Returnera källanslutningar som har en kolumn med en specifik name
värde:
GET /sourceConnections?property=params.columns[].name==firstName
Söka efter flödeskörnings-ID för ett mål genom att filtrera på segment-ID:
GET /runs?property=metrics.recordSummary.targetSummaries[].entitySummaries[].id==segment:068d6e2c-b546-4c73-bfb7-9a9d33375659
count
Alla filtreringsfrågor kan läggas till med count
frågeparameter med värdet true
för att returnera antalet resultat. API-svaret innehåller en count
egenskap vars värde representerar antalet totalt filtrerade objekt. De filtrerade objekten returneras inte i det här anropet.
Returnera antalet aktiverade flöden i systemet:
GET /flows?property=state==enabled&count=true
Svaret på frågan ovan ser ut så här:
{
"count": 95
}
Filterbara egenskaper efter resurs
Beroende på vilken Flow Service-enhet du hämtar kan olika egenskaper användas för filtrering. Tabellerna nedan delar upp rotnivåfälten för varje resurs som vanligtvis används vid filtrering.
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
Användningsfall use-cases
I det här avsnittet finns några specifika exempel på hur du kan använda filtrering och sortering för att returnera information om vissa anslutningar eller för att hjälpa dig med felsökningsfrågor. Om du vill att Adobe ska lägga till fler användningsområden använder du Detailed feedback options på sidan för att skicka en begäran.
Filtrera så att bara anslutningar till en viss destination returneras
Du kan bara använda filter för att returnera anslutningar till vissa mål. Fråga först connectionSpecs
slutpunkt som nedan:
GET /connectionSpecs
Sök sedan efter det du vill connectionSpec
genom att inspektera name
parameter. Du kan till exempel söka efter Amazon Ads, Pega eller SFTP i dialogrutan name
parameter. Motsvarande id
är connectionSpec
som du kan söka efter i nästa API-anrop.
Du kan till exempel filtrera destinationerna så att endast befintliga anslutningar till Amazon S3-anslutningar returneras:
GET /connections?property=connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81
Filtrera för att returnera dataflöden till endast mål
När du frågar /flows
slutpunkten kan du, i stället för att returnera alla käll- och måldataflöden, använda ett filter för att endast returnera dataflöden till mål. Om du vill göra det använder du isDestinationFlow
som frågeparameter, enligt följande:
GET /flows?property=inheritedAttributes.properties.isDestinationFlow==true
Filter som returnerar dataflöden till en viss källa eller mål
Du kan filtrera dataflöden om du bara vill returnera dataflöden till ett visst mål eller från en viss källa. Du kan till exempel filtrera destinationerna så att endast befintliga anslutningar till Amazon S3-anslutningar returneras:
GET /flows?property=inheritedAttributes.targetConnections[].connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81
Filtrera för att hämta alla körningar av ett dataflöde under en viss tidsperiod
Du kan filtrera dataflödeskörningar av ett dataflöde så att du bara tittar på körningar under ett visst tidsintervall, som nedan:
GET /runs?property=flowId==<flow-id>&property=metrics.durationSummary.startedAtUTC>1593134665781&property=metrics.durationSummary.startedAtUTC<1653134665781
Filter som endast returnerar felaktiga dataflöden
I felsökningssyfte kan du filtrera och se alla misslyckade dataflöden för ett visst käll- eller måldataflöde, som nedan:
GET /runs?property=flowId==<flow-id>&property=metrics.statusSummary.status==Failed
Nästa steg
Den här guiden beskriver hur du använder orderby
och property
frågeparametrar för att sortera och filtrera svar i Flow Service API. Stegvisa guider om hur du använder API:t för vanliga arbetsflöden i Platform finns i API-självstudiekurserna i källor och mål dokumentation.