Pesquisa de usuários por tipo de item
Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: /api/v9/user/{id}/search?itemType={itemType}&projectId={projectId}&criteria={criteria}
- Tipo: GET
-
Títulos obrigatórios:
- tipo de conteúdo: application/json
- Autorização X: Portador {token}
Descrição do URL
- {host}: Ele representa o domínio do ambiente no qual a API está localizada.
- ASMSAPI/: Prefixo de API fixo.
- URI: Ponto de extremidade específico para a solicitação.
⚐ URL DE EXEMPLO:
https://{host}/ASMSAPI/api/v9/user/{id}/search?itemType={itemType}&projectId={projectId}&criteria={criteria}
Parâmetros
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
Id | Número | Sim | Identificador de valor (ID do grupo, ID do grupo de clientes, ID da empresa e assim por diante) para pesquisar usuários com base no tipo de item (itemType) |
tipo de item | Enumerador | Sim | Tipo de pesquisa - Ci = 21 - Grupo de clientes = 64 - Empresa = 38 - Grupo = 49 - Licença = 68 |
ID do projeto | Número | Sim | ID do projeto |
Critérios | Texto | Não | Texto de pesquisa do usuário |
Corpo da petição
N/A
Exemplos 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
Responder
{
"content": [
{
"email": "tri@pri.comx", "id": 150,
"name": "Abdy Sanjur", "userName": "ASANJUR" }
],
"totalItems": 1
}
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
totalItems | Número | Número total de objetos encontrados |
conteúdo | Lista | Lista de itens |
Texto | E-mail do usuário | |
Id | Número | Identificação de usuário |
Nome | Texto | Nome de usuário |
nome do usuário | Texto | Aliases de usuário |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
500 | Erro de servidor interno | Usuários de pesquisa de falhas |
400 | Solicitação BadRequest | InvalidTypeForSearch |