Reference

Endpoint Get Groups

Name

get_groups

Description

Get the list of groups. [API reference]

Related Tables

Groups

Parameters

Parameter Required Options
Name: OrderBy

Label: Order By

Order the specified column by ascending or descending order
Option Value
None
AscendingOrder SomeColumn asc
DescendingOrder SomeColumn desc
Name: SearchCriteria

Label: Search Criteria

Data filter (e.g. somecolumn -eq 'somevalue')
Option Value
None
Equal Search SomeColumn eq 'SomeValue'
Substring Search substringof(SomeField,'abc')
Starts With startswith(SomeField, 'abc')
Name: PageSize

Label: Page Size

The number of records to include in each page of results

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(500) 500
DisplayName DT_WSTR nvarchar(500) 500
DeletedDateTime DT_WSTR nvarchar(500) 500
Classification DT_WSTR nvarchar(500) 500
CreatedDateTime DT_DBTIMESTAMP datetime
CreationOptions DT_WSTR nvarchar(1470) 1470
Description DT_WSTR nvarchar(1000) 1000
ExpirationDateTime DT_WSTR nvarchar(500) 500
GroupTypes DT_WSTR nvarchar(500) 500
IsAssignableToRole DT_BOOL bit
Mail DT_WSTR nvarchar(500) 500
MailEnabled DT_BOOL bit
MailNickname DT_WSTR nvarchar(100) 100
MembershipRule DT_WSTR nvarchar(500) 500
MembershipRuleProcessingState DT_WSTR nvarchar(500) 500
OnPremisesDomainName DT_WSTR nvarchar(500) 500
OnPremisesLastSyncDateTime DT_WSTR nvarchar(500) 500
OnPremisesNetBiosName DT_WSTR nvarchar(500) 500
OnPremisesSamAccountName DT_WSTR nvarchar(500) 500
OnPremisesSecurityIdentifier DT_WSTR nvarchar(500) 500
OnPremisesSyncEnabled DT_WSTR nvarchar(500) 500
PreferredDataLocation DT_WSTR nvarchar(500) 500
PreferredLanguage DT_WSTR nvarchar(500) 500
ProxyAddresses DT_WSTR nvarchar(4000) 4000
RenewedDateTime DT_DBTIMESTAMP datetime
ResourceBehaviorOptions DT_WSTR nvarchar(1020) 1020
ResourceProvisioningOptions DT_WSTR nvarchar(500) 500
SecurityEnabled DT_BOOL bit
SecurityIdentifier DT_WSTR nvarchar(1000) 1000
Theme DT_WSTR nvarchar(500) 500
UniqueName DT_WSTR nvarchar(500) 500
Visibility DT_WSTR nvarchar(100) 100
OnPremisesProvisioningErrors DT_WSTR nvarchar(50) 50
ServiceProvisioningErrors DT_WSTR nvarchar(50) 50
If the column you are looking for is missing, consider customizing Outlook Mail (Office 365) Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Outlook Mail (Office 365) Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Groups table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Outlook Mail (Office 365)
Outlook Mail Connector (Office 365) can be used to integrate Office 365 Outlook Mail API in your App / BI Tools. You can download attachment, read / search Emails, Users, MailFolders, Send email and more.
Outlook Mail (Office 365)
Groups
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Groups table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get groups:

API Destination - Outlook Mail (Office 365)
Outlook Mail Connector (Office 365) can be used to integrate Office 365 Outlook Mail API in your App / BI Tools. You can download attachment, read / search Emails, Users, MailFolders, Send email and more.
Outlook Mail (Office 365)
Groups
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get groups (Office 365) 

select * from Groups 
			--Where Id='049beb7f-03e0-4b0d-825d-73567b6786e9'

get_groups endpoint belongs to Groups table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get groups (Office 365) 

DECLARE @MyQuery NVARCHAR(MAX) = 'select * from Groups 
			--Where Id=''049beb7f-03e0-4b0d-825d-73567b6786e9''';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

get_groups endpoint belongs to Groups table(s), and can therefore be used via those table(s).