Sortieren und Filtern von Antworten in der Flow Service-API
- Themen:
- Datenflüsse
Erstellt für:
- Entwickler
Bei der Durchführung von Auflistungsanfragen (GET) in der Flow Service-API können Sie Abfrageparameter verwenden, um Antworten zu sortieren und zu filtern. Dieses Handbuch bietet eine Referenz zur Verwendung dieser Parameter für verschiedene Anwendungsfälle.
Sortieren
Sie können Antworten mithilfe eines orderby Abfrageparameters sortieren. Die folgenden Ressourcen können in der -API sortiert werden:
Um den Parameter zu verwenden, müssen Sie seinen Wert auf die spezifische Eigenschaft festlegen, nach der Sie sortieren möchten (z. B. ?orderby=name). Sie können dem Wert ein Pluszeichen (+) für aufsteigende Reihenfolge oder ein Minuszeichen (-) für absteigende Reihenfolge voranstellen. Wenn kein Sortierpräfix angegeben wird, wird die Liste standardmäßig in aufsteigender Reihenfolge sortiert.
GET /flows?orderby=name
GET /flows?orderby=-name
Sie können auch einen Sortierparameter mit einem Filterparameter kombinieren, indem Sie ein „Und“-Symbol (&) verwenden.
GET /flows?property=state==enabled&orderby=createdAt
Filterung
Sie können Antworten mithilfe eines property mit einem Schlüssel-Wert-Ausdruck filtern. Beispielsweise gibt ?property=id==12345 nur Ressourcen zurück, deren id genau 12345 entspricht.
Die Filterung kann für jede Eigenschaft in einer Entität allgemein angewendet werden, solange der gültige Pfad zu dieser Eigenschaft bekannt ist.
NOTE[]) an das Array im Pfad anhängen. Beispiele finden Sie im Abschnitt Filtern von ArrayEigenschaften).Gibt alle Quellverbindungen zurück, deren Quelltabellenname lead ist:
GET /sourceConnections?property=params.tableName==lead
Gibt alle Flüsse für eine bestimmte Segment-ID zurück:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a
Filter kombinieren
Eine Abfrage kann mehrere property enthalten, sofern sie durch die Zeichen „und“ (&) getrennt sind. Eine UND-Beziehung wird beim Kombinieren von Filtern angenommen, was bedeutet, dass eine Entität alle Filter erfüllen muss, damit sie in die Antwort aufgenommen wird.
Alle aktivierten Flüsse für eine Segment-ID zurückgeben:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a&property=state==enabled
Filtern nach Array-Eigenschaften
Sie können nach den Eigenschaften von Elementen in Arrays filtern, indem Sie [] an den Namen der Array-Eigenschaft anhängen.
Rückgabeströme, die bestimmten Quellverbindungen zugeordnet sind:
GET /flows?property=sourceConnectionIds[]==9874984,6980696
Rückgabe von Flüssen mit einer Transformation, die einen bestimmten Selektorwert-ID enthält:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a
Quellverbindungen mit einer Spalte mit einem bestimmten name zurückgeben:
GET /sourceConnections?property=params.columns[].name==firstName
Suchen der Flussausführungs-ID für ein Ziel durch Filtern nach Segment-ID:
GET /runs?property=metrics.recordSummary.targetSummaries[].entitySummaries[].id==segment:068d6e2c-b546-4c73-bfb7-9a9d33375659
count
Jede Filterabfrage kann mit count Abfrageparameter mit dem Wert true angehängt werden, um die Anzahl der Ergebnisse zurückzugeben. Die API-Antwort enthält eine count-Eigenschaft, deren Wert die Anzahl der insgesamt gefilterten Elemente darstellt. Die tatsächlich gefilterten Elemente werden in diesem Aufruf nicht zurückgegeben.
Gibt die Anzahl der aktivierten Flüsse im System zurück:
GET /flows?property=state==enabled&count=true
Die Antwort auf die obige Abfrage würde wie folgt aussehen:
{
"count": 95
}
Filternde Eigenschaften nach Ressource
Je nach abgerufener Flow Service-Entität können verschiedene Eigenschaften zum Filtern verwendet werden. Die folgenden Tabellen enthalten die Felder auf der Stammebene für jede Ressource, die häufig bei der Filterung von Anwendungsfällen verwendet werden.
connectionSpec
id/connectionSpecs?property=id==736873,9485095name/connectionSpecs?property=name==TestConnproviderId/connectionSpecs?property=providerId==3897933attributes.{ATTRIBUTE_NAME}/connectionSpecs?property=attributes.sampleAttribute="abc"flowSpec
id/flowSpecs?property=id==736873,9485095name/flowSpecs?property=name==TestConnproviderId/flowSpecs?property=providerId==3897933connection
id/connections?property=id==736873,9485095name/connections?property=name==TestConndescription/connections?property=description==Test%20descriptionconnectionSpec.id/connections?property=connectionSpec.id==938903,849048state/connections?property=state==enabledsourceConnection
id/sourceConnections?property=id==736873,9485095connectionSpec.id/sourceConnections?property=connectionSpec.id==938903,849048baseConnectionId/sourceConnections?property=baseConnectionId==983908,4908095targetConnection
id/targetConnections?property=id==736873,9485095connectionSpec.id/targetConnections?property=connectionSpec.id==938903,849048baseConnectionId/targetConnections?property=baseConnectionId==983908,4908095flow
id/flows?property=id==736873,9485095name/flows?property=name==TestFlowdescription/flows?property=description==Test%20descriptionflowSpec.id/flows?property=flowSpec.id==938903,849048state/flows?property=state==enabledsourceConnectionIds/flows?property=sourceConnectionIds[]==9874984,6980696targetConnectionIds/flows?property=targetConnectionIds[]==598590,690666run
id/runs?property=id==736873,9485095flowId/runs?property=flowId==8749844state/runs?property=state==inProgressAnwendungsszenarien
In diesem Abschnitt finden Sie einige spezifische Beispiele für die Verwendung von Filtern und Sortieren zur Rückgabe von Informationen zu bestimmten Connectoren oder zur Unterstützung bei der Fehlerbehebung. Wenn es zusätzliche Anwendungsfälle gibt, die Adobe hinzufügen soll, verwenden Sie bitte die Detaillierte Feedback-Optionen auf der Seite, um eine Anfrage zu senden.
Filtern, um Verbindungen nur zu einem bestimmten Ziel zurückzugeben
Sie können Filter verwenden, um nur Verbindungen zu bestimmten Zielen zurückzugeben. Fragen Sie zunächst den connectionSpecs-Endpunkt wie folgt ab:
GET /connectionSpecs
Suchen Sie dann nach dem gewünschten connectionSpec, indem Sie den name überprüfen. Suchen Sie beispielsweise im name nach Amazon Ads, Pega, SFTP usw. Der entsprechende id ist die connectionSpec, nach der Sie im nächsten API-Aufruf suchen können.
Filtern Sie beispielsweise Ihre Ziele so, dass nur bestehende Verbindungen an Amazon S3-Verbindungen zurückgegeben werden:
GET /connections?property=connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81
Filter, um nur Datenflüsse an Ziele zurückzugeben
Wenn Sie den /flows-Endpunkt abfragen, können Sie anstatt alle Quell- und Ziel-Datenflüsse zurückzugeben, einen Filter verwenden, um nur Datenflüsse an Ziele zurückzugeben. Verwenden Sie dazu isDestinationFlow als Abfrageparameter wie folgt:
GET /flows?property=inheritedAttributes.properties.isDestinationFlow==true
Filter, um Datenflüsse nur an eine bestimmte Quelle oder ein bestimmtes Ziel zurückzugeben
Sie können Datenflüsse filtern, um Datenflüsse an ein bestimmtes Ziel oder nur aus einer bestimmten Quelle zurückzugeben. Filtern Sie beispielsweise Ihre Ziele so, dass nur bestehende Verbindungen an Amazon S3-Verbindungen zurückgegeben werden:
GET /flows?property=inheritedAttributes.targetConnections[].connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81
Filtern, um alle Ausführungen eines Datenflusses für einen bestimmten Zeitraum abzurufen
Sie können Datenflussausführungen eines Datenflusses filtern, um nur Ausführungen in einem bestimmten Zeitintervall zu betrachten, wie unten dargestellt:
GET /runs?property=flowId==<flow-id>&property=metrics.durationSummary.startedAtUTC>1593134665781&property=metrics.durationSummary.startedAtUTC<1653134665781
Filter, um nur fehlgeschlagene Datenflüsse zurückzugeben
Zu Debuggingzwecken können Sie alle fehlgeschlagenen Datenflussausführungen für einen bestimmten Quell- oder Zieldatenfluss filtern und anzeigen, wie unten dargestellt:
GET /runs?property=flowId==<flow-id>&property=metrics.statusSummary.status==Failed
Nächste Schritte
In diesem Handbuch wurde beschrieben, wie Sie die Abfrageparameter orderby und property verwenden, um Antworten in der Flow Service-API zu sortieren und zu filtern. Eine schrittweise Anleitung zur Verwendung der API für gängige Workflows in Experience Platform finden Sie in den API-Tutorials in der Dokumentation Quellen und Ziele.