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	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Registration record does not exist.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Registration UUID is not valid.

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

Template Parameters

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

Methods

GET

Retrieve registration events. [tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-event-list+xml application/vnd.plcm.plcm-registration-event-list+json	Registration events retrieved successfully.
304		Registration events have not changed since the last search. Note: The API client must provide the "plcm-registration-event-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-event-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
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Registration record does not exist.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Registration UUID is not valid.

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

Template Parameters

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

Methods

GET

Retrieve registration detail. [tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-detail+xml application/vnd.plcm.plcm-registration-detail+json	Registration summary retrieved successfully.
304		Registration detail has not changed since the last search. Note: The API client must provide the "plcm-registration-detail" 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	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Registration record does not exist.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Registration UUID is not valid.

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

Methods

GET

Retrieve registration statistics. [tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-statistics+xml application/vnd.plcm.plcm-registration-statistics+json	Registration Statistics retrieved successfully.
304		Registration statistics has not changed since the last search. Note: The API client must provide the "plcm-registration-statistics" 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-statistics" ETag can be accessed from the initial search result's HTTP response header.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner

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

Methods

GET

This resource can be used to return a list of conference summary(filtered by optional query parameters).
Datetime format is [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm].
Examples include: 2001-01-26T21:32:52, 2001-01-26T21:32:52+02:00, 2001-01-26T19:32:52Z,
2001-01-26T19:32:52+00:00, -2001-01-26T21:32:52, or 2001-01-26T21:32:52.12679
[tags: DMA]

Request

Query Parameters

Name	Type	Description
conference-room-id	xs:string	Return only conferences that matches conference room value.
start-after	xs:dateTime	Retrieve conference summary for which conference started after this time.
end-after	xs:dateTime	Retrieve conference summary for which conference ended after this time.
start-before	xs:dateTime	Retrieve conference summary for which conference started before this time.
end-before	xs:dateTime	Retrieve conference summary for which conference ended before this time.
sort-key	xs:string	Sort the result based on this key. Sort key can have following values. 'conference-room-id': Sort the result by conference-room-id. '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-conference-list-v3+xml application/vnd.plcm.plcm-conference-list-v3+json	Conference summary list successfully retrieved.
304		List of conference summary information has not been changed since the last search. Note: The API client must provide the "plcm-conference-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-conference-list" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to conference 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	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/conferences/{conference-identifier}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	Unique identifier of conference record. Conference UUID

Methods

GET

Get the conference information from conference summary. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-v3+xml application/vnd.plcm.plcm-conference-v3+json	conference information successfully retrieved.
304		conference information has not been changed since the last search. Note: The API client must provide the "plcm-conference" 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-conference" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to conference 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 conference record
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conferencec identifier is not valid.

https://localhost:8443/api/rest/reports/conferences/{conference-identifier}/assoc-calls

Template Parameters

Name	Type	Description
conference-identifier	xs:string	Unique identifier of conference record. Conference UUID

Methods

GET

List all associated call with conference. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-call-list+xml application/vnd.plcm.plcm-call-list+json	Call list successfully retrieved.
304		List of call information has not been changed since the last search. Note: The API client must provide the "plcm-call-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-call-list" ETag can be accessed from the initial search result's HTTP response header.
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.

https://localhost:8443/api/rest/reports/conferences/{conference-identifier}/event

Template Parameters

Name	Type	Description
conference-identifier	xs:string	Unique identifier of conference record. Conference UUID

Methods

GET

List each conference event and its attributes. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-audit-event-list+xml application/vnd.plcm.plcm-audit-event-list+json	conference events successfully retrieved.
304		conference events has not been changed since the last search. Note: The API client must provide the "plcm-audit-event-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-audit-event-list" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/conferences/{conference-identifier}/property-change

Template Parameters

Name	Type	Description
conference-identifier	xs:string	Unique identifier of conference record. Conference UUID

Methods

GET

Lists each property change in the conference, showing the value, time, and sequence number of the associated event. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-audit-property-change-list+xml application/vnd.plcm.plcm-audit-property-change-list+json	conference property changes successfully retrieved.
304		conference properties has not been changed since the last search. Note: The API client must provide the "plcm-audit-property-change-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-audit-property-change-list" ETag can be accessed from the initial search result's HTTP response header.
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 call.

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

Template Parameters

Name	Type	Description
interval	xs:string	Interval value for which conference history max participants statistics retrieved. There are four interval values defined: 1) hour 2) day 3) week 4) six-months

Methods

GET

