Click or drag to resize

IDRARestServerObjectEnum Method

Retrieves a list of managed objects that match the specified filters across all managed domains
UriTemplate: /dra/objects/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/objects/get")]
Stream ObjectEnum(
	Computer computerAndFilter,
	Computer computerOrFilter,
	Contact contactAndFilter,
	Contact contactOrFilter,
	Domain domainAndFilter,
	Domain domainOrFilter,
	DomainMember domainMemberAndFilter,
	DomainMember domainMemberOrFilter,
	AzureTenant azureTenantAndFilter,
	AzureTenant azureTenantOrFilter,
	AzureGroup azureGroupAndFilter,
	AzureGroup azureGroupOrFilter,
	AzureUser azureUserAndFilter,
	AzureUser azureUserOrFilter,
	AzureContact azureContactAndFilter,
	AzureContact azureContactOrFilter,
	Group groupAndFilter,
	Group groupOrFilter,
	OU ouAndFilter,
	OU ouOrFilter,
	User userAndFilter,
	User userOrFilter,
	GroupManagedServiceAccount gmsaAndFilter,
	GroupManagedServiceAccount gmsaOrFilter,
	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
)

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
azureTenantAndFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureTenant
An optional AzureTenant object that defines the attribute patterns to match for Azure tenant to use in the 'and' clause
azureTenantOrFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureTenant
An optional AzureTenant object that defines the attribute patterns to match for Azure tenant to use in the 'or' clause
azureGroupAndFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureGroup
An optional AzureGroup object that defines the attribute patterns to match for azure groups to use in the 'and' clause
azureGroupOrFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureGroup
An optional AzureGroup object that defines the attribute patterns to match for azure groups to use in the 'or' clause
azureUserAndFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureUser
An optional AzureUser object that defines the attribute patterns to match for azure users to use in the 'and' clause
azureUserOrFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureUser
An optional AzureUser object that defines the attribute patterns to match for azure users to use in the 'or' clause
azureContactAndFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureContact
An optional AzureContact object that defines the attribute patterns to match for azure contacts to use in the 'and' clause
azureContactOrFilter
Type: NetIQ.DRA.Common.Rest.DataModelsAzureContact
An optional AzureContact object that defines the attribute patterns to match for azure contacts 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
gmsaAndFilter
Type: NetIQ.DRA.Common.Rest.DataModelsGroupManagedServiceAccount
An optional GroupManagedServiceAccount object that defines the attribute patterns to match for group managed service accounts users to use in the 'and' clause
gmsaOrFilter
Type: NetIQ.DRA.Common.Rest.DataModelsGroupManagedServiceAccount
An optional GroupManagedServiceAccount object that defines the attribute patterns to match for group managed service accounts users to use in the 'or' clause
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: Stream
A EnumObjectListResponse 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