Obtener registro

Punto final de la API que devolverá el registro solicitado por ID.

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

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

Parámetros

ParámetroDescripciónTipo
Parámetros de ruta necesarios
formIdEl formId actual 66b18359dc7659dc4cb98d15cadena
recordIdEl recordIdcadena
Parámetros de consulta opcionales
camposLista de campos separados por comas (consulte la sección Descripción general para obtener la lista de campos disponibles)cadena
includeAttachmentsDevuelve los adjuntos con un enlace descargable cuando los datos del registro contienen campos de adjuntos. El enlace url de cada archivo adjunto tiene una caducidad de 10 minutos.booleano

Ejemplo de solicitud

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

Respuesta

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

AtributoDescripciónTipo
_idID del registrocadena
escenarioEl escenario del discoEscenario
código cortoDepende del tipo de campoCada valor es diferente según el tipo de campo

Ejemplo de respuesta

{
  "kind": "form#record",
  "_id": "recordId",
  "meta": {
    "appId": "6266db8cbd86d9001a70c9ea",
    "formId": "66b18359dc7659dc4cb98d15"
  },
  "stage": "stg0",
  "text1": "Example Text"
}

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.

Actualizado el 27 de agosto de 2024
¿Le ha resultado útil este artículo?

Artículos relacionados