Microsoft Teams

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Action examples

This section shows how to perform some of the actions operations in this connector.

Example - Actions

This example sends a message to a specificChat entity.

1. In the Configure connector task dialog, click Actions.
2. Select SendMessage from the Actions list.
3. Select the Actions operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

         {
           "TeamId": "cc110f3f-3088-4b4c-b965-e1f3e0a2dfab",
           "ChannelId": "19%3a7680178ef3ab4b1eb762a7078b990083%40thread.tacv2",
           "Content": "Hello Guys Lets play"
         }

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all records

This example lists all the records in the Channel Members entity.

1. In the Configure connector task dialog, click Entities.
2. Select Channel Members from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes ('). For example, Id='13b1724a91ce448bad2f1986321fc70f'. You can also specify multiple filter conditions by using the logic operators. For example, Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false.

Example - Get a record

This example gets a record with the specified ID from the Chats entity.

1. In the Configure connector task dialog, click Entities.
2. Select Chats from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 19:1956432abc05491bb26f51f9f7263020@thread.v2 in the Default Value field.

   Here, 19:1956432abc05491bb26f51f9f7263020@thread.v2 is a primary key value in the Chats entity.

Example - Create a record

This example creates a record in the Group Owners entity.

1. In the Configure connector task dialog, click Entities.
2. Select Group Owners from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "GroupId": "1356c566-d799-4d49-86c0-b09ab6afdb47",
     "MemberId": "caf19b29-3af1-4191-b455-16468e6aba4b"
   }

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

   {
   "Id": "c3c68bc9a1343242443ca8e5ddcaa0000"
   }

Example - Update a record

This example updates the record with the specified ID in the Teams entity.

1. In the Configure connector task dialog, click Entities.
2. Select Teams from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
         "displayName": "My Team Name Changed",
         "description": "Changed the description for my team"
       }

5. Click filterClause, and then enter id = '953933bc-1024-4ce7-84dc-bae7f24dc2ca' in the Default Value field.

Example - Delete a record

This example deletes the record with the specified ID in the Group Owners entity.

1. In the Configure connector task dialog, click Entities.
2. Select Group Owners from the Entity list.
3. Select the Delete operation, and then click Done.