Actualizar registro

Punto final de la API que actualizará un registro existente.

Nota: Esta documentación de la API pretende ofrecer al lector una visión general de las capacidades de la API y de cómo acceder a ellas. Cuando intente escribir llamadas a la API, le recomendamos encarecidamente que utilice la documentación de la API directamente asociada a la clave de API específica a la que vaya 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 le permitirá copiar y pegar directamente los fragmentos de código de la documentación en su código. Si intentara utilizar los ejemplos de esta documentación, tendría que modificarlos para los campos, ID de formulario, etc.

Solicitud HTTP

PUThttps://api.gwapps.com/v1/forms/formId/records/recordId

Parámetros

Parámetro	Descripción	Tipo
Parámetros de ruta necesarios
formId	El formId actual 66b18359dc7659dc4cb98d15	cadena
recordId	El recordId	cadena

Solicitar cuerpo

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

Ejemplo de solicitud

PUThttps://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records/recordId

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

iniciar

Nota: Si pasa un campo que no existe en el formulario actual obtendrá un mensaje Bad Request lo mismo ocurre con las etapas que no existen en el formulario. Puede echar un vistazo en la sección Visión general para revisar los campos y etapas disponibles para este formulario.
Sólo se actualizarán los códigos cortos pasados en la solicitud. Si desea borrar un campo, debe pasar explícitamente el código corto del campo con un valor nulo.

Etapa Valor

iniciar

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

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

iniciar

Nota: Si no se especifica un código corto de campo en el momento de la actualización, no se modifica. Para eliminar un valor de campo de un registro, debe establecerlo explícitamente como nulo.

  {
      "field1": null // deletes field1 from this record
  }

Respuesta

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

Atributo	Descripción	Tipo
_id	ID del registro	cadena
escenario	El escenario del disco	Escenario
código corto	Depende del tipo de campo	Cada valor es diferente según el tipo de campo

Ejemplo de respuesta

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

Artículos relacionados con la API

Este artículo contiene información detallada sobre una llamada o un punto final específicos de la API. Los detalles de la estructura general de la API de registros y las llamadas/puntos finales se pueden encontrar en el artículo de la API de registros de GW Apps. La información sobre la creación de claves de API se puede encontrar en la sección API de la configuración de la plataforma y en la sección Seguridad > Claves de API de Editar aplicación dentro de cada aplicación.