Actuate Information Delivery API data types : UserSearch
 
UserSearch
A complex data type that represents a user search.
Schema
<xsd:complexType name="UserSearch">
<xsd:sequence>
<xsd:choice minOccurs="0">
<xsd:element name="Condition"
type="typens:UserCondition"/>
<xsd:element name="ConditionArray"
type="typens:ArrayOfUserCondition"/>
</xsd:choice>
<xsd:choice minOccurs="0">
<xsd:element name="MemberOfGroupName" type="xsd:string"/>
<xsd:element name="WithRoleName" type="xsd:string"/>
<xsd:element name="SubscribedToChannelName"
type="xsd:string"/>
<xsd:element name="MemberOfGroupId" type="xsd:string"/>
<xsd:element name="WithRoleId" type="xsd:string"/>
<xsd:element name="WithLicenseOption" type="xsd:string"/>
<xsd:element name="SubscribedToChannelId"
type="xsd:string"/>
</xsd:choice>
<xsd:element name="FetchSize" type="xsd:int" minOccurs="0"/>
<xsd:element name="FetchDirection" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="CountLimit" type="xsd:int" minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Elements
Condition
The search condition.
ConditionArray
An array of search conditions.
MemberOfGroupName
The name of the group of which the user is a member.
WithRoleName
The name of the role to which the user belongs.
SubscribedToChannelName
The name of the channel to which the user is subscribed.
MemberOfGroupId
The ID of the group of which the user is a member.
WithRoleId
The ID of the role to which the user belongs.
WithLicenseOption
The name of the license option assigned to the user.
SubscribedToChannelId
The ID of the channel to which the user is subscribed.
FetchSize
The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.