Clone
-----


.. tabularcolumns:: |p{4cm}|p{10.5cm}|

+---------------+---------------------------------------------------------------------------------------------------------------------+
| Action        | clone                                                                                                               |
+===============+=====================================================================================================================+
| Title         | Clone instance with [pkid]. The schema rules are applied.                                                           |
+---------------+---------------------------------------------------------------------------------------------------------------------+
| Method        | GET                                                                                                                 |
+---------------+---------------------------------------------------------------------------------------------------------------------+
| URL           | /api/<resource_type>/<resource_name>/[pkid]/clone/                                                                  |
+---------------+---------------------------------------------------------------------------------------------------------------------+
| Parameters    | hierarchy=[hierarchy], schema=true, schema_rules=true                                                               |
+---------------+---------------------------------------------------------------------------------------------------------------------+
| Response      | A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance. |
+---------------+---------------------------------------------------------------------------------------------------------------------+
| support_async | false                                                                                                               |
+---------------+---------------------------------------------------------------------------------------------------------------------+
| Class         | clone                                                                                                               |
+---------------+---------------------------------------------------------------------------------------------------------------------+

* For the instance pkids that can cloned, refer to the List GET call for the resource:

::

  GET http://<server_address>/api/<resource_type>/<resource_name>/
   ?hierarchy=[hierarchy]
   &format=json

* Use the POST action in the response and a modification of the response as the payload to create the clone
  of the the instance with pkid.


.. |VOSS-4-UC| replace:: VOSS-4-UC
.. |Unified CM| replace:: Unified CM
.. |API Guide| replace:: API Guide