Punto final de la API para eliminar archivos adjuntos de 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/attachments/delete
iniciar
Nota: Este endpoint es exclusivo para eliminar adjuntos de registros 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 |
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/delete
iniciar
Nota: Cada código corto para el campo selector de archivos contendrá la matriz de ids de archivos que desea eliminar del registro.
{
"attachment1": [
"file1.pdf",
"file2.pdf"
],
"attachment2": [
"file3.pdf"
]
}
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.