EndPoint Get Groups
Name
get_groups
Description
Get the list of groups. [API reference]
Parameters
| Parameter | Label | Required | Options | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| OrderBy | Order By | NO |
|
Order the specified column by ascending or descending order [API reference] | ||||||||||
| SearchCriteria | Search Criteria | NO |
|
Data filter (e.g. somecolumn -eq 'somevalue') [API reference] | ||||||||||
| PageSize | Page Size | NO | The number of records to include in each page of results [API reference] |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
|---|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(255)
|
255 | False | |
| DisplayName |
DT_WSTR
|
nvarchar(500)
|
500 | False | |
| Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | False | |
DT_WSTR
|
nvarchar(200)
|
200 | False | ||
| IdPath |
DT_WSTR
|
nvarchar(255)
|
255 | False | |
| CreatedDateTime |
DT_DBTIMESTAMP
|
datetime
|
False | ||
| DeletedDateTime |
DT_DBTIMESTAMP
|
datetime
|
False |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||