This operation returns the ID for a client.
Request
Syntax
GET <webservice>/GetId?clientname={clientName} 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 Parameters
Name |
Description |
Required |
---|---|---|
clientName |
The name of the client. It must be URL encoded. |
Yes, for request by client name |
agent |
The name of the agent. It must be URL encoded. |
Yes, for request by agent |
instanceName |
The name of the instance. It must be URL encoded. |
Yes, for request by instance name |
backupset |
The name of the backup set. It must be URL encoded. |
Yes, for request by backup set |
subclient |
The name of the subclient. It must be URL encoded. |
Yes, for request by subclient |
Request Headers
Name |
Description |
---|---|
Host |
The host name of the Web Server or Web Console 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 information about receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter |
Description |
Element |
|||
---|---|---|---|---|---|
clientName |
The name of the client. |
||||
clientId |
The ID of the client. |
||||
type |
The type of CommCell object. |
||||
applicationId |
The ID of the application. For a list of application IDs, see the valid values for the appName parameter. |
||||
appName |
The name of the application. Valid values for the applicationId and appName parameters:
|
||||
instanceId |
The system-generated ID that is assigned to the instance. |
||||
instanceName |
The name of the instance, such as DefaultInstanceName. |
||||
backupsetName |
The name of the backup set. |
||||
subclientId |
The ID of the subclient. |
||||
subclientName |
The name of the subclient. |
Examples
Sample Request
This request returns the client ID with client name.
GET <webservice>/GetId?clientname=yashdutch
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
This request returns the client ID with agent name.
GET <webservice>/GetId?clientname=dm2perf3&agent=File%20System
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
This request returns the client ID with instance name.
GET <webservice>/GetId?clientname=dm2perf3&agent=File%20System&instanceName=DefaultInstanceName
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
This is the response for request with client name.
{
"clientName": "yashdutch",
"clientId": 18,
"_type_": 3
}
This is the response for request with agent name.
{
"applicationId": 33,
"clientName": "dm2perf3",
"clientId": 2,
"_type_": 4,
"appName": "File System"
}
This is the response for request with instance name.
{
"applicationId": 33,
"clientName": "dm2perf3",
"instanceId": 1,
"clientId": 2,
"instanceName": "DefaultInstanceName",
"_type_": 5,
"appName": "File System"
}