IDRARestServer.GetContainersRequest Method

IDRARestServer GetContainersRequest Method

DRA REST Extensions SDK

Retrieves a list of containers matching the specified search criteria or returns the requested attributes of a specified container.
UriTemplate: /dra/domains/{domainFqdn}/containers/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/{domainFqdn}/containers/get")]
Stream GetContainersRequest(
	string domainFqdn,
	string containerIdentifier,
	Container containerAndFilter,
	Container containerOrFilter,
	PowerFilter[] powerFilters,
	SimpleFilterCollection additionalAndFilters,
	SimpleFilterCollection additionalOrFilters,
	string[] attributes,
	GetInfoOptions getInfoOptions,
	EnumerationOptions enumerationOptions,
	ConnectionParameters connectionParameters
)

[OperationContractAttribute]
[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json, 
	RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, 
	UriTemplate = "/dra/domains/{domainFqdn}/containers/get")]
Stream GetContainersRequest(
	string domainFqdn,
	string containerIdentifier,
	Container containerAndFilter,
	Container containerOrFilter,
	PowerFilter[] powerFilters,
	SimpleFilterCollection additionalAndFilters,
	SimpleFilterCollection additionalOrFilters,
	string[] attributes,
	GetInfoOptions getInfoOptions,
	EnumerationOptions enumerationOptions,
	ConnectionParameters connectionParameters
)

<OperationContractAttribute> 
<WebInvokeAttribute(Method := "POST", ResponseFormat := WebMessageFormat.Json, 
	RequestFormat := WebMessageFormat.Json, BodyStyle := WebMessageBodyStyle.Wrapped, 
	UriTemplate := "/dra/domains/{domainFqdn}/containers/get")> 
Function GetContainersRequest ( 
	domainFqdn As String,
	containerIdentifier As String,
	containerAndFilter As Container,
	containerOrFilter As Container,
	powerFilters As PowerFilter(),
	additionalAndFilters As SimpleFilterCollection,
	additionalOrFilters As SimpleFilterCollection,
	attributes As String(),
	getInfoOptions As GetInfoOptions,
	enumerationOptions As EnumerationOptions,
	connectionParameters As ConnectionParameters
) As Stream

<OperationContractAttribute> 
<WebInvokeAttribute(Method := "POST", ResponseFormat := WebMessageFormat.Json, 
	RequestFormat := WebMessageFormat.Json, BodyStyle := WebMessageBodyStyle.Wrapped, 
	UriTemplate := "/dra/domains/{domainFqdn}/containers/get")> 
Function GetContainersRequest ( 
	domainFqdn As String,
	containerIdentifier As String,
	containerAndFilter As Container,
	containerOrFilter As Container,
	powerFilters As PowerFilter(),
	additionalAndFilters As SimpleFilterCollection,
	additionalOrFilters As SimpleFilterCollection,
	attributes As String(),
	getInfoOptions As GetInfoOptions,
	enumerationOptions As EnumerationOptions,
	connectionParameters As ConnectionParameters
) As Stream

Parameters

domainFqdn: Type: System String
The FQDN of the domain to query

containerIdentifier: Type: System String
A string identifying the container. Used to indicate that the requested attributes of the container should be returned.

containerAndFilter: Type: NetIQ.DRA.Common.Rest.DataModels Container
An optional Container object that defines the attribute match patterns to filter on to use in the 'and' clause

containerOrFilter: Type: NetIQ.DRA.Common.Rest.DataModels Container
An optional Container 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 list of properties to retrieve from the server

getInfoOptions: Type: NetIQ.DRA.Common.Rest.DataModels GetInfoOptions
An optional GetInfoOptions structure that controls what data is 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 GetContainerPropertiesResponse when attributes of a container are requested or a ContainerListResponse containing the containers 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)