Time

 

Resource Root

https://localhost:8443/api/rest/config/time-config

Summary

Resources

Methods

https://localhost:8443/api/rest/config/time-config

GET     Retrieves the time and its settings (enabled/disabled NTP, list of NTP servers).

PUT     Updates the server's  time settings (enable/disable NTP, list of NTP servers).

 

 

Resources

https://localhost:8443/api/rest/config/time-config

Methods

GET

Retrieves the time and its settings (enabled/disabled NTP, list of NTP servers).  

 

Response

Status

Representation

Description

200

application/vnd.plcm.plcm-time-config+xml

Time configuration successfully retrieved.

304

application/vnd.plcm.plcm-error+xml

Time configuration has not changed.

Note:

The API client must provide the "plcm-time-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 request in the "If-None-Match" header, then the HTTP response will contain the same information in the message body as the previous request.

The "plcm-time-config" ETag can be accessed from the initial request result's HTTP response header.

If another client has changed the time configuration, the ETag value will be out of date and a request with the outdated ETag will return the full "plcm-time-config".

401

application/vnd.plcm.plcm-error+xml

Invalid credentials

403

application/vnd.plcm.plcm-error+xml

Unable to get permission. Retrieving time configuration requires administrator role.

 

 

PUT

Updates the server's time settings (enable/disable NTP, list of NTP servers).  

 

Request

Representations: application/vnd.plcm.plcm-time-config+xml

 

Response

Status

Representation

Description

200

 

OK.

Time settings successfully updated.

406

application/vnd.plcm.plcm-error+xml

Not Acceptable: content type format is not valid when data appears in body.

412

application/vnd.plcm.plcm-error+xml

Precondition Failed.