| IDRARestServerContactGet Method |
Retrieves a list of contacts matching the specified search criteria or returns the requested attributes of a specified contact.
UriTemplate: /dra/domains/{domainFqdn}/contacts/get
Namespace:
NetIQ.DRA.RestServiceLibrary
Assembly:
NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 10.2.2.1
Syntax [OperationContractAttribute]
[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json,
RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
UriTemplate = "/dra/domains/{domainFqdn}/contacts/get")]
Stream ContactGet(
string domainFqdn,
string contactIdentifier,
Contact contactAndFilter,
Contact contactOrFilter,
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}/contacts/get")>
Function ContactGet (
domainFqdn As String,
contactIdentifier As String,
contactAndFilter As Contact,
contactOrFilter As Contact,
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: SystemString
The FQDN of the domain to query - contactIdentifier
- Type: SystemString
A string identifying the contact. Used to indicate that the requested attributes of the contact should be returned. - contactAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsContact
An optional contact object that defines the attribute match patterns to filter on to use in the 'and' clause - contactOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsContact
An optional contact 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 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:
StreamA
GetContactPropertiesResponse when attributes of a contact are requested or a
ContactListResponse containing the contacts 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)See Also