Overview
Using your search parameters (QueryOptions) and specified team (TeamId), the Get Channels activity calls the Microsoft Graph ListChannels API to retrieve the channels that match your query .
After retrieving the channels, the activity returns its properties and relationships in a Channel[]
object (Channels) that you can use as input variables in subsequent activities (e.g., Channel(0).Id
in Get Messages, Send Message, etc.).
How it works
The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
- Add an activity or run an external process that outputs a
Team.Id
value (e.g., Get Teams). - Add the Get Channels activity inside the Microsoft Teams Scope activity.
- Enter values for the Input properties.
- Create and enter a
Channel[]
variable for your Output property. - Run the activity.
- Your input property values are sent to the ListChannels API.
- The API returns the
Channel[]
value to your output property variable.


Properties
The values for the following properties are specified when adding this activity to your project in UiPath Studio.


Common
DisplayName
The display name of the activity.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Get Channels |
Allowed values | Enter a |
Notes | N/A |
Input
TeamId
The Id of the Team
object that you want to retrieve channels from.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Empty |
Allowed values | Enter a |
Notes | To get the |
Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
Attributes | Details |
---|---|
Type | Checkbox |
Required | No |
Default value | Not Selected |
Allowed values | Selected or Not Selected |
Notes | N/A |
Options
QueryOptions
The search parameters that you want to apply when retrieving your list of channels.
Attributes | Details |
---|---|
Type |
|
Required | No |
Default value | Empty |
Allowed values | Enter a |
Notes | Enter your value using an OData system query option; the format is as follows: {New QueryOption("Option", "OptionParameter")}. |
Output
Channels
An array of channels (Channel[]
object) that match QueryOptions value.
Attributes | Details |
---|---|
Type |
|
Required | No (required if you plan to use the output data in subsequent activities) |
Default value | Empty |
Allowed values | Enter a |
Notes | The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get Messages, Send Message, etc.).
|
Example
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the Quickstart guides.


Updated 5 months ago