IDRARestServer.EquipmentMailboxGetRequest Method

IDRARestServer EquipmentMailboxGetRequest Method

DRA REST Extensions SDK

Retrieves a list of equipment mailboxes matching the specified search criteria or returns the requested attributes of a specified equipment mailbox.
UriTemplate: /dra/domains/{domainFqdn}/equipmentmailboxes/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}/equipmentmailboxes/get")]
Stream EquipmentMailboxGetRequest(
	string domainFqdn,
	string equipmentMailboxIdentifier,
	EquipmentMailbox equipmentMailboxOrFilter,
	PowerFilter[] powerFilters,
	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}/equipmentmailboxes/get")]
Stream EquipmentMailboxGetRequest(
	string domainFqdn,
	string equipmentMailboxIdentifier,
	EquipmentMailbox equipmentMailboxOrFilter,
	PowerFilter[] powerFilters,
	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}/equipmentmailboxes/get")> 
Function EquipmentMailboxGetRequest ( 
	domainFqdn As String,
	equipmentMailboxIdentifier As String,
	equipmentMailboxOrFilter As EquipmentMailbox,
	powerFilters As PowerFilter(),
	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}/equipmentmailboxes/get")> 
Function EquipmentMailboxGetRequest ( 
	domainFqdn As String,
	equipmentMailboxIdentifier As String,
	equipmentMailboxOrFilter As EquipmentMailbox,
	powerFilters As PowerFilter(),
	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

equipmentMailboxIdentifier: Type: System String
A string identifying an equipment mailbox. Used to indicate the requested attributes of the equipment mailbox should be returned.

equipmentMailboxOrFilter: Type: NetIQ.DRA.Common.Rest.DataModels EquipmentMailbox
An optional EquipmentMailbox object that defines the attribute patterns to match.

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

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 GetResourceMailboxPropertiesResponse when attributes of an equipment mailbox are requested or a ResourceMailboxListResponse containing the equipment mailboxes 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)