Reports

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/reports

Summary

Resources	Methods
https://localhost:8443/api/rest/reports	DELETE Removes all audit records (these include ACL history, call/conference/CDR reports, analytics, registration history, network usage data, subscription data).
https://localhost:8443/api/rest/reports/alerts	GET Get the list of alerts.
https://localhost:8443/api/rest/reports/alerts/{alert-identifier}	GET Get the alert information from alert history.
https://localhost:8443/api/rest/reports/orphaned-groups	GET Get the list of orphaned groups. DELETE Removes all the orphan groups from DMA system.
https://localhost:8443/api/rest/reports/orphaned-users	GET Get the list of orphaned users. DELETE Removes all the orphan users from DMA system.
https://localhost:8443/api/rest/reports/registrations	GET Retrieves a list of registration summary filtered by optional query parameters.
https://localhost:8443/api/rest/reports/registrations/{registration-uuid}	GET Retrieve registration summary.
https://localhost:8443/api/rest/reports/registrations/{registration-uuid}/events	GET Retrieve registration events.
https://localhost:8443/api/rest/reports/registrations/{registration-uuid}/details	GET Retrieve registration detail.
https://localhost:8443/api/rest/reports/registrations/statistics	GET Retrieve registration statistics.
https://localhost:8443/api/rest/reports/conferences	GET This resource can be used to return a list of conference summary(filtered by optional query parameters).
https://localhost:8443/api/rest/reports/conferences/{conference-identifier}	GET Get the conference information from conference summary.
https://localhost:8443/api/rest/reports/conferences/{conference-identifier}/assoc-calls	GET List all associated call with conference.
https://localhost:8443/api/rest/reports/conferences/{conference-identifier}/event	GET List each conference event and its attributes.
https://localhost:8443/api/rest/reports/conferences/{conference-identifier}/property-change	GET Lists each property change in the conference, showing the value, time, and sequence number of the associated event.
https://localhost:8443/api/rest/reports/conferences/statistics	GET Retrieve conference history max participants statistics.
https://localhost:8443/api/rest/reports/export-report	GET shows the export report of CDR data.
https://localhost:8443/api/rest/reports/network-usage	GET Provide historical Network usage data about the video network.
https://localhost:8443/api/rest/reports/network-usage/export	GET Provide Export Network Usage Data to download as CSV (comma-separated values) file containing all the network usage throttle point records for the time period you specify.
https://localhost:8443/api/rest/reports/calls	GET Get the list of call history.
https://localhost:8443/api/rest/reports/calls/audit-info	GET Retrieves a list of CDRs for the input call UUIDs.
https://localhost:8443/api/rest/reports/calls/{call-identifier}	GET Get the call information from call history.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/bandwidth	GET Get call bandwidth details after the call is ended.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/call-events	GET Lists each call event in the call and its attributes.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/property-changes	GET Lists each property change in the call, showing the value, time, and sequence number of the associated event.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/subscription-events	GET Lists each call subscription event in the call and its attributes.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/signaling-diagram	GET Downloads signaling diagram of a call.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/qos	GET Quality of service data is only available if one of the endpoints is a registered H323 endpoint that supports IRQs.
https://localhost:8443/api/rest/reports/calls/{call-identifier}/qos/{raw-data}	GET Get QOS data.
https://localhost:8443/api/rest/reports/acl-denial	GET Retrieves all acl denials.

Resources

https://localhost:8443/api/rest/reports

Methods

DELETE

Removes all audit records (these include ACL history, call/conference/CDR reports, analytics,
registration history, network usage data, subscription data).
This will reboot the DMA.

Response

Status	Representation	Description
204		Audit records successfully deleted
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. User roles required: administrator

https://localhost:8443/api/rest/reports/alerts

Methods

GET

Get the list of alerts. [tags: DMA]

Request

Query Parameters

Name	Type	Description
description	xs:string	Return only alerts that contains the description value.
alert-code	xs:string	Return only alerts that match with alert code value.
start-after	xs:dateTime	Return only alerts that started after this time.
end-after	xs:dateTime	Return only alerts that ended after this time.
start-before	xs:dateTime	Return only alerts that started before this time.
end-before	xs:dateTime	Return only alerts that ended before this time.
limit	xs:int	Limit the number of users returned to this number, even if more results match the query. Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used. Note 2: If the limit value is less than or equal to 0, the default of 500 will be used. Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.
page	xs:int	When limiting the results, this specifies which page/subset of data to view. Note 1: The valid integer range is 1 to 2147483647. Note 2: If the page value is less than or equal to 0, the default of 1 will be used. Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-alert-list+xml application/vnd.plcm.plcm-alert-list+json	Alert list successfully retrieved.
304		List of alert information has not been changed since the last search. Note: The API client must provide the "plcm-alert-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-alert-list" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to alerts on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, provisioner, auditor.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The date is expected to be in Gregorian Calendar format, which at minimum is CCYY-MM-DDThh:mm:ss. Date ranges must be valid.

https://localhost:8443/api/rest/reports/alerts/{alert-identifier}

Template Parameters

