Office365

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.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

CancelEvent action

This action lets you cancel an event.

Input parameters of the CancelEvent action

For example on how to configure the CancelEvent action, see Action examples.

MoveMail action

This action lets you move an email.

Input parameters of the MoveMail action

For example on how to configure the MoveMail action, see Action examples.

AssignLicense action

This action lets you assign a license.

Input parameters of the AssignLicense action

For example on how to configure the AssignLicense action, see Action examples.

ForwardEvent action

This action lets you forward an event.

Input parameters of the ForwardEvent action

For example on how to configure the ForwardEvent action, see Action examples.

UploadFile action

This action lets you upload a file.

Input parameters of the UploadFile action

For example on how to configure the UploadFile action, see Action examples.

DownloadFile action

This action lets you download a file.

Input parameters of the DownloadFile action

For example on how to configure the DownloadFile action, see Action examples.

CreateFolder action

This action lets you create a folder.

Input parameters of the CreateFolder action

For example on how to configure the CreateFolder action, see Action examples.

SendMail action

This action lets you send an email.

Input parameters of the SendMail action

For example on how to configure the SendMail action, see Action examples.

ForwardMail action

This action lets you forward an email.

Input parameters of the ForwardMail action

For example on how to configure the ForwardMail action, see Action examples.

DownloadEmail action

This action lets you download an email.

Input parameters of the DownloadEmail action

For example on how to configure the DownloadMail action, see Action examples.

DownloadAttachments action

This action lets you download the attachments of an email.

Input parameters of the DownloadAttachments action

For example on how to configure the DownloadAttachments action, see Action examples.

Action examples

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

Example - Cancel an event

This example cancels an event with the specified ID.

1. In the Configure connector task dialog, click Actions.
2. Select the CancelEvent action, and then click Done.
3. 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:

   {
   "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
   "Comment": "Canceled due to rain"
   }

If the action is successful, the CancelEvent task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Assign and remove a license

This example assigns and removes licenses for the specified user.

1. In the Configure connector task dialog, click Actions.
2. Select the AssignLicense action, and then click Done.
3. 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:

   {
   "UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
   "AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
   "RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
   }

If the action is successful, the AssignLicense task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Forward an event

This example forwards an event.

1. In the Configure connector task dialog, click Actions.
2. Select the ForwardEvent action, and then click Done.
3. 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:

   {
   "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
   "Comment": "forwarded due to rain",   
   "ToRecipients": "[email protected]"
   }

If the action is successful, the ForwardEvent task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Upload a file

This example uploads a file.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadFile action, and then click Done.
3. 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:

   {
   "FileName": "Document1234.docx",   
   "ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
   "Content": "test"
   }

If the action is successful, the UploadFile task's connectorOutputPayload response parameter will have a value similar to the following:

 [{
"Id": "01VCU572JX6F3L3NKLQVB2BXETRHLEAUAY",   
"@test.context": "https://example.com/v1.0/$metadata#users('7954f490-5a43-083fc215362a')/drive/items('01VCU5BZO354PWSELRRZ')/test/$entity",   
"@example.downloadurl": "https://example.com/test/admin123/_layouts/15/download.aspx?UniqueId=bd76224r7-4........
"Status": "Success"
}] 

Example - Download a file

This example downloads a file.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadFile action, and then click Done.
3. 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:

   {
   "FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
   }

If the action is successful, the DownloadFile task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success",
"FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J"
}]

Example - Create a folder

This example creates a folder.

1. In the Configure connector task dialog, click Actions.
2. Select the CreateFolder action, and then click Done.
3. 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:

   {
   "ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
   "FolderName": "outbox1234"
   }

If the action is successful, the CreateFolder task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Send an email

This example sends an email to the specified recipients.

1. In the Configure connector task dialog, click Actions.
2. Select the SendMail action, and then click Done.
3. 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:

   {
   "ToRecipients": "[email protected]",   
   "Content": "Testing",   
   "Subject": "Test subject",   
   "FileName": "Google"
   }

If the action is successful, the SendMail task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Forward an email

This example forwards an email.

1. In the Configure connector task dialog, click Actions.
2. Select the ForwardMail action, and then click Done.
3. 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:

   {
   "MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
   "ToRecipients": "[email protected]",   
   "Comment": "forwarded message"
   }

If the action is successful, the ForwardMail task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Download an email

This example downloads an email.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadEmail action, and then click Done.
3. 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:

   {
   "MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
   }

If the action is successful, the DownloadEmail task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success",   
"FileData": "RnJvbTogRk5VIExOVSA8YWRtaW4xMjNANzNzY21nLm9ubWljcm9zb2Z0LmNvbT4NClRvOiB0ZXN0IDx0ZXN0.......
}]

Example - Download attachments

This example downloads attachments.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadAttachments action, and then click Done.
3. 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:

   {
   {"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
   "DownloadTo": "My files/Office355/reports/"}
   }

If the action is successful, the DownloadAttachments task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Id": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGTWAAABEgAQAF3EBDrnTc1Cj8akAYrJjdM=",
"Name": "demoattachment.docx",
"ContentBytes": "UEsDBBQAAAAIALskYlcppqeszQEAAHQJAAATAAAAWAAAI3RyYXNoXS8wMDAwLmRhdP........",
"LastmodifiedDatetime": "2023-11-21T10:09:09Z",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"FileData": null,
"json:repeatelementorder#": null,
"size": "23575",
"isinline": "false
}]