Office365

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação CancelEvent

Com essa ação, você pode cancelar um evento.

Parâmetros de entrada da ação CancelEvent

Por exemplo, sobre como configurar a ação CancelEvent, consulte Exemplos de ação.

Ação MoveMail

Assim, você pode mover um e-mail.

Parâmetros de entrada da ação MoveMail

Para saber como configurar a ação MoveMail, consulte Exemplos de ação.

Ação "AtribuirLicença"

Essa ação permite que você atribua uma licença.

Parâmetros de entrada da ação AssignLicense

Por exemplo, sobre como configurar a ação AssignLicense, consulte Exemplos de ação.

Ação ForwardEvent

Essa ação permite que você encaminhe um evento.

Parâmetros de entrada da ação ForwardEvent

Por exemplo, sobre como configurar a ação ForwardEvent, consulte Exemplos de ação.

Ação UploadFile

Essa ação permite que você faça upload de um arquivo.

Parâmetros de entrada da ação UploadFile

Para saber como configurar a ação UploadFile, consulte Exemplos de ação.

Ação DownloadFile

Essa ação permite fazer o download de um arquivo.

Parâmetros de entrada da ação DownloadFile

Por exemplo, sobre como configurar a ação DownloadFile, consulte Exemplos de ação.

Ação "CreateFolder"

Essa ação permite criar uma pasta.

Parâmetros de entrada da ação CreateFolder

Para saber como configurar a ação CreateFolder, consulte Exemplos de ação.

Ação SendMail

Essa ação permite enviar um e-mail.

Parâmetros de entrada da ação SendMail

Por exemplo, sobre como configurar o SendMail, consulte os Exemplos de ação.

Ação de ForwardMail

Essa ação permite encaminhar um e-mail.

Parâmetros de entrada da ação ForwardMail

Por exemplo, sobre como configurar o ForwardMail, consulte os Exemplos de ação.

Ação DownloadEmail

Essa ação permite fazer o download de um e-mail.

Parâmetros de entrada da ação DownloadEmail

Por exemplo, sobre como configurar o DownloadMail, consulte os Exemplos de ação.

Ação DownloadAttachments

Essa ação permite fazer o download dos anexos de um e-mail.

Parâmetros de entrada da ação DownloadAttachments

Para saber como configurar a ação DownloadAttachments, consulte Exemplos de ação.

Exemplos de ação

Esta seção descreve como realizar algumas das ações neste conector.

Exemplo: cancelar um evento

Este exemplo cancela um evento com o ID especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CancelEvent e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

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

Se a ação for bem-sucedida, o CancelEvent resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Status": "Success"
}]

Exemplo: atribuir e remover uma licença

Este exemplo atribui e remove licenças do usuário especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AssignLicense e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, a resposta connectorOutputPayload da tarefa AssignLicense terá um valor semelhante ao seguinte:

[{
"Status": "Success"
}]

Exemplo: encaminhar um evento

Este exemplo encaminha um evento.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ForwardEvent e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
   "Comment": "forwarded due to rain",   
   "ToRecipients": "test99@example.com"
   }

Se a ação for bem-sucedida, o ForwardEvent resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo

Este exemplo faz o upload de um arquivo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadFile e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

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

Se a ação for bem-sucedida, o UploadFile resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

 [{
"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"
}] 

Exemplo: fazer o download de um arquivo

Este exemplo faz o download de um arquivo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadFile e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
   }

Se a ação for bem-sucedida, o DownloadFile resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: criar uma pasta

Este exemplo cria uma pasta.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateFolder e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateFolder terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: enviar um e-mail

Este exemplo envia um e-mail para os destinatários especificados.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação SendMail e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "ToRecipients": "test097@example.com",   
   "Content": "Testing",   
   "Subject": "Test subject",   
   "FileName": "Google"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SendMail terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: encaminhar um e-mail

Este exemplo encaminha um e-mail.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ForwardMail e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
   "ToRecipients": "test097@example.com",   
   "Comment": "forwarded message"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ForwardMail terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: fazer o download de um e-mail

Este exemplo faz o download de um e-mail.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadEmail e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadEmail terá um valor semelhante a este:

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

Exemplo: fazer o download de anexos

Este exemplo faz o download de anexos.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadAttachments e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachments terá um valor semelhante a este:

[{
"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
}]