Clasificación y filtrado de respuestas en la API de Flow Service
Al realizar solicitudes de listado (GET) en API de Flow Service, puede utilizar parámetros de consulta para ordenar y filtrar las respuestas. Esta guía proporciona una referencia sobre cómo utilizar estos parámetros para diferentes casos de uso.
Clasificación
Puede ordenar las respuestas mediante una orderby
parámetro de consulta. Los siguientes recursos se pueden ordenar en la API:
Para utilizar el parámetro, debe establecer su valor en la propiedad específica por la que desea ordenar (por ejemplo, ?orderby=name
). Puede anteponer el valor con un signo más (+
) para el orden ascendente o el signo menos (-
) en orden descendente. Si no se proporciona ningún prefijo de orden, la lista se ordena en orden ascendente de forma predeterminada.
GET /flows?orderby=name
GET /flows?orderby=-name
También se puede combinar un parámetro de clasificación con un parámetro de filtrado utilizando un símbolo "and" (&
).
GET /flows?property=state==enabled&orderby=createdAt
Filtro
Puede filtrar las respuestas mediante una property
parámetro con una expresión clave-valor. Por ejemplo, ?property=id==12345
solo devuelve recursos cuya id
propiedad es igual exactamente a 12345
.
El filtrado se puede aplicar genéricamente en cualquier propiedad de una entidad siempre y cuando se conozca la ruta válida a esa propiedad.
[]
) a la matriz en la ruta. Consulte la sección sobre filtrado en propiedades de matriz para ver ejemplos.Devolver todas las conexiones de origen donde el nombre de la tabla de origen es lead
:
GET /sourceConnections?property=params.tableName==lead
Devolver todos los flujos para un ID de segmento específico:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a
Combinación de filtros
Múltiple property
los filtros se pueden incluir en una consulta siempre que estén separados por caracteres "y" (&
). Se asume una relación AND al combinar filtros, lo que significa que una entidad debe satisfacer todos los filtros para que se incluya en la respuesta.
Devolver todos los flujos habilitados para un ID de segmento:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a&property=state==enabled
Filtrado en propiedades de matriz arrays
Puede filtrar basándose en las propiedades de los elementos dentro de las matrices añadiendo []
al nombre de la propiedad de matriz.
Devolver flujos asociados a conexiones de origen específicas:
GET /flows?property=sourceConnectionIds[]==9874984,6980696
Flujos de retorno que tienen una transformación que contiene un ID de valor de selector específico:
GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a
Devolver conexiones de origen que tengan una columna con un específico name
valor:
GET /sourceConnections?property=params.columns[].name==firstName
Busque el ID de ejecución de flujo de un destino filtrando por el ID de segmento:
GET /runs?property=metrics.recordSummary.targetSummaries[].entitySummaries[].id==segment:068d6e2c-b546-4c73-bfb7-9a9d33375659
count
Cualquier consulta de filtrado se puede anexar con count
parámetro de consulta con un valor de true
para devolver el recuento de los resultados. La respuesta de la API contiene un count
propiedad cuyo valor representa el recuento del total de elementos filtrados. Los elementos filtrados reales no se devuelven en esta llamada.
Devolver el recuento de flujos habilitados en el sistema:
GET /flows?property=state==enabled&count=true
La respuesta a la consulta anterior tendría el siguiente aspecto:
{
"count": 95
}
Propiedades filtrables por recurso
Según la entidad de Flow Service que esté recuperando, se pueden utilizar distintas propiedades para el filtrado. En las tablas siguientes se desglosan los campos de nivel raíz de cada recurso que se emplean comúnmente en los casos de uso de filtrado.
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
Casos de uso use-cases
Lea esta sección para ver algunos ejemplos específicos de cómo puede utilizar el filtrado y la ordenación para devolver información sobre determinados conectores o para ayudarle en los problemas de depuración. Si hay algún caso de uso adicional que le gustaría que el Adobe añadiera, utilice el Opciones de comentarios detalladas en la página para enviar una solicitud.
Filtre para devolver conexiones solo a un destino determinado
Puede utilizar filtros para devolver conexiones solo a determinados destinos. Primero, consulte connectionSpecs
como el siguiente:
GET /connectionSpecs
A continuación, busque el connectionSpec
inspeccionando el name
parámetro. Por ejemplo, busque Amazon Ads, Pega o SFTP, etc. en la name
parámetro. El correspondiente id
es el connectionSpec
que puede buscar por en la siguiente llamada de API.
Por ejemplo, filtre los destinos para que solo devuelvan las conexiones existentes a las conexiones de Amazon S3:
GET /connections?property=connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81
Filtre para devolver flujos de datos solo a destinos
Al consultar el /flows
extremo, en lugar de devolver todos los flujos de datos de origen y destino, puede utilizar un filtro para devolver solo los flujos de datos a los destinos. Para ello, utilice isDestinationFlow
como parámetro de consulta, así:
GET /flows?property=inheritedAttributes.properties.isDestinationFlow==true
Filtre para devolver flujos de datos solo a un origen o destino determinado
Puede filtrar los flujos de datos para devolver flujos de datos a un destino determinado o solo desde un origen determinado. Por ejemplo, filtre los destinos para que solo devuelvan las conexiones existentes a las conexiones de Amazon S3:
GET /flows?property=inheritedAttributes.targetConnections[].connectionSpec.id==4890fc95-5a1f-4983-94bb-e060c08e3f81
Filtre para obtener todas las ejecuciones de un flujo de datos durante un período de tiempo específico
Puede filtrar las ejecuciones de flujo de datos de un flujo de datos para ver solo las ejecuciones en un intervalo de tiempo determinado, como se muestra a continuación:
GET /runs?property=flowId==<flow-id>&property=metrics.durationSummary.startedAtUTC>1593134665781&property=metrics.durationSummary.startedAtUTC<1653134665781
Filtre para devolver solo los flujos de datos con errores
Para fines de depuración, puede filtrar y ver todas las ejecuciones de flujo de datos fallidas para un flujo de datos de origen o destino determinado, como se muestra a continuación:
GET /runs?property=flowId==<flow-id>&property=metrics.statusSummary.status==Failed
Pasos siguientes
En esta guía se explica cómo utilizar la variable orderby
y property
parámetros de consulta para ordenar y filtrar las respuestas en la API de Flow Service. Para obtener guías paso a paso sobre cómo utilizar la API para flujos de trabajo comunes en Platform, consulte los tutoriales de API contenidos en la orígenes y destinos documentación.