Configuration



[tags: DMA_INTERNAL]

Resource Root

https://localhost:8443/api/rest/config/microsoft-exchange-server

Summary


Resources Methods
https://localhost:8443/api/rest/config/microsoft-exchange-server

GET Retrieves the current Microsoft Exchange Server configuration settings.

PUT Update the current Microsoft Exchange Server configuration settings.

https://localhost:8443/api/rest/config/microsoft-exchange-server/status

GET Retrieves the current Microsoft Exchange Server status.

Resources


https://localhost:8443/api/rest/config/microsoft-exchange-server


Methods

GET

Retrieves the current Microsoft Exchange Server configuration settings

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-microsoft-exchange-server+xml
application/vnd.plcm.plcm-microsoft-exchange-server+json
Information successfully retrieved
304
Microsoft Exchange Server integration configuration has not changed since the last search.

Note: The API client must provide the "plcm-microsoft-exchange-server" 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-microsoft-exchange-server" 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.
403 application/vnd.plcm.plcm-error+xml

User does not have the correct permission to get the Microsoft Exchange Server settings.

PUT

Update the current Microsoft Exchange Server configuration settings

Request

Representations

application/vnd.plcm.plcm-microsoft-exchange-server+xml
application/vnd.plcm.plcm-microsoft-exchange-server+json

Response

Status Representation Description
204
The update of the settings was successful.
403 application/vnd.plcm.plcm-error+xml
The user does not have the correct permissions to change the Microsoft Exchange Server configuration.
400 application/vnd.plcm.plcm-error+xml

serverless-bind was true and no host IP or FQDN was specified in the address field.
400 application/vnd.plcm.plcm-error+xml

An address is missing. An IP address, host
name, or FQDN is required.
400 application/vnd.plcm.plcm-error+xml

A username is missing.Expected username to be
in the format DOMAIN\username
400 application/vnd.plcm.plcm-error+xml

A password is missing.
409 application/vnd.plcm.plcm-error+xml

Microsoft Exchange Server access error
412 application/vnd.plcm.plcm-error+xml

The Microsoft Exchange Server 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-microsoft-exchange-server.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-microsoft-exchange-server.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.

https://localhost:8443/api/rest/config/microsoft-exchange-server/status


Methods

GET

Retrieves the current Microsoft Exchange Server status

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-microsoft-exchange-server-status+xml
application/vnd.plcm.plcm-microsoft-exchange-server-status+json
Information successfully retrieved
304
Microsoft Exchange Server integration configuration has not changed since the last search.

Note: The API client must provide the "plcm-microsoft-exchange-server-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-microsoft-exchange-server-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.
403 application/vnd.plcm.plcm-error+xml

User does not have the correct permission to get the Microsoft Exchange Server status.