MS Teams – Team – Get Team App From App Items
MS Teams – Team – Get Team App From App Items
Get a Teams team app from a collection of apps by id.
Action details
| Property | Value |
|---|---|
| Action label | MS Teams – Team – Get Team App From App Items |
| Category | CloudTools |
| Apex class and method | GetMSTeamsTeamAppById.getTeamAppById |
| Input type | GetMSTeamsTeamAppById.GetMSTeamsTeamAppByIdInput |
| Output type | List<MSTeamsTeamApp> |
| Authorization | No connection required. |
Prerequisites and permissions
Supply a previously retrieved collection of the documented model type. This helper performs no callout and needs no Microsoft connector or permissions of its own.
Inputs
| Input | Apex field | Type | Required | Description |
|---|---|---|---|---|
| Id | id | String | Yes | App id to find |
| Items | items | List<MSTeamsTeamApp> | Yes | Apps to search |
Outputs
Returns one item per request, preserving request order. A null request, blank ID, null collection, or missing match yields null. An empty or null request list returns a single null element. The first matching non-null item is returned.
| Output | Apex field | Type | Description |
|---|---|---|---|
| Id | id | String | Unique identifier for the installed app resource |
| Teams App Id | teamsAppId | String | Unique identifier for the app in Teams catalog |
| Teams App Display Name | teamsAppDisplayName | String | Display name of the installed Teams app |
| Teams App External Id | teamsAppExternalId | String | External identifier for the installed Teams app |
| Teams App Definition Id | teamsAppDefinitionId | String | Identifier of the installed Teams app definition |
| Teams App Definition Display Name | teamsAppDefinitionDisplayName | String | Display name of the app definition |
| Teams App Definition Version | teamsAppDefinitionVersion | String | Version of the app definition |
| Distribution Method | distributionMethod | String | Distribution method for the app definition |
| OData Type | odataType | String | OData type for the installed app resource |
| OData ETag | odataEtag | String | OData ETag for the installed app resource |
| Additional Properties | additionalProperties | List<DynamicObject> | Additional properties from user-defined query |
Use in Flow
Add MS Teams – Team – Get Team App From App Items where supported. Pass a previously retrieved collection and an ID; check the returned item for null.
Use in custom Apex
This subscriber-org example uses the Apptigent namespace. Replace example identifiers and values before use. No callout context is required.
Apptigent.GetMSTeamsTeamAppById.GetMSTeamsTeamAppByIdInput request =
new Apptigent.GetMSTeamsTeamAppById.GetMSTeamsTeamAppByIdInput();
request.id = 'REPLACE_WITH_ID';
request.items = new List<Apptigent.MSTeamsTeamApp>{ /* previously retrieved items */ };
List<Apptigent.MSTeamsTeamApp> results =
Apptigent.GetMSTeamsTeamAppById.getTeamAppById(
new List<Apptigent.GetMSTeamsTeamAppById.GetMSTeamsTeamAppByIdInput>{ request }
);
System.debug(results);
Use in a Lightning Web Component
This helper is not exported by msTeamsConnectorLib. Search an existing JavaScript collection with items.find(item => item && item.id === id) || null; this performs no callout.
Error handling and troubleshooting
| Symptom | What to check |
|---|---|
| Null match | Check the collection type and ID. A missing match is returned as null. |