The delete_child message is sent to delete an editable node from the metadata tree. The attribute include_children=true indicates that children should be deleted also.

Delete a Node in the Tree

To delete a node in the tree, the sequence of events is as follows:

1. The client specifies a leaf, folder or container to be deleted.

2. The Ontology server performs the following steps:

   1. Parses the node information to obtain the key / table_cd

   2. Query the TABLE_ACCESS table for the table name associated with the TABLE_CD.

   3. Update the metadata table to delete the corresponding node and its synonyms.

   4. If include_children = true then also delete the children of this node.

1. The client removes the leaf, folder or container.

delete_child Request Message

This message requires the user to specify the node to be deleted. No additional attribute settings are necessary.
Example:
<message_body include_children="true">
<ns6:delete_child>
<level>1</level>
<key>\\i2b2\Custom Ontology\Test folder{color:#0000ff}</key>
<name>Test folder</name>
<synonym_cd>N</synonym_cd>
<basecode />
</ns6:delete_child>
</message_body>

delete_child Response Message

A status type of DONE or ERROR is specified in the response header. No specialized <message_body> is returned to the client.