Cómo proporcionar un cuerpo de solicitud

Proporcione el cuerpo de solicitud que es necesario para una solicitud REST mediante el método POST o PUT.

Los siguientes procedimientos se pueden utilizar para configurar un cuerpo de solicitud en la URL HTTP principal o la URL de sondeo y la URL de terminación opcionales.

Adición del cuerpo de solicitud

Actualmente, solo JSON es el formato soportado para un cuerpo de solicitud.

Para crear un cuerpo de solicitud:

  1. En el paso Definir Detalles de Ejecución de la página Configurar los Detalles de la API REST, seleccione Solicitar para crear un cuerpo de solicitud para la tarea de REST.

    Para crear un cuerpo de solicitud para una 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 Solicitud.

    Si no ve el separador Solicitud, asegúrese de haber seleccionado el método HTTP adecuado.

  2. En el editor, introduzca el cuerpo de la solicitud.
    • Puede escribir o copiar y pegar toda la carga útil.

    • Puede hacer referencia a parámetros existentes en la carga útil mediante la sintaxis ${}. Por ejemplo:

      {
          "modelType": "USER_PROJECT",
          "modelVersion": "20200901",
          "parentRef": {},
          "name": "${PROJECT_NAME}",
          "identifier": "${PROJECT_NAME}",
          "description": "Creating my project",
          "objectVersion": 0,
          "objectStatus": 8,
          "registryMetadata": {
              "registryVersion": 0
          }
      }
    Nota

    El validador incorporado en el editor valida el cuerpo de la solicitud. Si ve un punto rojo con una "x" en el lado del editor, desplácese sobre el icono para ver el error de esa línea de código.
  3. Para asignar un parámetro de tarea a todo el cuerpo de una solicitud, seleccione Exponer como parámetro de tarea. Consulte Parametrización del cuerpo de solicitud.

    Para editar el cuerpo de un cuerpo de solicitud con parámetros, edite el valor del parámetro.

Parametrización del cuerpo de solicitud

Además de utilizar parámetros en el cuerpo de la solicitud, puede establecer parámetros para todo el cuerpo de la solicitud.

Consulte Adición del cuerpo de solicitud.

Después de crear el cuerpo de la solicitud en el editor, puede asignar un parámetro de tarea a todo el cuerpo.

Para establecer parámetros para todo el cuerpo de la solicitud:

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

    Para parametrizar el cuerpo de la solicitud para una URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Solicitud.

  2. Seleccione Exponer como Parámetro de Tarea.

    Si aún no ha introducido el cuerpo de la solicitud, Data Integration muestra un mensaje de advertencia en un cuadro de diálogo. Introduzca primero un cuerpo de solicitud y, a continuación, asigne un parámetro a todo el cuerpo.

  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 del parámetro es JSON, que no puede cambiar.
  6. En el campo Valor, defina el JSON por defecto para este parámetro de tarea.
  7. Seleccione Agregar.
    El nombre del parámetro se agrega a la parte superior del editor.

Para editar el cuerpo de un cuerpo de solicitud con parámetros, edite el valor del parámetro.

Edición del valor de un parámetro de cuerpo de solicitud

Puede cambiar el valor por defecto del parámetro de tarea para el cuerpo de la solicitud.

Para editar el cuerpo de la solicitud con parámetros:

  1. En el paso Definir Detalles de Ejecución de la página Configurar Detalles de la API REST de un método POST o PUT, seleccione Solicitar.

    Para editar el cuerpo de solicitud con parámetros para una URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Solicitud.

  2. Seleccione Editar parámetro.
  3. En el panel Editar parámetro, solo puede editar el campo Valor. No puede cambiar el tipo de datos ni la descripción.

    Para editar la descripción, consulte Edición de un parámetro de tarea de REST.

  4. Seleccione Guardar.
Eliminación del parámetro del cuerpo de la solicitud

Al eliminar el parámetro, solo se elimina la asociación del parámetro al cuerpo de la solicitud en la tarea REST.

Para anular la asignación del parámetro de todo el cuerpo de la solicitud:

  1. En el paso Definir Detalles de Ejecución de la página Configurar Detalles de la API REST de un método POST o PUT, seleccione Solicitar.

    Para anular la asignación del parámetro del cuerpo de la solicitud para una URL de sondeo o terminación, vaya a la página Especificar criterios de finalización. En el separador Sondeo o Terminación, seleccione Solicitud.

  2. Seleccione Eliminar parámetro.
  3. En el cuadro de diálogo Eliminar parámetro, seleccione Eliminar.

    Se cancela la asignación del parámetro del cuerpo de la solicitud. El cuerpo de solicitud asignado al parámetro se convierte en el cuerpo de solicitud por defecto.

    Nota

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