GET /users

Contents[Hide]

Obtiene información de los usuarios definidos en el sistema.

Como veremos a continuación, se puede obtener una lista completa o un subconjunto filtrado en base a diferentes criterios (id de usuario, nombre, email, etc).

 

GET /users.json Obtiene todos los usuarios
GET /users/12.json
GET /users.json?id=12
Obtiene el usuario cuyo id es el 12.
GET /users.json?form[role]=Administrador%20maestro Obtiene los usuarios que cumplen los criterios de búsqueda especificados.
En este caso que tengan el rol de Administrador maestro.

NOTA : Los campos con espacios deben estar dentro de elementos form[] y los espacios deben sustituirse por %20

 

1. Criterios de búsqueda

 

NombreTipoValores posiblesDescripción
id Entero Cualquiera Identificador del usuario
login Texto Cualquiera Login del usuario
descr Texto Cualquiera Descripción del usuario
timeout Entero Cualquiera Timeout de sesión del usuario
firstname Texto Cualquiera Nombre del usuario
lastname Texto Cualquiera Apellidos del usuario
email Texto Cualquiera Correo electrónico del usuario
language Texto es_ES | en_US Idioma de la interfaz gráfica del usuario
role Texto Cualquiera Rol del usuario

 

Nota: en caso de querer realizar un OR en un mismo campo hay que separar los valores con comas.
Ejemplo: rol=networking,storage

 

2. Operadores

 

OperadorEquivalencia
CNMGT >
CNMGTE >=
CNMLT <
CNMLTE <=
CNMLIKE LIKE
CNMNLIKE NOT LIKE
CNMEQ =
CNMNEQ !=

3.  

4. Campos auxiliares

 

CampoDescripción
cnm_page_size Número de elementos por página. Por defecto devuelve 100 elementos
cnm_page Número de página
cnm_fields Campos que queremos que devuelva separados por comas
cnm_sort Campo por el que queremos que ordene (ponerle un - en caso de querer ordenar de forma descendente por dicho campo)
En caso de querer ordenar por varios campos, dichos campos deben ir separados por comas

 

5. Valor devuelto

 

Devuelve un vector de datos codificado en json.

6.  

7. Ejemplos

 

cnm@cnm002:/tmp$ curl -ki "https://localhost/onm/api/1.0/auth/token.json?u=admin&p=cnm123"
HTTP/1.1 200 OK
Date: Mon, 22 Sep 2014 09:13:28 GMT
Server: Apache/2.2.16 (Debian) PHP/5.3.3-7 with Suhosin-Patch proxy_html/3.0.1 mod_ssl/2.2.16 OpenSSL/0.9.8o mod_perl/2.0.4 Perl/v5.10.1
X-Powered-By: PHP/5.3.3-7
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
:
Vary: Accept-Encoding
Content-Length: 59
Content-Type: text/html; charset=utf-8

{"status":0,"sessionid":"343413375b6408847345a0358db4f247"}

cnm@cnm002:/tmp$ curl -ki -g -H "Authorization: 343413375b6408847345a0358db4f247" -X GET "https://localhost/onm/api/1.0/users.json"
HTTP/1.1 200 OK
Date: Mon, 22 Sep 2014 09:13:41 GMT
Server: Apache/2.2.16 (Debian) PHP/5.3.3-7 with Suhosin-Patch proxy_html/3.0.1 mod_ssl/2.2.16 OpenSSL/0.9.8o mod_perl/2.0.4 Perl/v5.10.1
X-Powered-By: PHP/5.3.3-7
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
:
Vary: Accept-Encoding
Content-Length: 1130
Content-Type: text/html; charset=utf-8

[{"id":"6","login":"ssv","descr":"Nueva descripcion","timeout":"3333","firstname":"Sergio","lastname":"Apellido1 Apellido2","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Administrador maestro"},{"id":"5","login":"amazon","descr":"Empresa: Amazon","timeout":"1440","firstname":"amazon","lastname":"Empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Usuario web"},{"id":"4","login":"cocacola","descr":"Empresa: Coca Cola","timeout":"1440","firstname":"Coca Cola","lastname":"Empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Usuario web"},{"id":"3","login":"pepsito","descr":"Empresa: Pepsico","timeout":"1440","firstname":"pepsico","lastname":"Empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Usuario web"},{"id":"2","login":"s30labs","descr":"Empresa: S30Labs","timeout":"1440","firstname":"s30labs","lastname":"empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"en_US","role":"Usuario web"},{"id":"1","login":"admin","descr":"Usuario Administrador","timeout":"1440","firstname":"","lastname":"","email":"","language":"es_ES","role":"Administrador maestro"}]

cnm@cnm002:/tmp$ curl -ki -g -H "Authorization: 343413375b6408847345a0358db4f247" -X GET "https://localhost/onm/api/1.0/users.json?language=es_ES"
HTTP/1.1 200 OK
Date: Mon, 22 Sep 2014 09:14:09 GMT
Server: Apache/2.2.16 (Debian) PHP/5.3.3-7 with Suhosin-Patch proxy_html/3.0.1 mod_ssl/2.2.16 OpenSSL/0.9.8o mod_perl/2.0.4 Perl/v5.10.1
X-Powered-By: PHP/5.3.3-7
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
:
Vary: Accept-Encoding
Content-Length: 943
Content-Type: text/html; charset=utf-8

[{"id":"6","login":"ssv","descr":"Nueva descripcion","timeout":"3333","firstname":"Sergio","lastname":"Apellido1 Apellido2","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Administrador maestro"},{"id":"5","login":"amazon","descr":"Empresa: Amazon","timeout":"1440","firstname":"amazon","lastname":"Empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Usuario web"},{"id":"4","login":"cocacola","descr":"Empresa: Coca Cola","timeout":"1440","firstname":"Coca Cola","lastname":"Empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Usuario web"},{"id":"3","login":"pepsico","descr":"Empresa: Pepsico","timeout":"1440","firstname":"pepsico","lastname":"Empresa","email":" Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla. ","language":"es_ES","role":"Usuario web"},{"id":"1","login":"admin","descr":"Usuario Administrador","timeout":"1440","firstname":"","lastname":"","email":"","language":"es_ES","role":"Administrador maestro"}]

cnm@cnm002:/tmp$ curl -ki -g -H "Authorization: 343413375b6408847345a0358db4f247" -X GET "https://localhost/onm/api/1.0/users.json?cnm_fields=id,login,descr"
HTTP/1.1 200 OK
Date: Mon, 22 Sep 2014 09:14:37 GMT
Server: Apache/2.2.16 (Debian) PHP/5.3.3-7 with Suhosin-Patch proxy_html/3.0.1 mod_ssl/2.2.16 OpenSSL/0.9.8o mod_perl/2.0.4 Perl/v5.10.1
X-Powered-By: PHP/5.3.3-7
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
:
Vary: Accept-Encoding
Content-Length: 343
Content-Type: text/html; charset=utf-8

[{"id":"6","login":"ssv","descr":"Nueva descripcion"},{"id":"5","login":"amazon","descr":"Empresa: Amazon"},{"id":"4","login":"cocacola","descr":"Empresa: Coca Cola"},{"id":"3","login":"pepsico","descr":"Empresa: Pepsico"},{"id":"2","login":"s30labs","descr":"Empresa: S30Labs"},{"id":"1","login":"admin","descr":"Usuario Administrador"}]cnm@cnm002:/tmp$
Más en esta categoría: « POST /users POST /profiles »

Iniciar sesión

Back to Top