Actualizar registro

Punto de conexión de API que actualizará un registro existente.

Nota: Esta documentación de la API tiene como objetivo brindar al lector una descripción general de las capacidades de la API y cómo acceder a ellas. Al intentar escribir llamadas a la API, recomendamos encarecidamente que utilice la documentación de la API asociada directamente con la clave de API específica que va a llamar. Esa documentación incluye ejemplos con los ID reales del formulario y los elementos del formulario, incluye ejemplos para cada campo disponible en los formularios asociados, etc. Esto permitirá copiar y pegar directamente los fragmentos de código de la documentación en su código. Si intentara usar los ejemplos de esta documentación, tendría que modificarlos para los campos, el ID del formulario, etc.

Solicitud HTTP

PUT https://api.gwapps.com/v1/forms/IdFormulario/registros/ID de registro

Parámetros

Parámetro	Descripción	Escribir
Parámetros de ruta requeridos
IdFormulario	El formId actual 66b18359dc7659dc4cb98d15	cadena
ID de registro	El recordId	cadena

Cuerpo de la solicitud

Parámetro	Descripción	Escribir
Parámetros requeridos
escenario	La etapa que tendrá el registro, esta etapa debe existir bajo las etapas de flujo de trabajo definidas en el formulario	cadena | objeto
Código de Campo*	Cada campo en el formulario tiene un shortCode único. Puede encontrar los Códigos Cortos de Campo en la sección “Descripción general” del formulario. También puede actualizar sus Códigos Cortos de Campo desde las Propiedades del Campo en el Diseñador de Formularios.	* Depende del tipo de campo. Consulte la sección “Descripción general” del formulario.

Solicitud de ejemplo

PUT https://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/registros/ID de registro

{
  "stage": "stg0",
  "text1": "Juan",
  "number1": 10,
  "currency1": {
    "code": "USD",
    "value": 120
  }
}

comenzar

Nota: Si pasas un campo que no existe en el formulario actual, recibirás un Solicitud incorrecta Respuesta de error; lo mismo se aplica a las etapas que no existen en el formulario. Puedes consultar la sección «Resumen» para revisar los campos y las etapas disponibles para este formulario.
Solo se actualizarán los códigos abreviados pasados en la solicitud. Si quieres borrar un campo, debes pasar explícitamente el código abreviado del campo con un valor nulo.

Valor de etapa

comenzar

Nota: La etapa de registro también podría pasarse como un objeto.

{
  "stage": {
    "id": "stg0",
    "status": "Borrador"
  }
}

comenzar

Nota: Si no se especifica un código abreviado de campo al momento de la actualización, este permanece sin cambios. Para eliminar el valor de un campo de un registro, debes establecerlo explícitamente como nulo.

  {
      "campo1": null // elimina el campo "campo1" de este registro
  }

Respuesta

La respuesta devuelta tendrá la información del registro, donde

Atributo	Descripción	Escribir
_id	El ID del registro	cadena
escenario	La etapa del disco	Escenario
códigoCorto	Depende del tipo de campo	Cada valor es diferente dependiendo del tipo de campo

Respuesta de ejemplo

{
  "kind": "form#record",
  "_id": "recordId",
  "meta": {
    "appId": "6266db8cbd86d9001a70c9ea",
    "formId": "66b18359dc7659dc4cb98d15"
  },
  "stage": {
    "id": "stg0",
    "status": "Borrador"
  },
  "text1": "John",
  "number1": 10,
  "currency1": {
    "code": "USD",
    "value": 120
  }
}

Artículos relacionados con la API

Este artículo cubre los detalles de una llamada/endpoint de API específico. Los detalles de la estructura general de la API de Registros y las llamadas/endpoints se pueden encontrar en la API de Registros de GW Apps artículo. Puede encontrar información sobre cómo crear claves de API dentro del Sección API de la Configuración de la plataforma, y en Seguridad > Claves API sección de Editar Aplicación dentro de cada aplicación.