UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

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 how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Teams Scope activity to your project.
  3. Add an activity or run an external process that outputs a Team.Id value (e.g., Get Teams) AND an activity or external process that outputs a Channel.Id value (e.g., Create Channel).
  4. Add the Get Channel activity inside the Microsoft Teams Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a Channel variable for your Output property.
  7. Run the activity.
    • Your input property values are sent to the GetChannel 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

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 (e.g., 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 (e.g.,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

Channel

Required

No (required if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a Team variable.

Notes

  • The variable you create for this property can be used as an input variable in subsequent activities (e.g., Channel.Id in Get Messages, Send Message, etc.).
  • The Channel object includes multiple properties and relationships that you can use in other activities.The example image below shows some of the properties that you can return.
  • Note - some properties listed in the designer are not applicable to the Channel object (e.g., Visibility). For a list of the applicable Team properties, visit the links above.

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 3 months ago


Get Channel


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.