.. _clock:

clock
=====

Configure time-of-day Clock


clock Specification
-------------------

	===================================== ==============================================
	 **Parameter**                         **Value** 

	===================================== ==============================================
	 **Type**                              *operational*

	 **Element Name**                      clock

	 **Element URI**                       /axapi/v3/clock

	 **Element Attributes**                clock_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`clock schema <clock/clock.txt>`
	===================================== ==============================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


EXECUTE Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/clock



.. raw:: html

   </td><td valign = 'top'>


:ref:`630_clock_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _630_clock_attributes:

clock attributes
----------------

    **set**

        **Description:** set is a **JSON Block**.  Please see below for :ref:`630_set` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/clock/set <clock_set>`

    **show**

        **Description:** show is a **JSON Block**.  Please see below for :ref:`630_show` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/clock/show <clock_show>`

.. _630_set:

set
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **time-cfg**

        **Description:** time-cfg is a **JSON Block**.  Please see below for :ref:`630_set_time-cfg` 

        **Type:** Object

.. _630_set_time-cfg:

set_time-cfg
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **day-of-month**

        **Description** Day of the Month

        **Type:** number

        **Range:** 1-31

    **day-of-month-2**

        **Description** Day of the Month

        **Type:** number

        **Range:** 1-31

    **month**

        **Description** 'January': Month of the year; 'February': Month of the year; 'March': Month of the year; 'April': Month of the year; 'May': Month of the year; 'June': Month of the year; 'July': Month of the year; 'August': Month of the year; 'September': Month of the year; 'October': Month of the year; 'November': Month of the year; 'December': Month of the year; 

        **Type:** string

        **Supported Values:** January, February, March, April, May, June, July, August, September, October, November, December

    **month-2**

        **Description** 'January': Month of the year; 'February': Month of the year; 'March': Month of the year; 'April': Month of the year; 'May': Month of the year; 'June': Month of the year; 'July': Month of the year; 'August': Month of the year; 'September': Month of the year; 'October': Month of the year; 'November': Month of the year; 'December': Month of the year; 

        **Type:** string

        **Supported Values:** January, February, March, April, May, June, July, August, September, October, November, December

    **time**

        **Description** Current Time

        **Type:** string

        **Format:** time

    **year**

        **Description** Year

        **Type:** number

        **Range:** 2005-2035

.. _630_show:

show
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters