Petition Details
- URL Base: {host}/ASMSAPI/
- URI:
api/v9/group/GetGroupsByProjects - Guy: POST
-
Required headings:
content-type: application/jsonX-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/group/GetGroupsByProjects
Parameters
| Name | Data type | Obligatory | Description |
|---|---|---|---|
| filter | Text | No | Group search text. |
| projects | List of numbers | Yes | List of project identifiers. |
Body of the petition
{
"filter":"Aranda",
"projects":[1,2]
}
answer
{
"content": [
{
"active":1,
"id":10,
"name":"Soporte Aranda"
}
],
"totalItems":1
}
Response Parameters
| Name | Data type | Description |
|---|---|---|
| totalItems | Number | Total objects found in the search |
| content | List | Item listing |
Content
| Name | Data type | Description |
|---|---|---|
| Active | Boolean | Whether the group is active or not |
| Id | Number | Group ID |
| Name | Text | Group Name |