SharePoint

O conector do SharePoint fornece acesso SQL aos serviços e servidores do SharePoint.

Versões compatíveis

Esse conector é compatível com o Windows SharePoint Services 3.0, o Microsoft Office SharePoint Server 2007 e superior e o SharePoint Online.

Antes de começar

Antes de usar o conector do SharePoint, realize as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o aplicativo do SharePoint no Azure (AD)

Se você optar por usar o Azure Active Directory (AD) para a edição on-line do SharePoint, siga estas etapas para configurar o aplicativo SharePoint no Azure AD:

  1. No portal do Azure AD, selecione o diretório da sua organização.
  2. Na seção Gerenciar, clique em Registros de aplicativo e em Novo registro.
  3. Registre o app no Azure AD preenchendo os detalhes do registro:
    1. Em Tipos de conta compatíveis, selecione Contas apenas neste diretório organizacional.
    2. Em URI de redirecionamento (opcional), selecione Web e adicione https://your_connections_host.spo.index.html como o URI para que os usuários das suas conexões recebam a resposta de autenticação.
    3. Clique em Registrar.

      4. Para mais informações, confira como registrar um aplicativo no Azure.

  4. Na página Visão geral do app, clique em Permissões da API e em Adicionar uma permissão.
  5. Configure seu aplicativo para acessar uma API da Web seguindo estas etapas:
    1. Em Solicitar permissões da API, selecione SharePoint na guia Microsoft APIs.
    2. Em Permissões delegadas, selecione Ler e gravar arquivos do usuário e Ler e gravar itens em todas as coleções do site.
    3. Clique em Adicionar permissões
    4. Na tela de permissões da API configurada, selecione Conceder consentimento de administrador para your_organizational_directory.
  6. Adicione um URI de redirecionamento ao app SharePoint para dispositivos móveis da sua organização:
    1. Clique em Autenticação.
    2. Na Web, clique em Adicionar URI e inclua https://your_connections_host/spo/mobile.html como o URL de resposta para usuários de dispositivos móveis.
    3. Em Concessão implícita, selecione Tokens de acesso e Tokens de ID.
    4. Clique em Salvar.
  7. Edite o manifesto do app Azure Active Directory para permitir a autenticação aberta usada pelo app:
    1. Na página Overview do app, clique na seção Manifest.
    2. Mude o atributo oauth2AllowImplicitFlow para true.
    3. Clique em Salvar.
  8. Na página Visão geral do app, anote o ID do aplicativo (cliente). Se você escolher o tipo de autenticação do Azure AD, será preciso fornecê-lo na seção de autenticação ao configurar o conector do SharePoint.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acesse a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Veja abaixo as regiões com suporte com o conector:

      Para acessar a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione SharePoint na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    7. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
    8. Clique em Próxima.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino. Por exemplo, o endereço do host é https://xxxxx.sharepoint.com.
      1. No campo Endereço do host, especifique o nome do host ou o endereço IP do destino.
        1. Se você quiser estabelecer uma conexão privada com seus sistemas de back-end, siga estas etapas:
          1. Crie um anexo do serviço PSC.
          2. Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
        2. Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir mais destinos, clique em +Adicionar destino.

    2. Clique em Próxima.
  6. Na seção Autenticação, insira os detalhes de autenticação.
    1. Selecione um dos tipos de autenticação a seguir e insira os detalhes correspondentes.
      • Credenciais do Windows: selecione essa opção se você estiver usando a edição local do SharePoint. Depois, faça o seguinte:
        1. Nome de usuário: digite o nome de usuário.
        2. Senha: selecione a senha.
        3. Versão do secret: insira a versão do secret.
      • AzureAD: selecione essa opção se você estiver usando a edição on-line do Sharepoint. Depois, faça o seguinte:
        1. ID do cliente: digite o ID do cliente usado para solicitar tokens de acesso. Para conseguir o ID do cliente, configure o aplicativo do SharePoint no Azure AD.
        2. Escopos: insira uma lista separada por vírgulas dos escopos desejados. Por exemplo, Sites.FullControl.All
        3. Chave secreta do cliente: digite a chave secreta do cliente referente ao app conectado que você criou.
        4. Versão do secret: versão do secret selecionado acima.
        5. URL de autorização: é o URL de autorização gerado ao criar o cliente. Insira o URL no seguinte formato: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Por exemplo, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize.
    2. Clique em Próxima.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Credenciais do Windows
    • Nome de usuário: digite o nome de usuário.
    • Password: selecione o secret do Secret Manager que contém a senha do usuário.
    • Versão do secret : selecione a versão do secret do Secret Manager.
  • AzureAD (OAuth 2.0 - código de autorização)
    • ID do cliente: ID do cliente conforme fornecido pelo aplicativo externo.
    • Escopos : insira escopos de permissão separados por vírgulas.
    • Chave secreta do cliente: selecione a chave Gerenciador de secrets. É necessário criar a chave secreta do Secret Manager antes de configurar esta autorização.
    • Versão do secret: a versão do secret do cliente no Secret Manager.

    Para o tipo de autenticação Authorization code, depois de criar a conexão, execute mais algumas etapas para configurar a autenticação. Para mais informações, consulte Etapas adicionais após a criação da conexão.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas etapas extras depois de criar a conexão:

  1. Na página Conexões, localize a conexão recém-criada.

    O Status do novo conector será Autorização necessária.

  2. Clique em Autorização necessária.

    O painel Editar autorização vai aparecer.

  3. Copie o valor do URI de redirecionamento no seu aplicativo externo.
  4. Verifique os detalhes da autorização.
  5. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Reautorização para o código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito mudanças na configuração no seu aplicativo Sharepoint, autorize novamente sua conexão do SharePoint. Para autorizar novamente uma conexão, siga estas etapas:

  1. Clique na conexão necessária na página Conexões.

    A página de detalhes da conexão será aberta.

  2. Clique em Edit para editar os detalhes da conexão.
  3. Verifique os detalhes de OAuth 2.0 - código de autorização na seção Autenticação.

    Se necessário, faça as alterações necessárias.

  4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
  5. Clique em Editar autorização na seção Autenticação. O painel Autorizar será exibido.
  6. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

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:

    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, essas operações 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. 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 suportadas pelo conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação DeleteAttachment

