Restriction: This information no longer refers to the latest product version but may still be relevant if you are working with an older version.
Gets the list of groups.
Request syntax
Copy
https://mycloud.perfectomobile.com/services/groups/?operation=list&securityToken=value[&optionalParameter=value]To get all the groups, no criteria parameter is required. To get groups according to criteria, the relevant criteria parameter is required.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| securityToken* | string |
|
A unique cryptographic key assigned to an authorized user. |
| user | string |
|
Deprecated. The name of the user running the operation. Important: All REST API commands require authentication through the Perfecto security token. See also Authentication in new APIs.
|
| password | string |
|
Deprecated. The password for the user. Important: All REST API commands require authentication through the Perfecto security token. See also Authentication in new APIs.
|
| label | string |
|
The group display name. |
| description | string |
|
The group description. |
| responseFormat | string | json | The format to use for the response. This operation supports the following response formats: XML, JSON |
* Mandatory parameter
Response
Indicates, in the info section, the number of groups that match the input criteria and a list of all the groups. For each group in the list, the following information is included:
| Field | Description |
|---|---|
| id | The identifier assigned by the system for the group. |
| label | The display name of the group |
| description | The description text associated with the group. |
Example
The following example shows a request that returns the list of all groups whose display name is "Monitoring"
Copy
Request
https://mycloud.perfectomobile.com/services/groups/?operation=list&securityToken=<your_token>&label=MonitoringCopy
Response
{
"groups":[
{
"id":"Monitoring_10000",
"description":"Monitoring",
"label":"Monitoring" }],
"info":{
"creationTime":{"formatted":"2016-11-20T14:39:36Z","millis":"1479652776095"},
"items":"1",
"modelVersion":"2.10.0.0",
"productVersion":"master",
"time":"2016-11-20T14:39:36Z" }
}