Retrieve conference history max participants statistics. [tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conferences-statistics+xml application/vnd.plcm.plcm-conferences-statistics+json	Conferences Statistics retrieved successfully.
304		Conferences statistics has not changed since the last search. Note: The API client must provide the "plcm-conferences-statistics" 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-conferences-statistics" ETag can be accessed from the initial search result's HTTP response header.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner

https://localhost:8443/api/rest/reports/export-report

Methods

GET

shows the export report of CDR data. [tags: DMA]

Request

Query Parameters

Name	Type	Description
export-type	xs:string	Accept type of export for history report. Values accepted: CDR, CALL_HISTORY, SYSTEM_LOG, CALL_HISTORY_CDR_BOTH.
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-export-report-list+xml application/vnd.plcm.plcm-export-report-list+json	Export report successfully retrieved.
304		Export report has not been changed since the last search. Note: The API client must provide the "plcm-export-report" 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-export-report" ETag can be accessed from the initial search result's HTTP response header.
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.

https://localhost:8443/api/rest/reports/network-usage

Methods

GET

Provide historical Network usage data about the video network. [tags: DMA]

Request

Query Parameters

Name	Type	Description
start-time	xs:dateTime	The date/time at which to begin searching.
time-granularity	xs:string	Available time granularity values are: EIGHT_HOURS_IN_ONE_MINUTE TWO_DAYS_IN_FIVE_MINUTES SEVEN_DAYS_IN_FIFTEEN_MINUTES TWENTY_DAYS_IN_ONE_HOUR ONE_YEAR_IN_ONE_DAY
usage-type	xs:string	Available usage types are: CLUSTER TERRITORY SITE SITE_LINK SUBNET
usage-type-value	xs:string	The value of the chosen usage-type. If TERRITORY is chosen, then valid values are the names of territories configured on the DMA. If SITE is chosen, the valid values are the names of the sites configured on the DMA.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-network-usage-list+xml application/vnd.plcm.plcm-network-usage-list+json	Network usage data event successfully retrieved.
304		Call subscription events has not been changed since the last search. Note: The API client must provide the "plcm-network-usage-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-network-usage-list" ETag can be accessed from the initial search result's HTTP response header.
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.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such call.

https://localhost:8443/api/rest/reports/network-usage/export

Methods

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. [tags: DMA]

Request

Query Parameters

Name	Type	Description
start-time	xs:dateTime	The date/time at which to start searching.
end-time	xs:dateTime	The date/time at which to stop searching.

Response

Status	Representation	Description
200	application/gzip	Network usage data event successfully downloaded.
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.

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

Methods

GET

Get the list of call history. [tags: DMA]

Request

Query Parameters

Name	Type	Description
cluster	xs:string	Return only calls that contains the cluster value.
territory	xs:string	Return only calls that match with territory name.
originator	xs:string	Return only calls that match with the start of the ip address, aliases or device name of the originator.
destination	xs:string	Return only calls that match with the start of the ip address, aliases or device name of the destination.
registration-status	xs:string	Return only calls that match with registration status value.
site	xs:string	Return only calls that match with site value.
signaling-includes	xs:string	Return only calls that match with signaling includes value.
dial-string	xs:string	Return only calls that match with dial string value.
device-uuid	xs:string	Return only calls that match with device uuid value.
start-after	xs:dateTime	Return only calls that started after this time.
end-after	xs:dateTime	Return only calls that ended after this time.
start-before	xs:dateTime	Return only calls that started before this time.
end-before	xs:dateTime	Return only call that ended before this time.
sort-key	xs:string	Sort the result based on this key. Sort key can have following values: 'originator': Sort the result by originator. 'destination': Sort the result by destination. 'dial-string': Sort the result by dial string. 'end-time': Sort the result by end time. 'start-time': Sort the result by start time. 'cluster': Sort the result by cluster. 'call-id': Sort the result by call id.
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-call-list+xml application/vnd.plcm.plcm-call-list+json	Call list successfully retrieved.
304		List of call information has not been changed since the last search. Note: The API client must provide the "plcm-call-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-call-list" ETag can be accessed from the initial search result's HTTP response header.
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.

https://localhost:8443/api/rest/reports/calls/audit-info

Methods

GET

Retrieves a list of CDRs for the input call UUIDs.

Note 1: ETag is currently passed back to the user as a unix timestamp. It is not truly an "ETag", but is
a placeholder for more correct implementation when audit information can be returned as a XML package rather
than a set of CSV's. Until then, it is still included as a useful piece of information about
when the API got the audit information.

[tags: DMA]

Request

Query Parameters

Name	Type	Description
uuid-list	xs:string	Comma separated list of UUID for which call audit information is needed.
start-after	xs:dateTime	Date after which call was started.
end-before	xs:dateTime	Date before which call was ended.

Response

Status	Representation	Description
200	application/tar	CDR information successfully retrieved.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Current user does not have permission to request information. DMA roles required: administrator, provisioner, auditor.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Call UUID is invalid.

https://localhost:8443/api/rest/reports/calls/{call-identifier}

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

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

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-call+xml application/vnd.plcm.plcm-call+json	Call successfully retrieved.
304		Call has not been changed since the last search. Note: The API client must provide the "plcm-call" 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-call" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/bandwidth

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

Get call bandwidth details after the call is ended. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-bandwidth+xml application/vnd.plcm.plcm-bandwidth+json	Call bandwidth successfully retrieved.
304		Call bandwidth has not been changed since the last search. Note: The API client must provide the "plcm-bandwidth" 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-bandwidth" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/call-events

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

Lists each call event in the call and its attributes. [tags: DMA]

Request

Query Parameters

Name	Type	Description

call-identifier	xs:string	Unique identifier of the call
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.
coords-only	xs:dateTime	Returns only the events with coordinates.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-audit-event-list+xml application/vnd.plcm.plcm-audit-event-list+json	Call events successfully retrieved.
304		Call events has not been changed since the last search. Note: The API client must provide the "plcm-audit-event-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-audit-event-list" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/property-changes

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

Lists each property change in the call, showing the value, time, and sequence number of the associated event. [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-audit-property-change-list+xml application/vnd.plcm.plcm-audit-property-change-list+json	Call events successfully retrieved.
304		Call properties has not been changed since the last search. Note: The API client must provide the "plcm-audit-property-change-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-audit-property-change-list" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/subscription-events

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

Lists each call subscription event in the call and its attributes. [tags: DMA]

Request

Query Parameters

Name	Type	Description

call-identifier	xs:string	Unique identifier of the call
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-call-subscription-event-list+xml application/vnd.plcm.plcm-call-subscription-event-list+json	Call subscription events successfully retrieved.
304		Call subscription events has not been changed since the last search. Note: The API client must provide the "plcm-call-subscription-event-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-call-subscription-event-list" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/signaling-diagram

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

Downloads signaling diagram of a call. [tags: DMA]

Request

Response

Status	Representation	Description
200	image/png	Signaling diagram successfully downloaded.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/qos

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call

Methods

GET

Quality of service data is only available if one of the endpoints is a registered
H323 endpoint that supports IRQs. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-qos+xml application/vnd.plcm.plcm-qos+json	Qos details successfully retrieved.
304		Qos details has not been changed since the last search. Note: The API client must provide the "plcm-qos" 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-qos" ETag can be accessed from the initial search result's HTTP response header.
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 call.

https://localhost:8443/api/rest/reports/calls/{call-identifier}/qos/{raw-data}

Template Parameters

Name	Type	Description
call-identifier	xs:string	Unique name or identifier of call
raw-data	xs:string	Raw data is used to calculate qos measures.

Methods

GET

Get QOS data. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-qos+xml application/vnd.plcm.plcm-qos+json	Qos measures successfully retrieved from raw data.
304		Qos measures has not been changed since the last search. Note: The API client must provide the "plcm-qos" 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-qos" ETag can be accessed from the initial search result's HTTP response header.
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 call.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Device authentication could not find entry.

https://localhost:8443/api/rest/reports/acl-denial

Methods

GET

Retrieves all acl denials. [tags: DMA]

Request

Query Parameters

Name	Type	Description
start-time	xs:dateTime	The date/time at which to begin searching.
end-time	xs:dateTime	The date/time at which to end searching.
acl-name	xs:string	The name of acl for searching.
rule	xs:string	The name of rule for searching.
server	xs:string	The name of server for searching.
port	xs:string	The port number for searching.
prefiltering	xs:string	The prefiltering for searching.
ip-address	xs:string	The ipaddress for searching.
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-acl-denial-list+xml application/vnd.plcm.plcm-acl-denial-list+json	Acl denial records successfully retrieved.
304		Acl Denial records have not changed since the last get.
400	text/plain	Bad request.
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.
412	application/vnd.plcm.plcm-error+xml	The resource has changed on the server. The API client must retrieve the latest resource version, apply the resource modifications, then update to the server.
428	application/vnd.plcm.plcm-error+xml	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-port-range-settings.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.