Tri et filtrage des réponses dans l’API Flow Service

Lors de l’exécution de requêtes de liste (GET) dans l’ API Flow Service, vous pouvez utiliser des paramètres de requête pour trier et filtrer les réponses. Ce guide fournit une référence pour l’utilisation de ces paramètres pour différents cas d’utilisation.

Tri

Vous pouvez trier les réponses à l’aide d’un paramètre de requête orderby. Les ressources suivantes peuvent être triées dans l’API :

Pour utiliser le paramètre , vous devez définir sa valeur sur la propriété spécifique par laquelle vous souhaitez effectuer un tri (par exemple, ?orderby=name). Vous pouvez ajouter un signe plus (+) en préfixe à la valeur pour l’ordre croissant ou un signe moins (-) pour l’ordre décroissant. Si aucun préfixe d’ordre n’est fourni, la liste est triée par défaut dans l’ordre croissant.

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

Vous pouvez également combiner un paramètre de tri avec un paramètre de filtrage à l’aide d’un symbole "et" (&).

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

Filtrage

Vous pouvez filtrer les réponses en utilisant un paramètre property avec une expression clé-valeur. Par exemple, ?property=id==12345 renvoie uniquement les ressources dont la propriété id est exactement égale à 12345.

Le filtrage peut être appliqué de manière générique sur n’importe quelle propriété d’une entité tant que le chemin d’accès valide à cette propriété est connu.

Renvoie toutes les connexions source dont le nom de la table source est lead:

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

Renvoie tous les flux pour un identifiant de segment spécifique :

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

Combinaison de filtres

Plusieurs property filtres peuvent être inclus dans une requête à condition qu’ils soient séparés par des caractères "et" (&). Une relation ET est supposée lors de la combinaison de filtres, ce qui signifie qu’une entité doit satisfaire tous les filtres pour qu’elle soit incluse dans la réponse.

Renvoie tous les flux activés pour un identifiant de segment :

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

Filtrage sur les propriétés de tableau arrays

Vous pouvez filtrer selon les propriétés des éléments dans les tableaux en ajoutant [] au nom de la propriété de tableau.

Flux de retour associés à des connexions source spécifiques :

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

Les flux de retour qui ont une transformation contenant un identifiant de valeur de sélecteur spécifique :

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

Renvoie les connexions source qui ont une colonne avec une valeur name spécifique :

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

Recherchez l’ID d’exécution de flux pour une destination en filtrant sur l’ID de segment :

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

count

Toute requête de filtrage peut être ajoutée avec un paramètre de requête count avec une valeur true pour renvoyer le nombre de résultats. La réponse de l’API contient une propriété count dont la valeur représente le nombre total d’éléments filtrés. Les éléments filtrés réels ne sont pas renvoyés dans cet appel.

Renvoie le nombre de flux activés dans le système :

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

La réponse à la requête ci-dessus ressemblerait à ce qui suit :

{
  "count": 95
}

Propriétés filtrables par ressource

Selon l’entité de service de flux que vous récupérez, différentes propriétés peuvent être utilisées pour le filtrage. Les tableaux ci-dessous ventilent les champs au niveau racine pour chaque ressource couramment utilisée dans les cas d’utilisation de filtrage.

connectionSpec

flowSpec

connection

sourceConnection

targetConnection

flow

run

Cas d’utilisation use-cases

Lisez cette section pour obtenir des exemples spécifiques sur l’utilisation du filtrage et du tri afin de renvoyer des informations sur certains connecteurs ou de vous aider à résoudre les problèmes de débogage. Si vous souhaitez ajouter d’autres cas pratiques, utilisez les options de commentaire détaillées sur la page pour envoyer une demande.

Filtre pour renvoyer des connexions à une destination spécifique uniquement

Vous pouvez utiliser des filtres pour renvoyer des connexions à certaines destinations uniquement. Tout d’abord, interrogez le point d’entrée connectionSpecs comme ci-dessous :

GET /connectionSpecs

Recherchez ensuite le connectionSpec souhaité en examinant le paramètre name. Par exemple, recherchez Amazon Ads, Pega ou SFTP, etc. dans le paramètre name . Le id correspondant est le connectionSpec que vous pouvez rechercher dans l’appel API suivant.

Par exemple, filtrez vos destinations pour ne renvoyer que les connexions existantes aux connexions Amazon S3 :

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

Filtre pour renvoyer des flux de données vers des destinations uniquement

Lors de l’interrogation du point de terminaison /flows, au lieu de renvoyer tous les flux de données de sources et de destinations, vous pouvez utiliser un filtre pour renvoyer uniquement les flux de données aux destinations. Pour ce faire, utilisez isDestinationFlow comme paramètre de requête, comme suit :

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

Filtre pour renvoyer des flux de données vers une source ou une destination spécifique uniquement

Vous pouvez filtrer les flux de données pour renvoyer les flux de données vers une certaine destination ou depuis une certaine source uniquement. Par exemple, filtrez vos destinations pour ne renvoyer que les connexions existantes aux connexions Amazon S3 :

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

Filtre pour obtenir toutes les exécutions d’un flux de données pour une période spécifique

Vous pouvez filtrer les exécutions de flux de données d’un flux de données afin de ne consulter que les exécutions dans un certain intervalle de temps, comme ci-dessous :

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

Filtre pour renvoyer les flux de données en échec uniquement

À des fins de débogage, vous pouvez filtrer et afficher toutes les exécutions de flux de données ayant échoué pour un certain flux de données source ou de destination, comme ci-dessous :

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

Étapes suivantes

Ce guide explique comment utiliser les paramètres de requête orderby et property pour trier et filtrer les réponses dans l’API Flow Service. Pour obtenir des guides détaillés sur l’utilisation de l’API pour les processus courants dans Platform, consultez les tutoriels sur l’API contenus dans la documentation sources et destinations .