REST API - GET Client Group

This operation returns a list of client computer groups.

Request

Syntax
GET webservice/ClientGroup HTTP/1.1
 Host: host name
 Accept: application/xml
 Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or the Command Center used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

Id

The system-generated ID assigned to the client computer group.

groups

edcSupportedInstanceType

groups

flag

groups

isAddinClientGroup

Valid values are True/False.

groups

isEDCInstanceAssociated

Valid values are True/False.

groups

isEDCInstanceDeleted

Valid values are True/False.

groups

isNetworkThrottleEnabled

The option to use network throttling. For information on network throttling, see Configuring Network Throttling.

Valid values are True/False.

groups

isSmartClientGroup

The option to use automatic associations. For information on automatic associations, see Smart Client Groups using Automatic Association.

Valid values are True/False.

groups

name

The name of the client computer group.

groups

Examples

Sample Request
GET webservice/ClientGroup HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GetServerListResp>
   <groups Id="1" edcSupportedInstanceType="" flag="4096" isAddinClientGroup="false" isEDCInstanceAssociated="false" isEDCInstanceDeleted="false" isNetworkThrottleEnabled="false" isSmartClientGroup="true" name="Media Agents"/>
   <groups Id="2" edcSupportedInstanceType="" flag="4096" isAddinClientGroup="false" isEDCInstanceAssociated="false" isEDCInstanceDeleted="false" isNetworkThrottleEnabled="false" isSmartClientGroup="true" name="Laptop Clients"/>
 </App_GetServerListResp>
×

Loading...