Retrieves a list of domains matching the specified search criteria or returns the requested attributes of a specified domain.
UriTemplate: /dra/domains/get

Namespace: NetIQ.DRA.RestServiceLibrary
Assembly: NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 10.2.2.1

Syntax

Copy

[OperationContractAttribute]
[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json, 
	RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, 
	UriTemplate = "/dra/domains/get")]
Stream GetDomainsRequest(
	string domainIdentifier,
	Domain domainAndFilter,
	Domain domainOrFilter,
	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/domains/get")>
Function GetDomainsRequest ( 
	domainIdentifier As String,
	domainAndFilter As Domain,
	domainOrFilter As Domain,
	powerFilters As PowerFilter(),
	additionalAndFilters As SimpleFilterCollection,
	additionalOrFilters As SimpleFilterCollection,
	attributes As String(),
	enumerationOptions As EnumerationOptions,
	connectionParameters As ConnectionParameters
) As Stream

Parameters

domainIdentifier: Type: SystemString
A string identifying the domain. Used to indicate that the requested attributes of the domain should be returned.
domainAndFilter: Type: NetIQ.DRA.Common.Rest.DataModelsDomain
An optional domain object that defines the attribute match patterns to filter on to use in the 'and' clause
domainOrFilter: Type: NetIQ.DRA.Common.Rest.DataModelsDomain
An optional domain object that defines the attribute match patterns to filter on 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 array of attributes to retrieve. If not specified a default set will be returned.
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 DomainGetPropertiesResponse when attributes of a domain are requested or a DomainListResponse containing the domains that matched the specified search filters.

Remarks

For more information on object filters, see the topic on ObjectEnum(Computer, Computer, Contact, Contact, Domain, Domain, DomainMember, DomainMember, AzureTenant, AzureTenant, AzureGroup, AzureGroup, AzureUser, AzureUser, AzureContact, AzureContact, Group, Group, OU, OU, User, User, GroupManagedServiceAccount, GroupManagedServiceAccount, EquipmentMailbox, EquipmentMailbox, RoomMailbox, RoomMailbox, SharedMailbox, DynamicDistributionGroup, DynamicDistributionGroup, Container, Container, BuiltinContainer, BuiltinContainer, PowerFilter, SimpleFilterCollection, SimpleFilterCollection, String, EnumerationOptions, ConnectionParameters)

Reference

IDRARestServer Interface

NetIQ.DRA.RestServiceLibrary Namespace

IDRARestServerAddLanguageSpecificTextSet("LST996E4EB4_0?cpp=::|nu=.");GetDomainsRequest Method

Parameters

Return Value

Reference

IDRARestServerGetDomainsRequest Method