Configuration

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/config/enterprise-directory-cache

Resources	Methods
https://localhost:8443/api/rest/config/enterprise-directory-cache	GET Retrieves a the current Enterprise Directory cache configuration. PUT Use this method to change the current settings for the Enterprise Directory cache by passing the new settings.
https://localhost:8443/api/rest/config/enterprise-directory-cache/refresh	POST Use this method to force the server to initiate a refresh of the Enterprise Directory cache.
https://localhost:8443/api/rest/config/enterprise-directory-cache/status	GET Retrieves the current Enterprise Directory cache status.
https://localhost:8443/api/rest/config/enterprise-directory-cache/defaults	GET Retrieves Enterprise Directory cache defaults.

Retrieves a the current Enterprise Directory cache configuration. [tags: DMA]

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-cache-config+xml application/vnd.plcm.plcm-enterprise-directory-cache-config+json	Cache configuration was successfully retrieved
304		Enterprise Directory Cache configuration has not changed since the last search. Note: The API client must provide the "plcm-enterprise-directory-cache-config" 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-enterprise-directory-cache-config" 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. This also assumes no other client made changes on the server.
401	application/vnd.plcm.plcm-error+xml	Invalid credentials
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to get the cache configuration

Use this method to change the current settings for the Enterprise Directory cache
by passing the new settings. [tags: DMA]

Status	Representation	Description
204		Cache configuration was successfully updated
401	application/vnd.plcm.plcm-error+xml	Invalid credentials
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to set the cache configuration
409	application/vnd.plcm.plcm-error+xml	Enterprise Directory integration is disabled. Enable integration before attempting to configure caching.
412	application/vnd.plcm.plcm-error+xml	The enterprise directory cache resource has changed on the server. Note: The response will contain the ETag value. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-enterprise-directory-cache.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.
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-enterprise-directory-cache.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.

Use this method to force the server to initiate a refresh of the Enterprise Directory cache. [tags: DMA]

Status	Representation	Description
200		A refresh of the cache has been successfully started
401	application/vnd.plcm.plcm-error+xml	Invalid credentials
403	application/vnd.plcm.plcm-error+xml	User does not have the permission to force a refresh of the cache
409	application/vnd.plcm.plcm-error+xml	Server is not integrated or not connected with the Enterprise Directory

Retrieves the current Enterprise Directory cache status. [tags: DMA]

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-cache-status+xml application/vnd.plcm.plcm-enterprise-directory-cache-status+json	Cache status was successfully retrieved
304		Enterprise Directory Cache status has not changed since the last search. Note: The API client must provide the "plcm-enterprise-directory-cache-status" 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-enterprise-directory-cache-status" 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. This also assumes no other client made changes on the server.
401	application/vnd.plcm.plcm-error+xml	Invalid credentials
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to get the cache status

Retrieves Enterprise Directory cache defaults.[tags: DMA]

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-cache-config+xml application/vnd.plcm.plcm-enterprise-directory-cache-config+json	Default Information successfully retrieved
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User does not have the correct permission to retrieve the Enterprise Directory status.