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: 10.2.2.1

Syntax

Copy

[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,
	EquipmentMailbox equipmentMailboxAndFilter,
	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,
	equipmentMailboxAndFilter As EquipmentMailbox,
	powerFilters As PowerFilter(),
	attributes As String(),
	getInfoOptions As GetInfoOptions,
	enumerationOptions As EnumerationOptions,
	connectionParameters As ConnectionParameters
) As Stream

Parameters

domainFqdn: Type: SystemString
The FQDN of the domain to query
equipmentMailboxIdentifier: Type: SystemString
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.DataModelsEquipmentMailbox
An optional EquipmentMailbox object that defines the attribute patterns to use in the 'or' clause for match.
equipmentMailboxAndFilter: Type: NetIQ.DRA.Common.Rest.DataModelsEquipmentMailbox
An optional EquipmentMailbox object that defines the attribute patterns to use in the 'and' clause for match.
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
attributes: Type: SystemString
An optional list of properties to retrieve from the server
getInfoOptions: Type: NetIQ.DRA.Common.Rest.DataModelsGetInfoOptions
An optional GetInfoOptions structure that controls what data is 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 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 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("LST222FE5B4_0?cpp=::|nu=.");EquipmentMailboxGetRequest Method

Parameters

Return Value

Reference

IDRARestServerEquipmentMailboxGetRequest Method