| IDRARestServerContainerEnum Method |
Retrieves a list of managed objects that match the specified filters across all managed domains
UriTemplate: /dra/managedObjects/get
Namespace:
NetIQ.DRA.RestServiceLibrary
Assembly:
NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 10.2.2.1
Syntax [OperationContractAttribute]
[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json,
RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
UriTemplate = "/dra/managedObjects/get")]
Stream ContainerEnum(
Computer computerAndFilter,
Computer computerOrFilter,
Contact contactAndFilter,
Contact contactOrFilter,
Domain domainAndFilter,
Domain domainOrFilter,
DomainMember domainMemberAndFilter,
DomainMember domainMemberOrFilter,
Group groupAndFilter,
Group groupOrFilter,
OU ouAndFilter,
OU ouOrFilter,
User userAndFilter,
User userOrFilter,
EquipmentMailbox equipmentMailboxOrFilter,
EquipmentMailbox equipmentMailboxAndFilter,
RoomMailbox roomMailboxOrFilter,
RoomMailbox roomMailboxAndFilter,
SharedMailbox sharedMailboxOrFilter,
DynamicDistributionGroup ddgAndFilter,
DynamicDistributionGroup ddgOrFilter,
Container containerAndFilter,
Container containerOrFilter,
BuiltinContainer builtinAndFilter,
BuiltinContainer builtinOrFilter,
PowerFilter[] powerFilters,
SimpleFilterCollection additionalAndFilters,
SimpleFilterCollection additionalOrFilters,
string[] attributes,
EnumerationOptions enumerationOptions,
ConnectionParameters connectionParameters
)
<OperationContractAttribute>
<WebInvokeAttribute(Method := "POST", ResponseFormat := WebMessageFormat.Json,
RequestFormat := WebMessageFormat.Json, BodyStyle := WebMessageBodyStyle.Wrapped,
UriTemplate := "/dra/managedObjects/get")>
Function ContainerEnum (
computerAndFilter As Computer,
computerOrFilter As Computer,
contactAndFilter As Contact,
contactOrFilter As Contact,
domainAndFilter As Domain,
domainOrFilter As Domain,
domainMemberAndFilter As DomainMember,
domainMemberOrFilter As DomainMember,
groupAndFilter As Group,
groupOrFilter As Group,
ouAndFilter As OU,
ouOrFilter As OU,
userAndFilter As User,
userOrFilter As User,
equipmentMailboxOrFilter As EquipmentMailbox,
equipmentMailboxAndFilter As EquipmentMailbox,
roomMailboxOrFilter As RoomMailbox,
roomMailboxAndFilter As RoomMailbox,
sharedMailboxOrFilter As SharedMailbox,
ddgAndFilter As DynamicDistributionGroup,
ddgOrFilter As DynamicDistributionGroup,
containerAndFilter As Container,
containerOrFilter As Container,
builtinAndFilter As BuiltinContainer,
builtinOrFilter As BuiltinContainer,
powerFilters As PowerFilter(),
additionalAndFilters As SimpleFilterCollection,
additionalOrFilters As SimpleFilterCollection,
attributes As String(),
enumerationOptions As EnumerationOptions,
connectionParameters As ConnectionParameters
) As Stream
Parameters
- computerAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsComputer
An optional Computer object that defines the attribute patterns to match for computers to use in the 'and' clause - computerOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsComputer
An optional Computer object that defines the attribute patterns to match for computers to use in the 'or' clause - contactAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsContact
An optional Contact object that defines the attribute patterns to match for contacts to use in the 'and' clause - contactOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsContact
An optional Contact object that defines the attribute patterns to match for contacts to use in the 'or' clause - domainAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsDomain
An optional Domain object that defines the attribute patterns to match for domains to use in the 'and' clause - domainOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsDomain
An optional Domain object that defines the attribute patterns to match for domains to use in the 'or' clause - domainMemberAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsDomainMember
An optional DomainMember object that defines the attribute patterns to match for domain members to use in the 'and' clause - domainMemberOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsDomainMember
An optional DomainMember object that defines the attribute patterns to match for domain members to use in the 'or' clause - groupAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsGroup
An optional Group object that defines the attribute patterns to match for groups to use in the 'and' clause - groupOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsGroup
An optional Group object that defines the attribute patterns to match for groups to use in the 'or' clause - ouAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsOU
An optional OU object that defines the attribute patterns to match for organizational units - ouOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsOU
An optional OU object that defines the attribute patterns to match for organizational units - userAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsUser
An optional User object that defines the attribute patterns to for users - userOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsUser
An optional User object that defines the attribute patterns to for users - equipmentMailboxOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsEquipmentMailbox
An optional EquipmentMailbox object that defines the attribute patterns to match for resource mailbox users to use in the 'or' clause - equipmentMailboxAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsEquipmentMailbox
An optional EquipmentMailbox object that defines the attribute patterns to match for resource mailbox users to use in the 'and' clause - roomMailboxOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsRoomMailbox
An optional RoomMailbox object that defines the attribute patterns to match for resource mailbox users to use in the 'or' clause - roomMailboxAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsRoomMailbox
An optional RoomMailbox object that defines the attribute patterns to match for resource mailbox users to use in the 'and' clause - sharedMailboxOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsSharedMailbox
An optional SharedMailbox object that defines the attribute patters to match for shared mailboxes to use in the 'or' clause - ddgAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsDynamicDistributionGroup
An optional DynamicDistributionGroup object that defines the attribute patterns to match for dynamicDistributionGroups to use in the 'and' clause - ddgOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsDynamicDistributionGroup
An optional DynamicDistributionGroup object that defines the attribute patterns to match for dynamicDistributionGroups to use in the 'or' clause - containerAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsContainer
An optional Container object that defines the attribute patterns to match for containers to use in the 'and' clause - containerOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsContainer
An optional Container object that defines the attribute patterns to match for containers to use in the 'or' clause - builtinAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsBuiltinContainer
An optional BuiltinContainer object that defines the attribute patterns to match for builtin containers to use in the 'and' clause - builtinOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsBuiltinContainer
An optional BuiltinContainer object that defines the attribute patterns to match for builtin containers to use in the 'or' clause - powerFilters
- Type: NetIQ.DRA.Common.Rest.DataModelsPowerFilter
An optional PowerFilter object that limits the returned objects to those which the AA has the specified powers over - additionalAndFilters
- Type: NetIQ.DRA.Common.Rest.DataModelsSimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'and' clauuse - additionalOrFilters
- Type: NetIQ.DRA.Common.Rest.DataModelsSimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'or' clauuse - attributes
- Type: SystemString
An optional list of the properties to retrieve from the server for all objects - enumerationOptions
- Type: NetIQ.DRA.Common.Rest.DataModelsEnumerationOptions
An optional EnumerationOptions structure that controls how the enumeration is performed - connectionParameters
- Type: NetIQ.DRA.Common.Rest.DataModelsConnectionParameters
Optional ConnectionParameters to specify a DRA server and Assistant Admin credentials
Return Value
Type:
StreamA
ManagedObjectListResponse object containing the operation results
Remarks Filters
Filters are specified by sending an object in the payload that corresponds to the object type and logical operand. The object should contain the
attributes to match on with the match string as it's value. The logic applied accross multiple fields is indicated by the logical operand in the filter
name. For example, if a computerOrFilter is included in the payload with match strings for three different attributes then any computer
that matches any of the match strings is included in the response. If it were a computerAndFilter then a computer would have to match all
match strings to be included in the response.
Examples
The following filter will match users whose firstName is 'Fred', description contains 'employee', or whose city begins with 'H':
"userOrFilter": {
"firstName": "Fred",
"description": "*employee*",
"city": "H*"
}
Use the | character to specify multiple match patterns for the same attribute. The following filter matches users whose city begins with 'H' or 'P':
"userOrFilter": {
"city": "H*|P*"
}
See Also