Examples of other operations on groups

To use other operations on groups, such as getGroups, importGroups, exportGroups, or updateGroupConfigs, you can utilize queries similar to the examples in this topic.

For example, to utilize getGroups, use this structure in the request:
<ns:getGroups>
   <ns1:groupSummary key="?" displayName="?" cardinality="?"/>
</ns:getGroups>
where key is the only required attribute indicating the groups primary key value, and cardinality optionally lets you list the number of attributes in the group. This request returns information on all groups and their attributes, similar to the response from the exportGroups.
To utilize importGroups, use this structure in the request:
<ns:importGroups>
   <ns1:group key="?" displayName="?">
      <mdex-property_Key>?</mdex-property_Key>
   </ns1:group>
</ns:importGroups>
where mdex-property_Key is the primary key of the group. This request replaces the specified group with another group of the same name, but with the new list of attributes. For example, if an existing group contained three attributes, you can use importGroups to replace this group with a group that will contain only two of them. The keys for the attributes you want to include must be specified in the importGroups request.
To utilize exportGroups, use this simple request that returns information for all groups and their attributes:
<ns:configTransaction>
  <ns:exportGroups/>
</ns:configTransaction>
To utilize updateGroupConfigs, use this structure:
<ns:updateGroupConfigs>
   <ns1:record>
      <system-group_DisplayName>?</system-group_DisplayName>
      <system-group_Key>?</system-group_Key>
   </ns1:record>
</ns:updateGroupConfigs>
and specify a system-group_Key indicating which group to update, and zero or more assignments in the group description record, such as an assignment on the display name, if an existing group does not have one. The operation replaces the assignment on the group description record with a new assignment if it is provided as an argument.
For example, the group system-navigation_InternalGroup is a group that contains all attributes that do not belong to any user-specified groups. This group is created automatically and does not have a display name initially. To provide a display name "Other attributes" for this group, send the following request to the Configuration Web Service running on the particular data domain:
<config-service:updateGroupConfigs>
   <mdex:record>
     <system-group_DisplayName>Other Attributes</system-group_DisplayName>
     <system-group_Key>system-navigation_InternalGroup</system-group_Key>
   </mdex:record>
</config-service:updateGroupConfigs>