Actualizar anexos de registros

Punto final de la API para actualizar un registro cargando archivos en campos del tipo 'Adjunto '.

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/attachments

iniciar

Nota: Este endpoint es exclusivo para subir adjuntos al registro con campos File Picker, sólo estos campos pueden ser actualizados a través de este endpoint.

Parámetros

Parámetro	Descripción	Tipo
Parámetros de ruta necesarios
formId	El formId actual 66b18359dc7659dc4cb98d15	cadena
recordId	El recordId	cadena
Parámetros de consulta opcionales
replaceAttachments	Si el parámetro de consulta se pasa con el valor true reemplazará los adjuntos existentes en los datos del campo, de lo contrario añadirá los adjuntos a los datos del campo actual	booleano

iniciar

Nota: Para subir los archivos, la petición HTTP debe ser multipart/form-data para poder enviar los archivos al endpoint. Los nombres de los campos de la solicitud son los códigos abreviados de los campos y los valores son los archivos adjuntos que se van a cargar.

Solicitar cuerpo

Parámetro	Descripción	Tipo
Parámetros requeridos
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.	* Sólo se admiten los campos del selector de archivos. Consulte el formulario "Visión general".

Ejemplo de solicitud

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

advertencia

Asegúrese de revisar la validación aplicada al campo File Picker en el diseño del formulario, ya que este endpoint valida el tipo de archivo y el tamaño de archivo permitido en el campo, si los campos a subir no coinciden con la validación el endpoint devolverá un array de errores para cada archivo y el mensaje de error donde no se cumplió la validación.

Ejemplo de respuesta de error

{
  "error": [
    {
      "fieldCode": "attachment1",
      "fileName": "file.zip",
      "mimeType": "application/zip",
      "message": "This file type is not supported."
    },
    {
      "fieldCode": "attachment1",
      "fileName": "file.md",
      "mimeType": "text/markdown",
      "message": "This file type is not supported."
    }
  ]
}

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.