.. _acos_events_message_id:

acos-events message-id
======================

Configure log message


message-id Specification
------------------------

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

	===================================== ==================================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *log-msg, message-id-scope-route*

	 **Collection Name**                   :ref:`163_message-id_list`

	 **Collection URI**                    /axapi/v3/acos-events/message-id

	                                       

	 **Element Name**                      message-id

	 **Element URI**                       /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}

	 **Element Attributes**                message-id_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`message-id schema <acos-events-message-id/acos-events-message-id.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/acos-events/message-id



.. raw:: html

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


:ref:`163_message-id_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/acos_events_message_id_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/acos-events/message-id



.. raw:: html

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


:ref:`163_message-id_attributes`



.. raw:: html

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




.. raw:: html

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}



.. raw:: html

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


:ref:`163_message-id_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/acos-events/message-id



.. raw:: html

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


:ref:`163_message-id_list`



.. raw:: html

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




.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}



.. raw:: html

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


:ref:`163_message-id_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}



.. raw:: html

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


:ref:`163_message-id_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/acos-events/message-id



.. raw:: html

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


:ref:`163_message-id_list`



.. raw:: html

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




.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}



.. raw:: html

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


:ref:`163_message-id_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _163_message-id_list:

message-id-list
---------------


    message-id-list is **JSON List** of :ref:`163_message-id_attributes` 

        message-id-list : [

             { :ref:`163_message-id_attributes` },

             { :ref:`163_message-id_attributes` },

             ...

         ]

.. _163_message-id_attributes:

message-id attributes
---------------------

    **log-msg**

        **Description** Specify log message-id lineage

        **Type:** string

        **Maximum Length:** 512 characters

        **Maximum Length:** 1 characters

    **message-id-scope-route**

        **Description** 'all': Log messages at this level and all sub-trees; 'node-only': Log messages at this node only; 'children-only': Log messages at all sub-trees only; 'log-field-only': This is a log-field (Default); 

        **Type:** string

        **Supported Values:** all, node-only, children-only, log-field-only

        **Default:** log-field-only

    **property**

        **Description:** property is a **JSON Block**.  Please see below for :ref:`163_property` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property <acos_events_message_id>`

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _163_property:

property
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **log-route**

        **Description:** log-route is a **JSON Block**.  Please see below for :ref:`163_property_log-route` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/log-route <acos_events_message_id>`

    **rate-limit**

        **Description:** rate-limit is a **JSON Block**.  Please see below for :ref:`163_property_rate-limit` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/rate-limit <acos_events_message_id>`

    **severity**

        **Description:** severity is a **JSON Block**.  Please see below for :ref:`163_property_severity` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/severity <acos_events_message_id>`

.. _163_property_log-route:

property_log-route
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **log-route-val**

        **Description** 'local-only': send logs to local-only; 'remote-only': send logs to remote-only; 'local-and-remote': send logs to both local and remote; 

        **Type:** string

        **Supported Values:** local-only, remote-only, local-and-remote

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _163_property_severity:

property_severity
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **severity-val**

        **Description** 'emergency': System unusable log messages (Most Important); 'alert': Action must be taken immediately; 'critical': Critical conditions; 'error': Error conditions; 'warning': Warning conditions; 'notification': Normal but significant conditions; 'information': Informational messages; 'debugging': Debug level messages (Least Important); 

        **Type:** string

        **Supported Values:** emergency, alert, critical, error, warning, notification, information, debugging

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _163_property_rate-limit:

property_rate-limit
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **rate-limit-val**

        **Description** 'enable': enable rate-limiting of logs; 'disable': disable rate-limiting of logs; 

        **Type:** string

        **Supported Values:** enable, disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters