- Release notes
- Overview
- Getting started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Publishing Guidelines for Process Mining app templates
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams scope
- Create team
- Create team from group
- Get team
- Get teams
- Channels
- Create channel
- Delete channel
- Get channel
- Get channels
- Update channel
- Chats
- Get chat
- Get chats
- Get chat members
- Messages
- Get message
- Get messages
- Get message replies
- Reply to message
- Send message
- Events
- Create event
- Delete event
- Get event
- Get events
- Users
- Get user presence
- How it works
- Technical references
- Get started
- About
- Setup
- Technical references
- Azure Form Recognizer scope
- Activities
- Analyze form
- Analyze form async
- Get analyze form result
- Analyze receipt
- Analyze receipt async
- Get analyze receipt result
- Analyze layout
- Analyze layout async
- Get analyze layout result
- Train model
- Get models
- Get model keys
- Get model info
- Delete model
- Connectors
- How to create activities
- Build Your Integration
Marketplace user guide
Get channel
Overview
The Get Channel activity calls the Microsoft Graph GetChannel API to retrieve the properties and relationships of a specified channel (ChannelId) from a team (TeamId).
After retrieving the channel, the activity returns its properties and relationships in a Channel object (Channel) that you can use as input variables in subsequent activities (e.g., Channel.Id in Get Messages, Send Message, etc.).
Unlike the Get Channels activity, which searches and returns a list of channels(Channel[]) using your specified QueryOptions, the Get Channel activity retrieves a single, specified channel (Channel) using the provided ChannelId and TeamId. This activity is not intended to be used to search for a channel like the Get Channels activity and can only be used when the Channel.Id value is known.
How it works
The following steps and message sequence diagram is an example of how the activity works from design time (that is, 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.Idvalue (e.g., Get Teams) AND an activity or external process that outputs aChannel.Idvalue (e.g., Create Channel). - Add the Get Channel activity inside the Microsoft Teams Scope activity.
- Enter values for the Input properties.
- Create and enter a
Channelvariable for your Output property. - Run the activity.
-
Your input property values are sent to the GetChannel API.
-
The API returns the
Channelvalue 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 | String |
| Required | Yes |
| Default value | Get Channel |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
Input
TeamId
The Id of the Team object that you want to retrieve the channel from.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (for example, Create Team or external API call) |
ChannelId
The Id of the Channel object that you want to retrieve.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Channel.Id value, use an external process or activity that includes the Channel.Id value in its output (for example, Create Channel or external API call) |
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 |
Output
Channel
The Channel object that represents the retrieved channel.
| Attributes | Details |
|---|---|
| Type |
|
| Required | No (required if you plan to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a Team variable. |
| Notes |
|
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.
