Loading...

REST API - POST Release License

This operation releases a license from a client or an agent.

Request

Syntax

Send the request using either XML or JSON:

  • XML

    POST <webservice>/Client/License/Release HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>
    Content-type: application/xml

    <release_license_template.xml>

  • JSON

    POST <webservice>/Client/License/Release HTTP/1.1
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-type: application/json

    <release_license_template.json>

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 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 details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: release_license_template.xml or release_license_template.json. The following table displays the parameters for the request body.

Name

Description

Element

isClientLevelOperation

The option to release a license for a client or an agent.

JSON valid values are:

  • true, to release a license for a client
  • false, to release a license for an agent

XML valid values are:

  • 1, to release a license for a client
  • 0, to release a license for an agent

TMMsg_ReleaseLicenseReq

clientName

The name of the client. If the client name is not known, use the GET Client API to retrieve it.

clientEntity

clientId

The system-generated ID assigned to the client. If the client ID is not known, use the GET Client API to retrieve it.

clientEntity

platformType

Valid values are:

  • 1, CommServe
  • 2, MediaAgent
  • 4, CommCell Console

licensesInfo

appType

The ID of the application (agent). This is required if the isClientLevelOperation parameter is set to false or 0.

Valid values are:

 

  • 41, Active Directory
  • 21, AIX File System
  • 64, Big Data Apps
  • 134, Cloud Apps
  • 37, DB2
  • 103, DB2 MultiNode
  • 62, DB2 on Unix
  • 128, Documentum
  • 90, Domino Mailbox Archiver
  • 91, DPM
  • 67, Exchange Compliance Archiver
  • 53, Exchange Database
  • 45, Exchange Mailbox
  • 54, Exchange Mailbox (Classic)
  • 56, Exchange Mailbox Archiver
  • 82, Exchange PF Archiver
  • 35, Exchange Public Folder
  • 73, File Share Archiver
  • 33, File System
  • 74, FreeBSD
  • 71, GroupWise DB
  • 17, HP-UX Files System
  • 65, Image Level
  • 75, Image Level On Unix
  • 76, Image Level ProxyHost
  • 87, Image Level ProxyHost on Unix
  • 3, Informix Database
  • 29, Linux File System
  • 89, MS SharePoint Archiver
  • 104, MySQL
  • 13, NAS
  • 83, Netware File Archiver
  • 12, Netware File System
  • 10, Novell Directory Services
  • 124, Object Link
  • 131, Object Store
  • 86, OES File System on Linux
  • 22, Oracle
  • 80, Oracle RAC
  • 130, Other External Agent
  • 125, PostgreSQL
  • 38, Proxy Client File System
  • 87, ProxyHost on Unix
  • 61, SAP for Oracle
  • 135, SAP HANA
  • 78, SharePoint Server
  • 20, Solaris 64bit File System
  • 19, Solaris File System
  • 81, SQL Server
  • 5, Sybase Database
  • 66, Unix File Archiver
  • 36, Unix Tru64 64-bit File System
  • 106, Virtual Server
  • 58, Windows File Archiver

 

license

licenseName

The name of the license that needs to be released. If the license name is not known, use the GET Client Licenses API to retrieve it.

license

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

CVGui_GenericResp

errorMessage

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

CVGui_GenericResp

Examples

Sample Request

XML

This request releases all of the licenses for a file system agent.

POST <webservice>/Client/License/Release HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<TMMsg_ReleaseConsumedLicenseReq isClientLevelOperation="1">
  <clientEntity clientName="client001"/>
  <licensesInfo platformType="1">
   <license appType="33" licenseName="Server File System - Windows File System"/>
  </licensesInfo>
</TMMsg_ReleaseConsumedLicenseReq>

JSON

This request releases all of the licenses for a client.

POST <webservice>/Client/License/Release HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json

{
  "isClientLevelOperation": true,
  "licensesInfo": [{
    "platformType": 1,
    "license": {
      "appType": 33,
      "licenseName": "Server File System - Windows File System"
    }
  }],
  "clientEntity": {
    "clientName": "client001"
  }
}

Sample Response

XML

<CVGui_GenericResp errorCode="0" errorMessage=""/>

JSON

{
"errorMessage":"","errorCode":0
}

Last modified: 5/29/2018 3:21:35 PM