Configuration



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest//enterprise-directory-reports

Summary


Resources Methods
https://localhost:8443/api/rest//enterprise-directory-reports

https://localhost:8443/api/rest//enterprise-directory-reports/room-errors-report

GET Retrieves Enterprise Directory conference room errors report.

https://localhost:8443/api/rest//enterprise-directory-reports/room-errors-report/export

GET  Provide Enterprise Integration Room errors report download as CSV (comma-separated values) [tags: DMA] .

https://localhost:8443/api/rest//enterprise-directory-reports/passcode-errors-report

GET Retrieves the current Enterprise Directory passcode errors report.

https://localhost:8443/api/rest//enterprise-directory-reports/passcode-errors-report/export

GET  Provide Enterprise Integration passcode errors report download as CSV (comma-separated values) [tags: DMA] .

https://localhost:8443/api/rest//enterprise-directory-reports/orphan-report

GET Retrieves the current Enterprise Directory orphaned groups and users report.

https://localhost:8443/api/rest//enterprise-directory-reports/orphan-report/users

DELETE  Remove orphaned enterprise users [tags: DMA] .

https://localhost:8443/api/rest//enterprise-directory-reports/orphan-report/groups

DELETE  Remove orphaned enterprise groups [tags: DMA] .

https://localhost:8443/api/rest//enterprise-directory-reports/integration-report

GET Retrieves the current Enterprise Directory integration report.

Resources


https://localhost:8443/api/rest//enterprise-directory-reports


https://localhost:8443/api/rest//enterprise-directory-reports/room-errors-report


Methods

GET

Retrieves Enterprise Directory conference room errors report. [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.
Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return up to the default of 500 results.
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 an 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 zero, the system will ignore the page request and return the first page.
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 an integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-plcm-enterprise-directory-reports-room-errors+xml
application/vnd.plcm.plcm-enterprise-directory-reports-room-errors+json
Information successfully retrieved
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

User does not have the correct permission to get the report.

https://localhost:8443/api/rest//enterprise-directory-reports/room-errors-report/export


Methods

GET


Provide Enterprise Integration Room errors report download as CSV (comma-separated values) [tags: DMA]

Request

Response

Status Representation Description
200 application/gzip
Room errors report csv successfully downloaded.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest//enterprise-directory-reports/passcode-errors-report


Methods

GET

Retrieves the current Enterprise Directory passcode errors report. [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.
Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return up to the default of 500 results.
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 an 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 zero, the system will ignore the page request and return the first page.
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 an integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-enterprise-directory-reports-passcode-errors+xml
application/vnd.plcm.plcm-enterprise-directory-reports-passcode-errors+json
Information successfully retrieved
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

User does not have the correct permission to get the report.

https://localhost:8443/api/rest//enterprise-directory-reports/passcode-errors-report/export


Methods

GET


Provide Enterprise Integration passcode errors report download as CSV (comma-separated values) [tags: DMA]

Request

Response

Status Representation Description
200 application/gzip
Room errors report csv successfully downloaded.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest//enterprise-directory-reports/orphan-report


Methods

GET

Retrieves the current Enterprise Directory orphaned groups and users report. [tags: DMA]

Request

Query Parameters

Name Type Description
userLimit 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 2147483647.
Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return all results.
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 an integer type.
userPage 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 zero, the system will ignore the page request.
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 an integer type.
groupLimit 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 2147483647.
Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return all results.
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 an integer type.
groupPage 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 zero, the system will ignore the page request.
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 an integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-enterprise-directory-reports-orphans+xml
application/vnd.plcm.plcm-enterprise-directory-reports-orphans+json
Information successfully retrieved
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

User does not have the correct permission to get the report.

https://localhost:8443/api/rest//enterprise-directory-reports/orphan-report/users


Methods

DELETE


Remove orphaned enterprise users [tags: DMA]

Response

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

https://localhost:8443/api/rest//enterprise-directory-reports/orphan-report/groups


Methods

DELETE


Remove orphaned enterprise groups [tags: DMA]

Response

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

https://localhost:8443/api/rest//enterprise-directory-reports/integration-report


Methods

GET

Retrieves the current Enterprise Directory integration report. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-enterprise-directory-reports-integration+xml
application/vnd.plcm.plcm-enterprise-directory-reports-integration+json
Information successfully retrieved
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

User does not have the correct permission to get the report.