SharePoint

Exemplos de configuração de conexão

Esta seção lista os exemplos de valores para as diversas campos que você configura ao criar a conexão.

Tipo de conexão da Web

Tipo de conexão PSC

Tipo de conexão da credencial do cliente

Tipo de conexão do certificado de portador JWT

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 da entidade, como as operações não estã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

Esta seção lista algumas das ações aceitas pelo conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação DeleteAttachment

Esta ação exclui um anexo.

Parâmetros de entrada da ação DeleteAttachment

Para entender como configurar a ação DeleteAttachment, consulte Exemplos de ação.

Ação CheckInDocument

Essa ação permite que você faça check-in em um documento.

Parâmetros de entrada da ação CheckInDocument

Para entender como configurar a ação CheckInDocument, consulte Exemplos de ação.

Ação CheckOutDocument

Essa ação permite que você faça o check-out de um arquivo.

Parâmetros de entrada da ação CheckOutDocument

Para entender como configurar a ação CheckOutDocument, consulte Exemplos de ação.

Ação DiscardCheckOutDocument

Esta ação permite que você desfaça o check-out de um arquivo.

Parâmetros de entrada da ação DescartarCheckOutDocument

Para entender como configurar a ação DiscardCheckOutDocument, consulte Exemplos de ação.

Ação CopyDocument

Essa ação permite copiar um arquivo de um local para outro.

Parâmetros de entrada da ação CopyDocument

Para entender como configurar a ação CopyDocument, consulte Exemplos de ação.

Ação UploadDocument

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

Parâmetros de entrada da ação UploadDocument

Para entender como configurar a ação UploadDocument, consulte Exemplos de ação.

Ação DownloadDocument

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

Parâmetros de entrada da ação DownloadDocument

Para entender como configurar a ação DownloadDocument, consulte Exemplos de ação.

Ação MoveAttachmentOrDocument

Isso permite que você mova um arquivo de uma pasta para outra.

Parâmetros de entrada da ação MoveAttachmentOrDocument

Para entender como configurar a ação MoveAttachmentOrDocument, consulte Exemplos de ação.

Ação CreateFolder

Essa ação permite criar uma pasta.

Parâmetros de entrada da ação CreateFolder

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

Ação AddAttachments

Essa ação permite adicionar um anexo.

Parâmetros de entrada da ação AddAttachments

Para entender como configurar a ação AddAttachments, consulte Exemplos de ação.

Ação DownloadAttachments

Essa ação permite fazer o download de anexos.

Parâmetros de entrada da ação DownloadAttachments

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

Exemplos de ação

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

Exemplo: excluir um anexo

Este exemplo exclui o arquivo especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteAttachment 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:

   {
   "ListTitle": "My lists",
   "ItemId": "1",
   "FileName": "sitepages.txt"
   }

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

[{
"Status": "Success"
}]

Exemplo: fazer check-in em um documento

Este exemplo faz check-in em um documento.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CheckInDocument 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt",
   "Comment": "Comment test"
   }

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

[{
"Status": "Success"
}]

Exemplo: fazer check-out de um arquivo

Este exemplo verifica um arquivo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CheckOutDocument 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt"
   }

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

[{
"Status": "Success"
}]

Exemplo: descartar uma finalização de compra

Este exemplo reverte um check-out de arquivo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DiscardCheckOutDocument 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.docx"
   }

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

[{
"Status": "Success"
}]

Exemplo: copiar um arquivo

Este exemplo copia um arquivo de um local para outro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CopyDocument 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:

   {
   "SourceFileRelativeUrl": "/Shared Documents/Document.docx",
   "DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
   }

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

[{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo de texto

Este exemplo faz o upload de um arquivo de texto para o local especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadDocument 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:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "Content": "abcd"
   }

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

[{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo binário

Este exemplo faz upload de um arquivo binário para o local especificado. Ao fazer upload de um binário especifique o conteúdo a ser enviado como uma string codificada em Base64.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadDocument 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:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "ContentBytes": "SGVsbG8gd29ybGQK",
   "HasBytes": "true"
   }

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

[{
"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 DownloadDocument 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:

   {
   "RemoteFile": "/TestFolder/test.txt",
   "Library": "Shared Documents"
   }

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

[{
"Success": "True",
"Content": "Test File",
}]

Exemplo: fazer o download de um arquivo binário

Este exemplo faz o download de um arquivo binário.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadDocument 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:

   {
   "RemoteFile": "/TestFolder/test1.png",
   "Library": "Shared Documents"
   "HasBytes": "true"  
   }

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

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Exemplo: mover um anexo

Este exemplo move um anexo de um local para outro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação MoveAttachmentOrDocument 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:

   {
   "SourceFileURL": "/Shared Documents/test.txt",
   "DestinationFolderURL": "/Shared Documents/TestFolder"
   }

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

[{
"Result": "Success"
}]

Exemplo: criar uma pasta

Este exemplo cria uma pasta no local especificado.

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 de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "FolderName": "TestFolder123"
   }

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

[{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Exemplo: adicionar um anexo

Este exemplo adiciona um anexo à lista especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AddAttachments 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:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment2",
   "Content": "abcd text",
   "ItemId": "1"
   }

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

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Exemplo: adicionar um anexo binário

Este exemplo adiciona um anexo binário à lista especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AddAttachments 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:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment3",
   "ContentBytes": "VGVzdCBGaWxl",
   "HasBytes": "true",  
   "ItemId": "1"
   }

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

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Exemplo: fazer o download de um anexo

Este exemplo faz o download de um anexo.

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 de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "RemoteFile": "/Shared Documents/Document.txt"
   }

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

[{
"Success": "True",
"Content": "Test File",
}]

Exemplo: fazer o download de um anexo binário

Este exemplo faz o download de um anexo binário.

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 de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "RemoteFile": "/Shared Documents/Document.docx",
   "HasBytes": "true"
   }

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

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Exemplos de operações de entidade

Esta seção mostra como executar algumas das operações de entidade neste conector.

Exemplo: listar todos os arquivos

Este exemplo lista todos os arquivos da entidade Files.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Files na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, você também pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Você também pode especificar várias condições de filtro usando os operadores lógicos.

Exemplo: acessar uma lista

Este exemplo recebe uma lista com o ID especificado da entidade My Lists.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione My Lists na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Task Input da tarefa Connectors, clique em EntityId e e insira 3 no campo Valor padrão.

   Aqui, 3 é um valor de chave primária na entidade My Lists.

Exemplo: criar um registro

Este exemplo cria um registro na entidade My Lists.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione My Lists na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "AuthorId": 11.0, 
   "BaseName": "3_",
   "Attachments": false,
   "Title": "Created List New"
   }

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá uma semelhante a:

   [{
   "ID": 3.0
   }]

Exemplo: excluir um registro

Este exemplo exclui o registro com o ID especificado na entidade My Lists.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione My Lists na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e e insira 2 no campo Valor padrão.