Agregar o actualizar valores
En esta unidad se exploran las plantillas de directivas que puede aplicar para establecer valores de datos en la solicitud y la respuesta de la API. El escenario más común es establecer los valores requeridos por la API en el cuerpo, encabezado o consulta de la solicitud para que el fabricante no tenga que proporcionarlos. Las directivas son flexibles para gestionar diversas tareas relacionadas con la configuración de datos a petición y respuesta. Las siguientes plantillas de directivas están disponibles y se centran en establecer valores de datos:
Establecer propiedad: agregue o actualice una propiedad en un objeto o colección.
Establecer el parámetro de cadena de consulta: agregue o actualice un parámetro en la cadena de consulta.
Establecer encabezado HTTP: agregue o actualice un valor en el encabezado de la solicitud y/o respuesta.
Utilizar la plantilla de directiva Establecer propiedad
La plantilla de directiva Establecer propiedad se puede utilizar para establecer o actualizar valores del cuerpo de la solicitud o de los objetos de la respuesta. Puede establecer un valor constante mediante un valor de cadena o una expresión utilizando @body() para obtener otro valor existente del objeto del cuerpo. En el siguiente ejemplo se muestra cómo establecer un valor constante en el cuerpo de la respuesta.
Si observa la respuesta después de implementar la plantilla de directiva, verá la siguiente imagen.
En el ejemplo anterior se muestra que la operación ListInvoice devuelve un objeto con una factura de propiedad que es una matriz de objetos de factura. Si quisiera establecer la propiedad de prefijo en cada factura en la matriz de facturas, cambiaría su objeto principal o la ruta de la colección para que se parezca a la siguiente imagen.
La salida que obtendría después de realizar ese cambio sería similar a la siguiente imagen.
También puede hacer referencia a otros valores en el cuerpo que ya están configurados. Por ejemplo, la siguiente imagen muestra que la propiedad FullValue incluye la propiedad Prefijo.
Observe que el campo Valor para agregar contiene la expresión {@body().Prefix} para obtener el valor del prefijo del cuerpo. Debe escribir la expresión entre llaves ({expression}) para que funcione.
Solo funciona hacer referencia a la expresión @body en este campo; no se admite el uso de otras expresiones, como @connectionProperties, @headers o @queryParameters.
Usar la plantilla de directiva Establecer parámetro de cadena de consulta
La directiva de plantilla Establecer parámetro de cadena de consulta se puede utilizar para agregar o actualizar parámetros de consulta en la solicitud. Debido a que la cadena de consulta solo importa en la solicitud, no es necesario establecer el valor Ejecutar directiva en. A diferencia de la directiva Establecer propiedad, que siempre establece el valor aunque exista, esta directiva es configurable. Puede establecer la acción, si el parámetro existe, en una de las siguientes opciones:
Reemplazar: reemplaza el valor existente.
Omitir: el valor existente no se reemplaza.
Anexar: el valor de la plantilla de directiva se anexa al valor existente.
Esta función puede darle control sobre cuándo se usa el valor, por lo que es un buen enfoque para proporcionar valores predeterminados. Un ejemplo de este enfoque es el conector de Microsoft Outlook, que tiene una directiva Establecer parámetro de cadena de consulta que permite establecer un valor predeterminado de 50 para el parámetro $top. En el siguiente ejemplo, se muestra el aspecto de la plantilla de directiva.
Tenga en cuenta que se usó la opción Omitir para el valor Acción si existe el parámetro de consulta a fin de garantizar que esta directiva solo se utilice como predeterminada.
Utilizar la plantilla de directiva Establecer encabezado HTTP
Puede usar la plantilla de directiva Establecer encabezado HTTP para agregar o actualizar valores en el encabezado de la solicitud, respuesta o fallo. De manera similar a la plantilla de directiva Establecer cadena de consulta, puede elegir la acción si el valor ya existe. La plantilla de directiva se usa con más frecuencia para establecer los valores de encabezado que espera la API, como la identificación del remitente, ETag para el seguimiento de cambios o encabezados de clave de API especiales que no se gestionan mediante la configuración normal del conector. Por ejemplo, el conector de Azure Cognitive Services usa una plantilla de directiva Establecer encabezado para establecer el valor de encabezado X-Ms-Sender en Microsoft Azure Logic Apps. En el siguiente ejemplo, se muestra el aspecto de una plantilla directiva.
El uso de estas plantillas de directiva le permite establecer los valores que espera la API. También puede usarlos para establecer valores en la respuesta que podrían simplificar la tarea del fabricante de consumir los datos. Estas directivas también se pueden utilizar para establecer valores predeterminados cuando aún no se ha proporcionado ninguno. Puede utilizar varias directivas en un orden específico para componer valores más complejos.