REST API - GET Subclient Policies

This operation returns a list of subclient policies.

Request

Syntax

GET webservice/SubclientPolicies HTTP/1.1
Host: host name
Accept: application/xml | application/json
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

Name

Description

Elements

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.

  • 2, a failure.

  • a specific error code.

error

errorMessage

The description of the error code. Not all error codes have an error message.

error

idaType

subClientPolicies

_type_

subclientPolicyEntity

subclientPolicyId

The system-generated ID assigned to the subclient policy.

subclientPolicyEntity

subclientPolicyName

The name of the subclient policy.

subclientPolicyEntity

Examples

Sample Request

GET webservice/SubclientPolicies HTTP/1.1
Host: client.mydomain.com
Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{ "error": { "errorMessage": "", "errorCode": 0 }, "subClientPolicies": [ { "idaType": 2, "subclientPolicyEntity": { "_type_": 65, "subclientPolicyId": 7, "subclientPolicyName": "Laptop plan Windows subclient policy" } }, { "idaType": 3, "subclientPolicyEntity": { "_type_": 65, "subclientPolicyId": 8, "subclientPolicyName": "Laptop plan Linux subclient policy" } }, { "idaType": 4, "subclientPolicyEntity": { "_type_": 65, "subclientPolicyId": 32, "subclientPolicyName": " Laptop plan Mac subclient policy" } } ]
}
×

Loading...