Búsqueda de usuario por tipo de elemento
Detalles de la petición
- URL Base: {host}/ASMSAPI/
- Uri: /api/v9/user/{id}/search?itemType={itemType}&projectId={projectId}&criteria={criteria}
- Tipo: GET
-
Encabezados requeridos:
- content-type: application/json
- X-Authorization: Bearer {token}
Descripción de la URL
- {host}: Representa el dominio del ambiente en el que se encuentra la API.
- ASMSAPI/: Prefijo fijo de la API.
- Uri: Endpoint específico para la petición.
⚐ EJEMPLO URL:
https://{host}/ASMSAPI/api/v9/user/{id}/search?itemType={itemType}&projectId={projectId}&criteria={criteria}
Parámetros
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| id | Número | Si | Identificador del valor (ID de grupo, ID de grupo de clientes, ID de compañía, etc.) para la búsqueda de usuarios según el tipo de elemento (itemType) |
| itemType | Enumerador | Si | Tipo de búsqueda - Ci = 21 - ClientGroup = 64 - Company = 38 - Group = 49 - License = 68 |
| projectId | Número | Si | Identificador del proyecto |
| criteria | Texto | No | Texto de búsqueda de usuario |
Cuerpo de la petición
N/A
Ejemplos de uri
- api/v9/user/17/search?itemType=group&projectId=2&criteria=abdy
- api/v9/user/17/search?itemType=group&projectId=2&criteria=
- api/v9/user/17/search?itemType=group&projectId=2
Respuesta
{
"content": [
{
"email": "tri@pri.comx", "id": 150,
"name": "Abdy Sanjur", "userName": "ASANJUR" }
],
"totalItems": 1
}
Parámetros de respuesta
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| totalItems | Número | Número total de objetos encontrados |
| content | Lista | Listado de objetos |
| Texto | Correo electrónico del usuario | |
| id | Número | Identificador del usuario |
| name | Texto | Nombre del usuario |
| userName | Texto | Alias del usuario |
Mensajes de error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 500 | InternalServerError | FailureSearchUsers |
| 400 | BadRequest | InvalidTypeForSearch |