Punto final de la API que devolverá la lista de registros, con soporte para búsqueda general y filtros básicos.
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
Parámetros
| Parámetro | Descripción | Tipo | Por defecto |
|---|---|---|---|
| Parámetros de consulta opcionales | |||
| campos | Lista de campos separados por comas (consulte la sección Descripción general para obtener la lista de campos disponibles) | cadena | |
| maxResultado | Número máximo de entradas devueltas en una página de resultados. Por defecto, el valor es 100. El intervalo válido es de 1 a 200. | número | 100 |
| númeroDePágina | El número de página, la respuesta devolverá la bandera hasNext que se puede utilizar para comprobar si hay más páginas e incrementar el pageNumber hasta que no haya más páginas que devolver. | número | 1 |
| orderBy | Una lista de campos separados por comas. p. ej. stage para ordenar la lista en orden ascendente y -stage para ordenar la lista en orden descendente. | cadena | |
| q | Una cadena para buscar en los campos del registro. | cadena | |
Ejemplo de solicitud
GEThttps://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records
Respuesta
La respuesta devuelta tendrá un array de registros, donde
| Atributo | Descripción | Tipo |
|---|---|---|
| cuente | Total de usuarios | número |
| actual | Número de página actual | número |
| totalPáginas | Total de páginas | número |
| hasNext | Tiene una página siguiente | booleano |
| registros | Lista de registros | Matriz |
| registros._id | ID del registro | cadena |
| records.stage | El escenario del disco | Escenario |
| records.shortCode | Depende del tipo de campo | Cada valor es diferente según el tipo de campo |
Ejemplo de respuesta
{
"kind": "form#records",
"count": 5,
"current": 1,
"hasNext": false,
"totalPages": 1,
"records": [
{
"_id": "recordId",
"meta": {
"appId": "6266db8cbd86d9001a70c9ea",
"formId": "66b18359dc7659dc4cb98d15"
},
"stage": "stg0"
}
]
}
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.