Integration Server 10.11 | Built-In Services Reference Guide | XMLData Folder | Summary of Elements in this Folder | pub.xmldata:getGroupObjects
 
pub.xmldata:getGroupObjects
WmPublic. Queries the object tags and objects in a group of unknown structure to return information about the tags in the group.
The structure of a group is unknown when:
*The conversion from XML to XmlData is not directed by an XML document type.
*The complexContent model for a group is anyType.
*A content model contains any or substitutionGroup particles.
The service returns information for a specific tag or set of tags in a group. (A group consists of tags and objects.) This is in contrast to pub.xmldata:getGroupValues which returns information about the values in a group.
The service takes a group as input and, for output, produces a list of descriptive information Documents about each tag in the group that meets the provided query criteria. A tag is comprised of a particle-id, a local name, and an optional namespace. The object associated with a tag can be an array if the tag is defined as holding repeating values (maxOccurs > 1).
Input Parameters
query
Document. Document containing the group to query and the query parameters.
Key
Description
groupValue
Document The group to be queried in an XmlData document.
ncName
String Optional. The NCName (non-colonized name) of the tags 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 only tags that do not belong to a namespace. If you do not specify a namespace, the service looks for a tags that belong to any namespace.
If no ncName and no namespace is specified, the service queries 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.
Output Parameters
results
Document List. Query results. Returns one document for each tag in the input group that meets the query parameters.
Key
Value
ncName
String NCName portion of the tag.
namespace
String Namespace portion of the tag.
particleID
String ParticleId portion of the tag
tagType
String Type of tag. The tagType is one of the following:
*any
*group
*element
*substitution
object
Object. The object associated with the tag.
objectType
String The base object type. The objectType is one of the following:
*String
*Document
*Object
hasRepeatingValues
String Indicates if the object is an array. A value of:
*true indicates the object is an array.
*false indicates the object is not an array.
size
String The size of the array.
Usage Notes
Together, the ncName, namespace, and particleId identify a particular field in the XmlData group.