Name	Type	Description
alert-identifier	xs:string	Unique identifier of alert

Methods

GET

Get the alert information from alert history. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-alert+xml application/vnd.plcm.plcm-alert+json	Alert information successfully retrieved.
304		Alert information has not been changed since the last search. Note: The API client must provide the "plcm-alert" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-alert" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to alerts on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, provisioner, auditor.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such alert

https://localhost:8443/api/rest/reports/orphaned-groups

Methods

GET

Get the list of orphaned groups. [tags: DMA]

Request

Query Parameters

Name	Type	Description
limit	xs:int	Limit the number of users returned to this number, even if more results match the query. Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used. Note 2: If the limit value is less than or equal to 0, the default of 500 will be used. Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.
page	xs:int	When limiting the results, this specifies which page/subset of data to view. Note 1: The valid integer range is 1 to 2147483647. Note 2: If the page value is less than or equal to 0, the default of 1 will be used. Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-orphaned-groups-list+xml application/vnd.plcm.plcm-orphaned-groups-list+json	Orphaned group list successfully retrieved.
304		List of orphaned groups information has not been changed since the last search. Note: The API client must provide the "plcm-orphaned-groups-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-orphaned-groups-list" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to alerts on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, provisioner.

DELETE

Removes all the orphan groups from DMA system. [tags: DMA]

Response

Status	Representation	Description
204		Orphan Groups successfully deleted
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. User roles required: administrator

https://localhost:8443/api/rest/reports/orphaned-users

Methods

GET

Get the list of orphaned users. [tags: DMA]

Request

Query Parameters

Name	Type	Description
limit	xs:int	Limit the number of users returned to this number, even if more results match the query. Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used. Note 2: If the limit value is less than or equal to 0, the default of 500 will be used. Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.
page	xs:int	When limiting the results, this specifies which page/subset of data to view. Note 1: The valid integer range is 1 to 2147483647. Note 2: If the page value is less than or equal to 0, the default of 1 will be used. Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-orphaned-users-list+xml application/vnd.plcm.plcm-orphaned-users-list+json	Orphaned user list successfully retrieved.
304		List of orphaned users information has not been changed since the last search. Note: The API client must provide the "plcm-orphaned-users-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-orphaned-users-list" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to alerts on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, provisioner.

DELETE

Removes all the orphan users from DMA system. [tags: DMA]

Response

Status	Representation	Description
204		Orphan Users successfully deleted
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. User roles required: administrator

https://localhost:8443/api/rest/reports/registrations

Methods

GET

Retrieves a list of registration summary filtered by optional query parameters. [tags: DMA]

Request

Query Parameters

Name	Type	Description
alias	xs:string	Retrieve registration summary associated with this alias.
ip-address	xs:string	Retrieve registration summary associated with this ip-address.
start-after	xs:dateTime	Retrieve registration summary for which device registratoin started after this time.
end-after	xs:dateTime	Retrieve registration summary for which device registratoin ended after this time.
start-before	xs:dateTime	Retrieve registration summary for which device registratoin started before this time.
end-before	xs:dateTime	Retrieve registration summary for which device registratoin ended before this time.
territory	xs:string	Retrieve registration summary associated with this territory.
site	xs:string	Retrieve registration summary associated with this site.
protocol	xs:string	Retrieve registration summary associated with this protocol.
owner	xs:string	Retrieve registration summary associated with this owner.
status	xs:string	Retrieve registration summary having this registration status.
device-type	xs:string	Retrieve registration summary associated with this device type.
sort-key	xs:string	Sort the result based on this key. Sort key can have following values. 'name': Sort the result by name. 'alias': Sort the result by alias. 'start-time': Sort the result by start time. 'end-time': Sort the result by end time. 'status': Sort the result by status.
sort-order	xs:string	Sort the result based on this direction. Sort order can have following values: 'ascending': Sort the result in ascending order. 'descending': Sort the result in descending order. To specify default sort order, this parameter should be null.
limit	xs:int	Limit the number of users returned to this number, even if more results match the query. Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used. Note 2: If the limit value is less than or equal to 0, the default of 500 will be used. Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.
page	xs:int	When limiting the results, this specifies which page/subset of data to view. Note 1: The valid integer range is 1 to 2147483647. Note 2: If the page value is less than or equal to 0, the default of 1 will be used. Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-summary-list+xml application/vnd.plcm.plcm-registration-summary-list+json	Registration summary list retrieved successfully.
304		Registration summary list information has not changed since the last search. Note: The API client must provide the "plcm-registration-summary-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-registration-summary-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid value provided for search filter.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid value provided for sort key.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid value provided for sort order.

https://localhost:8443/api/rest/reports/registrations/{registration-uuid}

Template Parameters

Name	Type	Description
registration-uuid	xs:string	Unique uid to retrieve registration summary.

Methods

GET

Retrieve registration summary. [tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-summary+xml application/vnd.plcm.plcm-registration-summary+json	Registration summary retrieved successfully.
304		Registration summary has not changed since the last search. Note: The API client must provide the "plcm-registration-summary" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-registration-summary" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value.
403