Generate a Report
Generate a report using the specified query parameters. For a complete list of required and optional parameters, see URI Parameters.
| Method Type | URI |
|---|---|
| GET | v90/ws/report/{reportId}.ws?{format} |
Example URL:
http://localhost:8080/ems/v82/ws/report/AuditLogReport.ws?format=pdf&StartDate=2021-01-26&EndDate=2021-02-26&entityName=all
URI Parameters
This section describes the query parameters for the following report types:
Entitlement Reports
Customer Entitlement Report
Lists all generated Entitlements per Customer sorted by date.
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (CustomerEntitlementReport) |
String (Path) |
| StartDate | (Optional) Start of the date range (yyyy-MM-dd format) to search reports. | String |
| EndDate | (Optional) End of the date range (yyyy-MM-dd format) to search reports. | String |
| customerName | (Optional) Name of the customer. | String |
| partnerName | (Optional) Name of the channel partner. | String |
| format |
(Required) Output format for the retrieved reports. Valid values: PDF, XLS, RTF, CSV |
String |
Customer Activation Report
Lists the Product activations per Customer, sorted by date. Includes the total number of activations per Customer and the Products each Customer activated.
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (CustomerActivationReport) |
String (Path) |
| StartDate | (Optional) Start of the date range (yyyy-MM-dd format) to search reports. | String |
| EndDate | (Optional) End of the date range (yyyy-MM-dd format) to search reports. | String |
| customerName | (Optional) Name of the customer. | String |
| format |
(Required) Output format for the retrieved reports. Valid values: PDF, XLS, RTF, CSV |
String |
Total Entitlement Utilization
Per-product report for the total number of activations in the entitlement, the total quantity activated, and the total remaining activations.
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (TotalEntitlementUtilization) |
String (Path) |
| product |
(Optional) Complete product name. |
String |
| customerName | (Optional) Name of the customer. | String |
| format |
(Required) Output format for the retrieved reports. Valid values: PDF, XLS, RTF, CSV |
String |
License Expiration Report
Lists the licenses that are due to expire within the specified number of days, starting from today, sorted by Entitlement ID (EID).
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (TotalEntitlementUtilization) |
String (Path) |
| daysBeforeExpiration |
(Optional) Number of days, including today. |
Integer |
| customerName | (Optional) Name of the customer. | String |
| format |
(Required) Output format for the retrieved reports. Valid values: PDF, XLS, RTF, CSV |
String |
Most Popular Products Order
Lists all Products sorted by quantity ordered.
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (TotalEntitlementUtilization) |
String (Path) |
| StartDate | (Optional) Start of the date range (yyyy-MM-dd format) to search reports. | String |
| EndDate | (Optional) End of the date range (yyyy-MM-dd format) to search reports. | String |
| partnerName | (Optional) Name of the channel partner. | String |
| format |
(Required) Output format for the retrieved reports. Valid values: PDF, XLS, RTF, CSV |
String |
Audit Log Report
Displays details of the operations performed for the specified entity within the specified date range, including:
>Operation: Type of operation performed, such as, create, update, and delete.
>Operation By: User who performed the task.
>Operation Date: Date and time when the task was performed.
>Entity Description: Entity name.
>Client IP: IP address of the machine on which the operation was performed.
>Remarks: Additional information, such as, whether the Product is a Modification Product or a Cancellation Product.
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (TotalEntitlementUtilization) |
String (Path) |
| entityName |
(Required) Name of the entity for which you are creating the report. Valid values: >All >Product >Feature >Entitlement >Target >User >Customer >Vendor |
String |
| customerName | (Optional) Name of the customer. | String |
| format |
(Required) Output format for the retrieved reports. Valid values: PDF, XLS, RTF, CSV |
String |
Custom Reports
Returns custom reports for the specified query parameters.
| Parameter | Description | Type |
|---|---|---|
| reportId |
(Required) Unique report identifier. Valid values: > ID > Report name (TotalEntitlementUtilization) |
String (Path) |
| format |
(Required) Output format for the retrieved reports. Valid values: XML, CSV |
String |
Sample Response
Success
HTTP Status Code: 201
Response Body:
,,,,,,,,,Audit Log Report,,,,,, ,Audit Log Between,,,,-,,,and,,,-,,,, Entity Type,,,Operation,Operation By,,,Operation Date,,,Entity Description,,Client Ip,,Remarks,
,,User,,,,,,,,,,,Total Count:,,9 User,,,Vendor portal Login,admin,,,3/15/2021,,,login successful,,127.0.0.1,,,
User,,,User details Updated,admin,,,3/15/2021,,,admin,,127.0.0.1,,,
User,,,User details Updated,admin,,,3/15/2021,,,admin,,127.0.0.1,,,
User,,,User's password changed,admin,,,3/15/2021,,,admin,,127.0.0.1,,,
User,,,Vendor portal Login,admin,,,3/16/2021,,,login failed,,10.156.4.282,,,
User,,,Vendor portal Login,admin,,,3/16/2021,,,login failed,,10.164.108.148,,, User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.108.148,,,
User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.110.195,,, User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.110.195,,, ,,Entitlement,,,,,,,,,,,Total Count:,,1 Entitlement,,,Login by product key,71ff2268-1836-481e-8c93-48815655c1a0,,,3/16/2021,,,login successful,,10.164.108.148,,,
,,User,,,,,,,,,,,Total Count:,,3 User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.156.4.282,,,
User,,,Vendor portal Login,admin,,,3/16/2021,,,login failed,,10.164.108.173,,, User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.108.173,,, ,,Entitlement,,,,,,,,,,,Total Count:,,1 Entitlement,,,Login by product key,c03e2c49-225e-4984-b75f-d8ffe5c84a2b,,,3/16/2021,,,login successful,,10.164.108.173,,, ,,User,,,,,,,,,,,Total Count:,,4 User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.108.148,,, User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.110.195,,, User,,,Vendor portal Login,admin,,,3/16/2021,,,login failed,,10.164.110.195,,, User,,,Vendor portal Login,admin,,,3/16/2021,,,login successful,,10.164.110.195,,,
Failure
HTTP Status Code: 400