IDRARestServer.GetDomainsRequest Method

IDRARestServer GetDomainsRequest Method

DRA REST Extensions SDK

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: 1.1.0.318 (1.1.0.318)

Syntax

C++

Copy to Clipboard Print

[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")]
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

<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: System String
A string identifying the domain. Used to indicate that the requested attributes of the domain should be returned.

domainAndFilter: Type: NetIQ.DRA.Common.Rest.DataModels Domain
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.DataModels Domain
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.DataModels PowerFilter
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.DataModels SimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'and' clauuse

additionalOrFilters: Type: NetIQ.DRA.Common.Rest.DataModels SimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'or' clauuse

attributes: Type: System String
An optional array of attributes to retrieve. If not specified a default set will be returned.

enumerationOptions: Type: NetIQ.DRA.Common.Rest.DataModels EnumerationOptions
An optional EnumerationOptions structure that controls how the enumeration is performed

connectionParameters: Type: NetIQ.DRA.Common.Rest.DataModels ConnectionParameters
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 ContainerEnum(Computer, Computer, Contact, Contact, Domain, Domain, Group, Group, OU, OU, User, User, EquipmentMailbox, RoomMailbox, DynamicDistributionGroup, DynamicDistributionGroup, Container, Container, BuiltinContainer, BuiltinContainer, PowerFilter , SimpleFilterCollection, SimpleFilterCollection, String , EnumerationOptions, ConnectionParameters)