Documentación de Oracle Cloud Infrastructure

Adición y gestión de una cabecera

Defina una o más cabeceras para pasar a la sección de cabecera de la solicitud de REST. Una cabecera tiene una clave y un valor. Están soportadas todas las cabeceras de solicitud de la API de REST estándar.

Por ejemplo, puede agregar la cabecera Content-Type para una solicitud POST o PUT.

Los siguientes procedimientos se pueden utilizar para agregar y gestionar cabeceras en la URL HTTP principal o la URL de sondeo y la URL de terminación opcionales.

Creación de una cabecera

Cree una cabecera de solicitud para el método HTTP principal o los métodos HTTP de sondeo y terminación opcionales.

Para crear una cabecera:

  1. En el paso Definir Detalles de Ejecución de la página Configurar los Detalles de la API REST, seleccione Cabecera para crear una cabecera para la tarea de REST.

    Para crear una cabecera para la URL de sondeo o de terminación, vaya a la página Especificar los criterios de finalización, active la casilla de control Configurar una condición de sondeo y de terminación para una llamada de REST sin espera. En el separador Sondeo o Terminación, seleccione Cabecera.

  2. Seleccione Agregar cabecera.
  3. En el campo Clave, comience a escribir el nombre de una cabecera.
    Cuando se encuentra una clave coincidente, se muestra una lista de sugerencias en un menú. Seleccione la cabecera que desee.
  4. En el campo Valor, comience a escribir el nombre del valor de cabecera.
    Cuando se encuentra un valor coincidente, se muestra una lista de sugerencias en un menú. Seleccione el valor de cabecera que desee.
  5. Seleccione Agregar.

    La clave y el valor de cabecera se agregan a la tabla Cabecera.

    Para asignar un parámetro para el valor del par clave-valor de cabecera, seleccione Exponer como parámetro de tarea. Consulte Parametrización de un valor de cabecera.

Edición de una cabecera

Puede editar la clave y el valor de una cabecera.

Si el valor de cabecera tiene parámetros, edite el parámetro para cambiar el valor de parámetro por defecto. Consulte Edición del valor de una cabecera con parámetros.

Para editar un par clave-valor de cabecera:

  1. En el paso Definir Detalles de Ejecución de la página Configurar los Detalles de la API REST, seleccione Cabecera para editar una cabecera en la tarea de REST.

    Para editar una cabecera para la URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Cabecera.

  2. En la fila de la tabla de una cabecera, seleccione Editar en el menú Acciones (Acciones, menú).
  3. En el panel Editar cabecera, cambie los valores de los campos Clave y Valor y seleccione Guardar.

    Al empezar a escribir en cualquiera de los campos, se muestra una lista de sugerencias en un menú cuando se encuentra un elemento coincidente. A continuación, puede seleccionar la clave de cabecera o el valor de cabecera que desee.

    Nota

    Si el valor del campo Valor es una cadena de parámetros como ${PARAMETER_HEADER} y sobrescribe la cadena con un valor de cabecera que coincida con la clave, el parámetro se elimina al seleccionar Guardar. Para volver a parametrizar el valor de cabecera, seleccione Exponer como parámetro de tarea, como se describe en Parámetros de un valor de cabecera.

Supresión de una cabecera

Al suprimir una cabecera, se elimina el par clave-valor de cabecera de la tarea de REST.

Para suprimir una cabecera:

  1. En el paso Definir Detalles de Ejecución de la página Configurar los Detalles de la API REST, seleccione Cabecera para suprimir una cabecera de la tarea de REST.

    Para suprimir una cabecera para la URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Cabecera.

  2. En la fila de la tabla de una cabecera, seleccione Suprimir en el menú Acciones (Acciones, menú).
  3. En el cuadro de diálogo Suprimir cabecera, seleccione Suprimir.

    El par clave-valor de cabecera se elimina de la tabla de cabecera.

    Nota

    Si se ha parametrizado el valor de cabecera, el parámetro asociado al valor de cabecera no se suprime. Para suprimir el parámetro, consulte Supresión de un parámetro de tarea de REST.
Parametrización de un valor de cabecera

Después de definir el par clave-valor para una cabecera, puede asignar un parámetro de tarea al valor de cabecera.

Para parametrizar el valor de cabecera de una cabecera:

  1. En el paso Definir Detalles de Ejecución de la página Configurar Detalles de API de la REST, seleccione Cabecera.

    Para parametrizar un valor de cabecera para la URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Cabecera.

  2. En la fila de la tabla de una cabecera, junto al valor de cabecera, seleccione Exponer como parámetro para tarea.
  3. En el panel Agregar parámetro, introduzca un nombre para el parámetro en el campo Identificador o utilice el valor por defecto.

    El nombre de parámetro debe ser único en la tarea de REST. Para obtener una lista actual de los parámetros de la tarea, consulte Visualización de todos los parámetros en una tarea de REST.

  4. (Opcional) Introduzca una Descripción para ayudar a identificar la finalidad del parámetro a otros usuarios.
  5. El tipo de datos es String. No puede cambiar el tipo de datos.
  6. Defina la duración.
  7. Defina el Valor por defecto del parámetro.
    El valor de cabecera por defecto se utiliza en tiempo de ejecución, a menos que cambie el valor en tiempo de diseño o en tiempo de ejecución.
  8. Seleccione Agregar.
    La fila de la tabla de la cabecera se actualiza con el nombre del parámetro junto al valor de la cabecera.
Edición del valor de una cabecera con parámetros

Solo puede cambiar el valor por defecto del parámetro.

Para editar el valor por defecto de un valor de cabecera con parámetros:

  1. En el paso Definir Detalles de Ejecución de la página Configurar Detalles de API de la REST, seleccione Cabecera.

    Para editar un valor de cabecera con parámetros para la URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Cabecera.

  2. En la fila de la tabla del valor de cabecera que desea cambiar, junto al nombre del parámetro, seleccione Editar parámetro.
  3. En el panel Editar parámetro, cambie el valor del parámetro.
  4. Seleccione Guardar.
Eliminación de un parámetro de valor de cabecera

Al eliminar un parámetro de valor de cabecera, solo se elimina la asociación del parámetro al valor de cabecera de la cabecera.

La eliminación del parámetro de valor de cabecera no suprime el par clave-valor de cabecera.

Para eliminar un parámetro de valor de cabecera:

  1. En el paso Definir Detalles de Ejecución de la página Configurar Detalles de API de la REST, seleccione Cabecera.

    Para eliminar un parámetro de valor de cabecera para la URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Cabecera.

  2. En la fila de la tabla del parámetro de valor de cabecera que desea eliminar, seleccione Eliminar parámetro.
  3. En el cuadro de diálogo Eliminar parámetro, seleccione Eliminar.

    Se anula la asignación del parámetro del valor de la cabecera. El valor asignado al parámetro se convierte en el valor de cabecera.

    Nota

    El parámetro de valor de cabecera no se suprime de la tarea de REST. Para suprimir el parámetro, consulte Supresión de un parámetro de tarea de REST.