Scope of API for Smart Licensing REST Web Service
This is a web interface to the Smart Licensing REST Web Service. This web service contains Read APIs to view data for the Smart Licensing. Use the REST APIs URL to fetch, configure, and update the smart licensing-related activities in the HCM-F Smart Licensing.
URL (Base URL) |
HTTPs Method |
||||
---|---|---|---|---|---|
GET |
POST |
PUT |
UPDATE |
DELETE |
|
Configure Smart Account | |||||
|
N |
Y |
N |
N |
N |
Update Smart Account by Id | |||||
|
N |
N |
Y |
N |
N |
Delete Smart AccountY | |||||
|
N |
N |
N |
N |
Y |
Schema Smart Account Config | |||||
|
N |
Y |
N |
N |
N |
List of Smart Accounts | |||||
|
Y |
N |
N |
N |
N |
Schema for Transport Settings | |||||
|
Y |
N |
N |
N |
N |
List of VA for Smart Accounts | |||||
|
Y |
N |
N |
N |
N |
List all Virtual Account | |||||
|
Y |
N |
N |
N |
N |
Get a Virtual Account details by Id | |||||
|
Y |
N |
N |
N |
N |
Get a Virtual Account by name | |||||
|
Y |
N |
N |
N |
N |
Update a Virtual Account by ID | |||||
|
N |
N |
N |
Y |
N |
Schema for Virtual Account | |||||
|
Y |
N |
N |
N |
N |
Assign Cluster to a Virtual Account | |||||
|
N |
Y |
N |
N |
N |
Schema for Assign Cluster to a Virtual Account | |||||
|
Y |
N |
N |
N |
N |
Unassign Cluster to a Virtual Account | |||||
|
N |
Y |
N |
N |
N |
Schema for unassign Cluster to a Virtual Account | |||||
|
Y |
N |
N |
N |
N |
Sync from CSSM | |||||
|
N |
Y |
N |
N |
N |
Schema for Sync request | |||||
|
Y |
N |
N |
N |
N |
Get VA info based on cluster ID | |||||
|
Y |
N |
N |
N |
N |
Get VA info based on cluster name | |||||
|
Y |
N |
N |
N |
N |
Unassign Cluster | |||||
|
N |
Y |
N |
N |
N |
Get All Subscription Details | |||||
|
Y |
N |
N |
N |
N |
Get Subscription Details for a Customer | |||||
|
Y |
N |
N |
N |
N |
Update Subscription Details | |||||
|
N |
N |
Y |
N |
N |
Cluster Summary | |||||
|
Y |
N |
N |
N |
N |
Configure Smart Account (Client Id and Client Secret)
Title |
Configure Client id and Client Secret |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
|
Data Params |
smartLic/smartAccountConfig/schemameta |
Success Response |
200 |
Error Response |
400- Smart Account Access Error 400 – Invalid domain name / clientId / clientSecret / authGateway / serverUrl / transportMode 400 – Smart Account Does not exist 400 – Smart Account Already exist 400 – Validation Error 400 – AutoReg VA allowed only if operationalLic is enabled 400 – Enable AutoReg only when Operational Licenses are selected 400 – VAs are mandatory when Operational Licenses enabled 400 – Only one SA for AutoReg 400 – At least one SA must have Operational Licenses eenabled 412 – Sync In Progress 500 – Service down , unknown |
Example |
|
Notes |
Update Smart Account by Id
Title |
Update Smart Accounts |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
Pkid – integer Pkid – Smart Account identifier |
Data Params |
|
Success Response |
200 |
Error Response |
400- Smart Account Access Error 400 – Invalid domain name / clientId / clientSecret 400 – Smart Account Does not exist 400 – Validation Error 400 – Invalid pkid 412 – Sync In Progress 500 – Unknown, service down |
Example |
For Direct Mode:
For Proxy Mode:
For Satellite Mode:
|
Notes |
Delete Smart Account
Title |
Delete Smart Account |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
smartAccountId |
Data Params |
smartLic/smartAccountConfig/schemameta |
Success Response |
200 |
Error Response |
400 -Smart account does not exist 400-Validation error 400 -Smart Account cannot be deleted 412-Sync in progress 500 - Unknown, service down |
Example |
|
Notes |
Schema Smart Account Config
Title |
Schema for Smart Account Config |
---|---|
Root URL |
|
URL |
smartLic/smartAccountConfig/schemameta |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example |
|
Notes |
List of Smart Accounts
Title |
Get List of Smart Accounts |
---|---|
Root URL |
|
URL |
smartLic/smartAccounts |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
500 – Unknown, service down |
Example |
|
Notes |
Schema for Transport Settings
Title |
Assign a Cluster to a Virtual Account |
---|---|
Root URL |
|
URL |
smartLic/transportMode/schemameta |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example |
|
Notes |
List of Virtual Accounts for Smart Accounts
Title |
Get List of Virtual Account for a Smart Account |
---|---|
Root URL |
|
URL |
smartLic/smartAccount/pkid/virtualAccounts |
Method |
GET |
URL Params |
Pkid = integer Pkid = Smart Account identifier |
Data Params |
|
Success Response |
200 |
Error Response |
404- Invalid KID found 500 – Unknown Errors, Service Down |
Example |
|
Notes |
List all Virtual Account
Title |
Get all the Virtual Accounts |
---|---|
Root URL |
|
URL |
smartLic/smartAccount/virtualAccounts |
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
500 – Unknown Errors, Service Down |
Example |
|
Notes |
Get a Virtual Account Details by ID
Title |
Get all the Virtual Accounts |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
Pkid = integer Pkid = Virtual Account identifier |
Data Params |
|
Success Response |
200 |
Error Response |
404- SmartLic Data Issue 500 – Unknown, Service Down |
Example |
|
Notes |
Get a Virtual Account by Name
Title |
Update the License mode of Virtual account based on name |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/smartAccount/virtualAccount/name/name |
Method |
GET |
URL Params |
Name = String name = Name of the Virtual Account |
Data Params |
|
Success Response |
200 |
Error Response |
404- Data Issue 500 – Unknown , Service Down |
Example |
|
Notes |
Only License Mode update is allowed. |
Update a Virtual Account by Id
Title |
Update the License mode of Virtual account based on ID |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/smartAccount/virtualAccount/pkid |
Method |
UPDATE |
URL Params |
Pkid = integer Pkid = Virtual Account identifier |
Data Params |
smartLic/smartAccount/virtualAccount/updateSchemameta |
Success Response |
200 |
Error Response |
400- SmartLic Data issue 404 - Invalid KID found 412 – Deployment Mode cannot be changed 500 – Unknown , Service Down |
Example |
|
Notes |
Only License mode updation is allowed |
Update a Virtual Account by Name
Title |
Update the License mode of Virtual account based on name |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/smartAccount/virtualAccount/name/{name} |
Method |
|
URL Params |
Name = String name – Name of the Virtual Account |
Data Params |
smartLic/smartAccount/virtualAccount/updateSchemameta |
Success Response |
200 |
Error Response |
400- SmartLic Data issue 412 – Deployment Mode cannot be changed 500 – Unknown , Service Down |
Example |
|
Notes |
Only License mode updation is allowed |
Schema for Virtual Account
Title |
Schema for Virtual account |
---|---|
Root URL |
|
URL |
smartLic/smartAccount/virtualAccount/updateSchemameta |
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Only License Mode update is allowed. |
Assign Cluster to a Virtual Account
Assignment of Expressway C and E Clusters
Assign Expressway E and C clusters from the Virtual Account. Smart Software Manager Cisco SSM On-Prem server 7.2 or later supports assigning Expressway E and C Clusters. They are assigned only if all the subordinate peers are added in the HCMF application, else the assignment is not accepted. Ensure to enter Correct credentials, network address and proxy details during assignment.
Title |
Assign a Cluster to a Virtual Account |
---|---|
Root URL |
|
URL |
smartLic/assignCluster |
Method |
|
URL Params |
|
Data Params |
smartLic/assignCluster/schemameta |
Success Response |
200 |
Error Response |
400- Virtual Account Invalid 400 – Cluster Invalid 412 –Deployment Mode not set 412 – Cluster Validation Failed 412 – Cluster InUse 400 – Cluster type not supported 412 – Cluster not having platform credentials 412 – Cluster version incorrect 412 – Cluster not having admin credentials 412 – Cluster not having publisher 412 – Cluster already assigned 500 –Unknown, service down |
Example |
|
Notes |
Schema to Assign Cluster to a Virtual Account
Title |
Schema for Assignment |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/assignCluster/schemameta |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Unassign Cluster to a Virtual Account
Title |
Unassign a Cluster from a Virtual Account |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/unassignCluster |
Method |
|
URL Params |
|
Data Params |
smartLic/unassignCluster/schemameta |
Success Response |
200 |
Error Response |
400- Cluster Invalid 412 – Cluster Validation Failed 412 – Cluster Inuse 400 – Cluster Type Not supported 412 – Cluster Not having platform Cred 412 – Cluster Version Incorrect 412 – Cluster not having admin Credentials 412 –Cluster not having publisher 412 – Cluster already unassigned 500 – Unknown, service down |
Example |
|
Notes |
Schema to Unassign Cluster to a Virtual Account
Title |
Schema for unassignment |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/unassignCluster/schemameta |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Sync from CSSM
Title |
Sync fulfillment data with CSSM |
---|---|
Root URL |
|
URL |
|
Method |
|
URL Params |
smartAccountId – Integer smartAccountId – SmartAccount identifier |
Data Params |
smartLic/schedule/schemameta |
Success Response |
200 |
Error Response |
412- Scheduler already running 400 – SmartAccount does not exist 400 – Invalid SmartAccount Id 500 – Unknown, service down |
Example |
|
Notes |
Schema for Sync Request
Title |
Schema for Sync Request |
---|---|
Root URL |
|
URL |
|
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Get Virtual Account Info Based on Cluster ID
Title |
Get the VA info for cluster Id |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/clusters/pkid |
Method |
|
URL Params |
Pkid- Integer Pkid of the cluster |
Data Params |
|
Success Response |
200 |
Error Response |
404- Data Issue 404 - Invalid KID 500 – Unknown, Service Down |
Example |
|
Notes |
Get Virtual Account Info Based on Cluster Name
Title |
Get the VA info for cluster name |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/clusters/name/name |
Method |
|
URL Params |
name- String name of the cluster |
Data Params |
|
Success Response |
200 |
Error Response |
404- Data Issue 500 – Unknown , Service Down |
Example |
|
Notes |
Unassign Cluster
Title |
Unassign cluster from a Virtual Account |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/unassignCluster |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
400 – Cluster Invalid 412 – Cluster Validation Failed 412 – Cluster In Use 400 – Cluster type not supported 412 – No Platform/Admin credentials found for cluster 412 – Cluster version incorrect 412 – Publisher not found for cluster 412 – Cluster already unassigned 500 – Unknown , Service Down |
Example |
|
Notes |
Get All Subscription Details
Title |
Get subscription details for all Smart Accounts including satellite |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/subscriptions |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404 - Resource not found 500 – Unknown , Service Down |
Example |
|
Notes |
Get Subscription Details for a Customer
Title |
Get subscription details for a customer |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/subscriptions/customer/customerId |
Method |
|
URL Params |
customerId – Integer customerId – Customer identifier |
Data Params |
|
Success Response |
200 |
Error Response |
400 – Data issue 400 – Invalid KID 400 – Validation error 500 – Unknown , Service Down |
Example |
|
Notes |
Update Subscription Details
Title |
Update subscription details for a customer |
---|---|
Root URL |
https://HCMF_HOST_NAME:8443/sdr/rest/ |
URL |
smartLic/subscriptions |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
400 – Data Issue 400 – Invalid License Model 400 – Validation error 400 – Invalid KID 500 – Unknown , Service Down |
Example |
|
Notes |
Cluster Summary
Title |
Cluster Summary |
---|---|
Root URL |
|
URL |
smartLic/clusterSummary |
Method |
|
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
500 – Unknown , Service Down |
Example |
|
Notes |