Integration Server 10.5 | Built-In Services Reference Guide | XMLData Folder | Summary of Elements in this Folder | pub.xmldata.getGroupValues
 
pub.xmldata.getGroupValues
WmPublic. Queries the contents of a group with unknown structure to return information about the values in the group.
The contents of a group can be unknown when the instance content corresponds to an anyType, substitutionGroup, or content created without using document type-directed conversion. A group consists of tags and values.
The pub.xmldatat.getGroupValues service accepts a group as input along with an optional set of query parameters. The service produces a set of descriptive information documents about each value in the group. Because each tag can have repeating values, the length of the result list could be many times the number of tags present in the provided group. However, the result can be thought of as a flattened list of the objects associated with the tags.
Input Parameters
query
Document Group from which to obtain values and any query parameters to identify the particular field or fields for which you want to obtain values.
Key
Value
groupValue
Document The group to be queried.
ncName
String Optional. The NCName (non-colonized name), of the tag you want to query in the group. The NCName is also called the local name. If you do not specify a value for ncName, the service queries all tags belonging to the namespace specified in the namespace input parameter.
namespace
String Optional. The namespace URI for the tag you want to query in the group. If you specify an empty String, the service queries tags that do not belong to any namespace. If you do not specify a namespace and a ncName, the service returns information about all tags.
particleId
String Optional. The sequential number for the particle in a group that you want to query. A value of 1 refers to the first instance of the field with ncName#namespace name.
objectIndex
String Optional. Index of an object in the group. You can supply objectIndex instead of supplying ncname, namespace, and particleId).
Output Parameters
results
Document List IData array containing the results of the query for group values. The array contains one document for each value. Because an object can contain multiple values, the length of the list might be longer than the number of tags contained in the group. All the values from all of the tags are combined into a single list, representing the list of values as they appeared in the input XML.
This service simplifies obtaining values for content when the object tags are a mixture of any and substitution tags. The returned array has the corresponding tags for the value as it appeared in the original XML rather than the as it appears in the document type object model.
Key
Value
objectIndex
String The offset of the object in the list group objects in the provided groupValue. This is the tag to which the value belongs. If a tag has more than one value, then more than one item in the results array will have the same objectIndex.
ncName
String NCName portion of the value tag. If the tagType is a substitution or any tag, the value tag will not have the same NCName as the object tag.
namespace
String Namespace portion of the value tag. If the tagType is a substitution or any tag, the value tag will not have the same namespace as the object tag.
particleId
String ParticleID portion of the value tag. If the tagType is a substitution or any tag, the particleId is 1.
index
String The offset into the repeating values for the object that corresponds to objectIndex.
tagType
String Type of tag. The tagType is one of the following:
*group
*element
value
Object Value associated with the tag at the returned index.
valueType
String The base value type. The valueType is one of the following:
*simple indicates a String value.
*group indicates that the value is an IData that does not contain attributes, nor does it contain a repeating top-level group.
*complex indicates the value contains attributes and/or a repeating top-level group.
*none indicates an empty model.
complexContent
Object Conditional. The complexContent for the returned value. The complexContent is returned for complex values only.
repeatingComplexContent
String Conditional. Indicates if the top-level group value is an array (. A value of:
*true indicates the object is an array.
*false indicates the object is not an array.
The repeatingComplexContent variable is returned only for complex values (that is, when valueType is complex).
complexContentType
String Conditional. The type of complex content. The complexContentType can be one of the following:
*simple
*group
*none
attributes
Document Conditional. An IData containing the attribute and values.
The attributes variable is returned only for complex values (that is, when valueType is complex).