The get_children message returns all the children of a particular folder. A client may want a list of all the children in order to expand a node of the workplace tree when a user is browsing through the tree.
The get_children message is used to populate tree nodes in the Workplace view. In both of these cases the table / index (root) to search are known.
The sequence of events is as follows:
type = core
blob = true
The get_children message implies that the user is passing a key / index for a parent and wants the children returned. The parent tag will tell the service what metadata table / index to search in and for the get_children message must be specified. The structure of a parent is organized as follows:
\\table_key\index
So <parent>\\asthma\22</parent> equates to the metadata table that maps to the key "asthma" plus the index "22" to search for.
Attributes provide information about the results to be returned. The "blob" attribute indicates whether or not to return the blob and for this feature must be set to true.
<message_body>
<get_children blob="true">
<parent>\\asthma\22</parent>
</get_children>
</message_body>
Value | Description | Example |
false | Do not return data stored as a blob or clob | xml, comments |
true | Return xml and comments. |
|
The request has the following settings:
blob=true
Response Message:
<message_body>
<folders>
<folder>
<name>CONCEPTS</name>
<index>\\asthma\2</index>
<parentIndex>1</parentIndex>
<visualAttributes>FA</visualAttributes>
<tooltip>FOLDER:Concepts</tooltip>
<groupId>Demo</groupId>
<shareId/>
<statusCd/>
<userId>lcp</userId>
<workXml/>
<workXmlSchema/>
<workXmlI2B2Type/>
</folder>
<folder>
<name>Patient Sets</name>
<index>\\asthma\8</index>
<parentIndex>1</parentIndex>
<visualAttributes>FA</visualAttributes>
<tooltip>FOLDER:Patient Sets</tooltip>
<groupId>Demo</groupId>
<shareId/>
<statusCd/>
<userId>lcp</userId>
<workXml/>
<workXmlSchema/>
<workXmlI2B2Type/>
</folder>
</folders>
</message_body>