Scope of API
This controls fulfillment-related tasks, like kicking off manual syncs, restarting jobs, and non-CRUD Shared Data Repository operations.
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This controls fulfillment-related tasks, like kicking off manual syncs, restarting jobs, and non-CRUD Shared Data Repository operations.
The location of the WADL for the Fulfillment REST Web Service is https://HCM-F_Server_IPaddress:8443/ff/rest/application.wadl.
This is a web interface to the License Statistics REST Web Service. This web service contains Read APIs to view data in the License Dashboard. The REST APIs URL to fetch the license report for customers and PLMs in the HCM-F license dashboard is as follows:
To fetch customers for license dashboard: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/customerview/customers
To fetch PLMs for license dashboard: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/plmview/plms
To fetch License report for all PLMs: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/plmview/stats
To fetch License Report for specific PLM: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/plmview/stats/plm-id
To fetch License report for all customers: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/customerview/stats
To fetch License report for specific customer: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/customerview/stats/customer-id
To fetch License report of User, and Device report for specific customer: https://HCM-F_Server_IPaddress/sdr/rest/licenseAnalytics/customerview/downloadUserLicense/customer-id
Note |
|
This is a web interface to the Flex License Usage Report REST Web Service. The web service contains Read APIs to view data in the Flex Usage Report. Use the REST APIs URL to configure and fetch the Flex License Usage summary report for UC clusters at customer level.
Note |
You must accept EURA (End User Reporting Agreement) before using any API to configure or download the Flex License Usage report. Else, the report is not generated. |
To configure the Flex Usage Report, use the following API to configure Flex Usage report parameters such as scheduler time, date, SFTP server details, and HCM-F hostname:
Response:
{
"providerName": "",
"reportScheduleTime": "",
"reportScheduleDay": "",
"reportfrequency": "",
"retentionPeriod": ,
"smtpHost": "",
"smptPort": ,
"toEmailAddresses": [
""
],
"fromEmailId": "",
"EulaAcceptedDate": "",
"additionalEmailAddressTo": "",
"ciscoEmailAddressTo": "hcs-license-reporting@external.cisco.com",
"sftpHostname": "",
"sftpPort": ,
"sftpUsername": "",
"sftpPassword": "",
"sftpUploadPath": "",
"hcmfInstanceName": "",
"hcmfUUID": null,
"lcrtQuarterlyReportDates": "15-MAR, 15-JUN, 15-SEP, 15-DEC",
"sftpEnabled":
}
Note |
For details on the fields, see Configure Flex Usage Report in Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide . |
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
403 |
Eula Not accepted |
Request:
{
"providerName": "<String>",
"reportScheduleTime": "<hh:mm:ss>",
"reportScheduleDay": "<date>",
"reportfrequency": "Monthly",
"retentionPeriod": <In between 30-180>,
"smtpHost": "",
"smptPort": <int>,
"toEmailAddresses": "",
"fromEmailId": "",
"additionalEmailAddressTo": "",
"ciscoEmailAddressTo": "”,
"sftpHostname": "",
"sftpPort": <int>,
"sftpUsername": "",
"sftpPassword": "",
"sftpUploadPath": <path to upload>",
"hcmfInstanceName": "",
"hcmfUUID": null,
"sftpEnabled": <Boolean>
}
Note |
|
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
403 |
Eula Not accepted |
400 |
Validation Error |
To view the End-User Reporting Agreement (EURA) status:
GET https://HCM-F_Server_IPaddress/sdr/rest/licenseManagement/eulaStatus
{
"eulaStatus": "Accepted",
"eulaAcceptDate": "<Date of Acceptance>"
}
{
"eulaStatus": "Not Accepted",
"eulaAcceptDate": NA
}
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
To get the list of Flex License Usage summary report:
GET https://HCM-F_Server_IPaddress/sdr/rest/licenseManagement/Report
[
{
"reportName": "",
"fileSize": <int>,
"reportDate": "2019-03-26 03:29:34",
"time": 1553596174000
}
]
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
403 |
EULA Not Accepted |
To download a Flex License Usage report with name:
GET https://HCM-F_Server_IPaddress/sdr/rest/licenseManagement/filename to download
{
"partnerName": "",
"reportVersion": "1.0",
"businessReportVersion": "1.0",
"creationDate": "2019-03-27 02:56:39",
"startDate": "02-28-2019",
"endDate": "03-27-2019",
"productName": "",
"productUuid": "b6de95dd-ab58-41f7-8c91-e9b353b7f342",
"productVersion": "11.5.4.99000-9009",
"packageInfo": [
{
"customerName": "",
"siteName": "NA",
"flexSubcriptionId": "",
"packageName": "",
"unitsConsumed": <int>,
"monthlyAverage": <int>,
"maxUnitsConsumed": <int>
}
]
}
{
"partnerName": "Airtel",
"reportVersion": "2.0",
"businessReportVersion": "2.0",
"creationDate": "2019-09-24 15:31:43",
"startDate": "08-25-2019",
"endDate": "09-24-2019",
"productName": null,
"productUuid": "1797af3e-4cbc-4b34-8385-ec648e4fe019",
"productVersion": "12.5.0.98000-9005",
"operationalVirtualAccount": "va-hcs-operational",
"orderedVirtualAccount": "va-hcs-ordered",
"smartAccountDomain": "hcs-intg.cisco.com",
"orderRetrievalDate": "2019-09-24",
"packageInfo": [
{
"customerName": "TestCustomer3",
"siteName": "NA",
"flexSubcriptionId": "",
"licenseModel": "Named User",
"packageName": "CER",
"unitsConsumed": 3,
"monthlyAverage": 3,
"complianceStatus": "Out of Compliance",
"estimatedTrueForwarding": -3,
"maxUnitsConsumed": 3,
"installed": 0
}
]
}
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
403 |
EULA Not Accepted |
404 |
Report Not Found |
To trigger an On demand Flex License Usage report:
POST https://HCM-F_Server_IPaddress/sdr/rest/licenseManagement/Report
{
"jobId": ""
}
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
403 |
EULA Not Accepted |
400 |
Already Running |
To get the Perpetual License Consumption data in Flex Report
GET https://HCM-F_Server_IPaddress/sdr/rest/licenseManagement/Report/Perpetual/ReportName
{
"partnerName": "Airtel",
"reportVersion": "2.0",
"businessReportVersion": "2.0",
"creationDate": "2019-09-19 05:22:10",
"startDate": "08-20-2019",
"endDate": "09-19-2019",
"productName": "TEST_HCMF",
"productUuid": "hcs-intg.cisco.com",
"productVersion": "12.5.0.98333-34",
"operationalVirtualAccount": "HCS-VA-TEST",
"orderedVirtualAccount": "HCS-VA-Ordered",
"smartAccountDomain": "2019-09-19",
"orderRetrievalDate": "null",
"packageInfo": [
{
"customerName": "customer1;customer2",
"siteName": "NA",
"flexSubcriptionId": "NA",
"licenseModel": "Perpetual",
"packageName": "Hcs TelePresence",
"unitsConsumed": "2260",
"monthlyAverage": "NA",
"complianceStatus": "NA",
"estimatedTrueForwarding": "NA",
"maxUnitsConsumed": "NA",
"installed": "NA"
},
{
"customerName": "customer1;customer2",
"siteName": "NA",
"flexSubcriptionId": "NA",
"licenseModel": "Perpetual",
"packageName": "Hcs Basic",
"unitsConsumed": "100",
"monthlyAverage": "NA",
"complianceStatus": "NA",
"estimatedTrueForwarding": "NA",
"maxUnitsConsumed": "NA",
"installed": "NA"
},
{
"customerName": "customer1;customer2",
"siteName": "NA",
"flexSubcriptionId": "NA",
"licenseModel": "Perpetual",
"packageName": "Hcs Foundation",
"unitsConsumed": "5875",
"monthlyAverage": "NA",
"complianceStatus": "NA",
"estimatedTrueForwarding": "NA",
"maxUnitsConsumed": "NA",
"installed": "NA"
},
{
"customerName": "Airtel",
"siteName": "NA",
"flexSubcriptionId": "sub00003",
"licenseModel": "Perpetual",
"packageName": "Hcs TelePresence",
"unitsConsumed": "4520",
"monthlyAverage": "NA",
"complianceStatus": "NA",
"estimatedTrueForwarding": "-4520",
"maxUnitsConsumed": "NA",
"installed": "0"
},
{
"customerName": "Airtel",
"siteName": "NA",
"flexSubcriptionId": "sub00003",
"licenseModel": "Perpetual",
"packageName": "Hcs Basic",
"unitsConsumed": "200",
"monthlyAverage": "NA",
"complianceStatus": "NA",
"estimatedTrueForwarding": "-200",
"maxUnitsConsumed": "NA",
"installed": "0"
},
{
"customerName": "Airtel",
"siteName": "NA",
"flexSubcriptionId": "sub00003",
"licenseModel": "Perpetual",
"packageName": "Hcs Foundation",
"unitsConsumed": "11750",
"monthlyAverage": "NA",
"complianceStatus": "NA",
"estimatedTrueForwarding": "-11750",
"maxUnitsConsumed": "NA",
"installed": "0"
}
]
}
HTTP Error Code |
Description |
---|---|
200 |
Success |
500 |
Internal Server Error |
403 |
EULA Not Accepted |
400 |
Already Running |
The WADL for the License Statistics REST Web Service along with the Shared Data Repository REST Web Service can be found at https://HCM-F_Server_IPaddress:8443/sdr/rest/application.wadl.