.. _file_class_list:

file class-list
===============

class list file information and management commands


class-list Specification
------------------------

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

	 **Element Name**                      class-list

	 **Element URI**                       /axapi/v3/file/class-list

	 **Element Attributes**                class-list_attributes

	 **Operational Data URI**              /axapi/v3/file/class-list/oper

	 **Schema**                             :download:`class-list schema <file-class-list/file-class-list.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/file/class-list



.. raw:: html

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


:ref:`734_class-list_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _734_class-list_attributes:

class-list attributes
---------------------

    **action**

        **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; 

        **Type:** string

        **Supported Values:** create, import, export, copy, rename, check, replace, delete

    **dst-file**

        **Description** destination file name for copy and rename action

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **file**

        **Description** class list local file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **file-handle**

        **Description** full path of the uploaded file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _734_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - file-list
      - 
      - file-list