Esta ação exclui um anexo.

Parâmetros de entrada da ação DeleteAttachment

Nome do parâmetro Tipo de dados Obrigatório Descrição
ListTitle String Sim Título do item da lista.
ItemId String Sim ID do item da lista.
FileName String Sim Nome do arquivo a ser excluído da biblioteca de documentos.

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

Ação CheckInDocument

Essa ação permite fazer check-in em um documento.

Parâmetros de entrada da ação CheckInDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo para fazer check-in.
Comentar String No Uma mensagem de check-in opcional.

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

Ação ChekOutDocument

Essa ação permite fazer check-out de um arquivo.

Parâmetros de entrada da ação ChekOutDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo a ser verificado.

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

Ação DescartarCheckOutDocument

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

Parâmetros de entrada da ação DescartarCheckOutDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo cujo check-out deve ser desfeito.

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

Nome do parâmetro Tipo de dados Obrigatório Descrição
SourceFileRelativeUrl String Sim URL relativo do arquivo de origem.
DestFileRelativeUrl String Sim URL relativo do arquivo de destino.

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

Ação "UploadDocument"

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

Parâmetros de entrada da ação UploadDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileName String Sim Nome do arquivo a ser enviado.
RelativeUrl String Sim URL relativo da pasta.
Conteúdo String No Conteúdo a ser enviado como um arquivo.
ContentBytes String No Conteúdo em bytes (como uma string Base64) para fazer upload como um arquivo. Use-o para fazer upload de dados binários.
HasBytes Booleano No Especifica se o conteúdo a ser enviado é binário. O valor padrão é false.

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

Ação de fazer o download de documentos

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

Parâmetros de entrada da ação DownloadDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RemoteFile String Sim URL completo do arquivo para download.
Biblioteca String Sim Nome da biblioteca no servidor do SharePoint.
HasBytes Booleano No Especifica se o download do conteúdo será feito em bytes. O valor padrão é false.

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

Ação MoveAttachmentOrDocument

Isso permite mover um arquivo de uma pasta para outra.

Parâmetros de entrada da ação MoveAttachmentOrDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
SourceFileURL String Sim URL do arquivo de origem que deve ser movido.
DestinationFolderURL String Sim URL da pasta de destino.

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

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
FolderName String Sim Nome da pasta a ser criada.

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

Ação AddAttachments

Esta ação permite adicionar um anexo.

Parâmetros de entrada da ação AddAttachments

Nome do parâmetro Tipo de dados Obrigatório Descrição
ListTitle String Sim Nome da lista de anexos.
FileName String Sim Nome do arquivo de anexo.
ItemId String Sim ID do anexo a ser adicionado.
Conteúdo String Sim Conteúdo do anexo.
ContentBytes String No Conteúdo em bytes (como uma string Base64) para fazer upload como um anexo. Use-o para fazer upload de dados binários.
HasBytes Booleano No Especifica se o conteúdo a ser enviado é binário. O valor padrão é false.

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"

Nome do parâmetro Tipo de dados Obrigatório Descrição
RemoteFile String Sim URL relativo do arquivo.
HasBytes Booleano No Especifica se o conteúdo a ser transferido por download é binário. O valor padrão é false.

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

Exemplos de ação

Nesta seção, descrevemos como executar algumas das ações nesse 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

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

    [{
"Status": "Success"
}]

Exemplo: fazer check-in em um documento

Este exemplo faz a verificação 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 Task Input 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"
}

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

    [{
"Status": "Success"
}]

Exemplo: verificar um arquivo

Este exemplo verifica um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ChekOutDocument e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

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

    [{
"Status": "Success"
}]

Exemplo: descartar um check-out

Este exemplo reverte o check-out de um 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

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

    [{
"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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

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

    [{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo de texto

Este exemplo faz 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 Task Input 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"
}

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

    [{
"Status": "Success"
}]

Exemplo: upload de um arquivo binário

Este exemplo faz upload de um arquivo binário para o local especificado. Ao fazer upload de um arquivo binário, especifique o conteúdo que 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 Task Input 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"
}

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

    [{
"Status": "Success"
}]

Exemplo: fazer o download de um arquivo

Neste exemplo, fazemos 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

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

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

Exemplo: fazer o download de um arquivo binário

Neste exemplo, é feito 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

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

    [{
"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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

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

    [{
"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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

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

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

Exemplo: adicionar um anexo

Neste exemplo, um anexo é adicionado à 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. 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/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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachments 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

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

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

Exemplos de operação de entidade

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

Exemplo: listar todos os arquivos

Neste exemplo, listamos todos os arquivos na entidade Files.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista de Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Opcionalmente, na seção Entrada da tarefa da tarefa Conectores, você pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Também é possível 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 de 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 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 de Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no 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á um valor semelhante a este:

    [{
"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 de Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 2 no campo Valor padrão.

Usar a conexão do SharePoint em uma integração

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

  • Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte Tarefa Conectores.
  • Para entender como criar e usar a tarefa de conectores na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir