User search by item type
Petition Details
- Base URL: {host}/ASMSAPI/
- Uri: /api/v9/user/{id}/search?itemType={itemType}&projectId={projectId}&criteria={criteria}
- Type: GET
-
Required headings:
- content-type: application/json
- X-Authorization: Bearer {token}
URL Description
- {host}: It represents the domain of the environment in which the API is located.
- ASMSAPI/: Fixed API prefix.
- URI: Specific endpoint for the request.
⚐ EXAMPLE URL:
https://{host}/ASMSAPI/api/v9/user/{id}/search?itemType={itemType}&projectId={projectId}&criteria={criteria}
Parameters
Name | Data type | Obligatory | Description |
---|---|---|---|
Id | Number | Yes | Value identifier (Group ID, Customer Group ID, Company ID, and so on) for searching for users based on item type (itemType) |
itemType | Enumerator | Yes | Search Type - Ci = 21 - ClientGroup = 64 - Company = 38 - Group = 49 - License = 68 |
projectId | Number | Yes | Project ID |
Criteria | Text | No | User Search Text |
Body of the petition
N/A
Examples of 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
Answer
{
"content": [
{
"email": "tri@pri.comx", "id": 150,
"name": "Abdy Sanjur", "userName": "ASANJUR" }
],
"totalItems": 1
}
Response parameters
Name | Data type | Description |
---|---|---|
totalItems | Number | Total number of objects found |
content | List | Item listing |
Text | User Email | |
Id | Number | User ID |
Name | Text | Username |
userName | Text | User aliases |
Error messages
Code | HTTP status | Error Message |
---|---|---|
500 | InternalServerError | FailureSearchUsers |
400 | BadRequest | InvalidTypeForSearch |