Dropbox

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 for compatível com nenhuma das operações de 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. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. 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 as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação CopyResource

Com essa ação, você pode copiar um arquivo ou uma pasta para outro local no Dropbox do usuário.

Parâmetros de entrada da ação CopyResource

Para ver um exemplo de como configurar a ação CopyResource, consulte Exemplos de ações.

Ação CreateFolder

Essa ação permite criar uma pasta em um determinado caminho.

Parâmetros de entrada da ação CreateFolder

Para ver um exemplo de como configurar a ação CreateFolder, consulte Exemplos de ações.

Ação DeleteResource

Essa ação permite excluir o arquivo ou a pasta em um determinado caminho. Se o caminho for uma pasta, todo o conteúdo dela também será excluído.

Parâmetros de entrada da ação DeleteResource

Para ver um exemplo de como configurar a ação DeleteResource, consulte Exemplos de ações.

Ação MoveResource

Mover um arquivo ou pasta para outro local no Dropbox do usuário. Se o caminho de origem for uma pasta, todo o conteúdo dela será movido. No momento, não oferecemos suporte à mudança de caixa.

Parâmetros de entrada da ação MoveResource

Para ver um exemplo de como configurar a ação MoveResource, consulte Exemplos de ações.

Ação RenameResource

Essa ação permite renomear um recurso fornecendo um caminho e um novo nome.

Parâmetros de entrada da ação RenameResource

Para ver um exemplo de como configurar a ação RenameResource, consulte Exemplos de ações.

Ação "UnshareFolder"

Essa ação permite remover o compartilhamento de uma pasta. Requer o escopo "sharing.write".

Parâmetros de entrada da ação UnshareFolder

Para ver um exemplo de como configurar a ação UnshareFolder, consulte Exemplos de ações.

Ação DownloadFile

Essa ação permite baixar um arquivo. Requer o escopo "files.content.read".

Parâmetros de entrada da ação DownloadFile

Para ver um exemplo de como configurar a ação DownloadFile, consulte Exemplos de ações.

Exemplos de ações

Nesta seção, descrevemos como executar algumas das ações neste conector.

Exemplo: copiar um recurso

O exemplo a seguir mostra como copiar um recurso com um caminho especificado para outro caminho:

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

   {
     "From_Path": "/DropboxFolder/pptxFile.pptx",
     "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx"
   }

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

[ { "Success": "true", "metadata_.tag": "file", 
  "metadata_name": "pptxFile.pptx", 
  "metadata_path_lower": "/testingdropboxupdated/abcde/pptxfile.pptx", 
  "metadata_path_display": "/TestingDropBoxUpdated/abcde/pptxFile.pptx", 
  "metadata_parent_shared_folder_id": "3204685267", "metadata_id": "id:8-07A6kHAoIAAAAAAAAC1w",
  "metadata_client_modified": "2024-06-13T11:06:37Z", "metadata_server_modified": "2024-07-12T10:19:02Z",
  "metadata_rev": "61d0a3560ecb5bf039dd3", "metadata_size": "17052", 
  "metadata_sharing_info_read_only": "false", "metadata_sharing_info_parent_shared_folder_id": "3204685267",
  "metadata_sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A", 
  "metadata_is_downloadable": "true", 
  "metadata_content_hash": "0234f7d4eaf914cb276716c8b2a24e24655d1f6f39ee549207e33a4255e2fba2" } ]

Exemplo: criar uma pasta

O exemplo a seguir mostra como criar uma pasta em um determinado caminho:

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:

   {
     "Path": "/TestDrobBoxFolder/newFolder"
   }

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

[ { "Id": "id:8-07A6kHAoIAAAAAAAAC2Q" } ]

Exemplo: excluir um recurso

O exemplo a seguir mostra como excluir um recurso:

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

   {
     "Path": "/TestingDropBox/FolderToBeDeletedName"
   }

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

[{
"Status": "Success"
}]

Exemplo: mover um recurso

O exemplo a seguir mostra como mover um recurso:

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

   {
     "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
     "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
   }

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

[{
  "Status": "Success"
  }]

Exemplo: renomear um recurso

O exemplo a seguir mostra como renomear um recurso:

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

   {
     "Path": "/TestDropBox/abcd",
     "NewName": "abcded"
   }

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

[{
"Status": "Success"
}]

Exemplo: cancelar o compartilhamento de uma pasta

O exemplo a seguir mostra como cancelar o compartilhamento de uma pasta:

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

   {
     "FolderId": "3336772979"
   }

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

[{
"Status": "Success"
}]

Exemplo: fazer o download de um arquivo

O exemplo a seguir mostra como baixar 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:

   {
     "Id": "id:8-07A6kHAoIAAAAAAAABcg",
     "FileType": "file"
   }

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

[ { "Success": "true", "Name": "license.txt", 
  "Id": "id:8-07A6kHAoIAAAAAAAABcg", "ClientModified": "2024-07-09T09:52:41Z", 
  "ServerModified": "2024-07-09T09:52:41Z", "Revision": "61ccd7da2b987c0f52053", "Size": "11", 
  "LowerCasePath": "/sahil kapoor/testingdropboxupdated/uploadfolderwithnestedfolder/nestedfolder2/license.txt",
   "DisplayPath": "/Sahil Kapoor/TestingDropBoxUpdated/uploadFolderWithNestedFolder/NestedFolder2/license.txt",
    "PreviewURL": null, "IsDownloadable": "true", "HasExplicitSharedMembers": null, 
  "ContentHash": "f6dc724d119649460e47ce719139e521e082be8a9755c5bece181de046ee65fe", "Owner": null,
  "Title": null, "MimeType": null, "FileData": "SGVsbG8gd29ybGQ=", "parent_shared_folder_id": "3237290067",
  "sharing_info_read_only": "false", "sharing_info_parent_shared_folder_id": "3237290067", 
  "sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A" } ]