Contenido
Lista de proyectos
Servicio: /api/v1/admin/projects Tipo: GET Resultado: JSON
Trae la lista de proyectos
Ejemplo:
https://api.kontrolid.com/api/v1/admin/projects
Parámetros
Los parámetros son pares variable=valor que se especifican en la url adicionando un ? al final de la misma y que modifican los registros que se muestran en la consulta. Cuando se aplican varios filtros, estos se separan con &.
all=true
Cuando se especifica, trae la totalidad de proyectos existentes en la organización. Cuando no se especifica, sólo trae los proyectos asociado al usuario.
https://api.kontrolid.com/api/v1/admin/projects?all=true
links=true
Cuando se especifica, trae los enlaces asociados a los proyectos, por ejemplo, para consulta de grupo de tareas. Nota: Los enlaces se generan, aunque no existan grupo de tareas creadas y aparecerán vacíos en esos casos.
https://api.kontrolid.com/api/v1/admin/projects?all=true&links=true
Lista de formularios
Servicio: /api/v1/admin/surveys/(project id) Tipo: GET Resultado: JSON
Trae la lista de formularios asociados a un proyecto. Project id, se refiere al identificador del proyecto, el cual se puede traer desde el API anterior o desde el servidor en la lista de proyectos:
Ejemplo:
https://api.kontrolid.com/api/v1/admin/surveys/585
El JSON trae todos los parámetros y ajustes relacionados con el formulario. Siendo el más relevante el ident que corresponde al identificador del formulario y que lo necesitará si quiere traer información específica:
Parámetros
links=true
Cuando se especifica, trae los enlaces asociados a los formularios, por ejemplo, campañas relacionadas.
Lista de usuarios
Servicio: /api/v1/misc/userList/simple Tipo: GET Resultado: JSON
Trae la lista de usuarios de una organización. id se refiere al identificador único del usuario el cual lo puede usar por ejemplo en la asignación de tareas automáticamente:
Lista detallada de usuarios
Servicio: /surveyKPI/userList/ Tipo: GET Resultado: JSON
Trae la lista de usuarios con todos los detalles de proyectos, privilegios, roles y organizaciones a las que pertenece. Además, detalles de habilitaciones heredadas por la organización donde se encuentre. Podrá encontrar otra información que no comprenda bien o que desconozca. No se preocupe que corresponde a datos asignados a nivel superior desde el servidor o no usados actualmente.
Esta API produce mucha información que puede ser abrumadora. Recuerde que desde la aplicación del servidor usted puede exportar un archivo de Excel con la información organizada de privilegios, proyectos y roles, que puede ser más adecuada para sus necesidades.
La ruta para exportar dicho archivo es la siguiente: Usuarios -> Archivo -> Exportar:
El archivo Excel luce así:
El API de la Lista detallada de usuarios se recomienda usar sólo en casos que de manera dinámica requiera para conectar con otras apis o procesos automatizados.
El siguiente ejemplo muestra un lista de una organización “Prueba ALEX” que tiene 2 usuarios. Los datos relevantes aparecen resaltados tales como la organización actual, los privilegios asignados (groups), proyectos donde está (projects), roles asignados (roles) y organizaciones a las que pertenece (orgs)
https://api.kontrolid.com/surveyKPI/userList
