IMPORTANTE: esta documentação foi descontinuada. Leia a documentação OneDrive atualizada no nosso novo portal de documentação.
O OneDrive permite estabelecer uma conexão com o serviço OneDrive da Microsoft e habilita as seguintes operações: list, list search, pagination, download, download by file ID, upload e delete.
Dê uma olhada nos parâmetros de configuração do componente:
Account: para o componente fazer a autenticação ao serviço do OneDrive é necessário usar uma account do tipo Oath 2 de provedor Microsoft com ao menos o escopo de "offline_access" e "Files.ReadWrite.All".
Operation: list, list search, pagination, download, download by file ID, upload e delete.
Remote Directory: diretório remoto base, que pode ser relativo (ex.: pub/tmp) ou absoluto (ex.: /root/pub). Este parâmetro aceita Double Braces.
Page Size: utilizado na operação list e list search, se refere à quantidade de objetos retornados na busca.
Query: presente na operação list search. Esse parâmetro define o tipo de busca que será feito nos diretórios do OneDrive. Para saber mais sobre esse filtro, clique aqui.
Next Page: presente na operação pagination.
IMPORTANTE: se um componente OneDrive que estiver executando a operação list ou list search gerar mais resultados do que o Page Size, então um segundo componente OneDrive ligado pode usar a operação pagination e o parâmetro Next Page. Isso pode ocorrer manualmente ou por meio de Double Braces. Exemplo: com {{ message. nextPage }}), mais resultados da operação anterior são carregados.
File Name: nome do arquivo ou caminho completo (full file path) para o arquivo. Este parâmetro aceita Double Braces.
Remote File Name: nome do arquivo remoto ou caminho relativo (ex.: tmp/file.txt) para o arquivo remoto. Este parâmetro aceita Double Braces.
File ID: identificador único de um arquivo.
Fail On Error: se a opção estiver habilitada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".
IMPORTANTE: note que alguns dos parâmetros acima suportam Double Braces. Para entender como essa linguagem funciona, leia o nosso artigo clicando aqui.
Fluxo de mensagens
Saída
Ao executar um componente OneDrive utilizando as operações list e list search, a seguinte estrutura de JSON será gerada:
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('user%40hotmail.com')/drive/root/children",
"count": 5,
"nextPage": "https://microsoft.graph/nextPage?token=Md",
"value": [
{
"createdDateTime": "2010-10-07T23:25:28.99Z",
"cTag": "adDpEOUMxOTZEMzdEMkQxNT42MzcyODc4NjU2Nzg0MDAwMUHDA",
"eTag": "aRDlfdseMTk2RDRfdfDJEMTU5RSExEuMA",
"id": "DXCC196D37D2D159E!161",
"lastModifiedDateTime": "2020-06-26T16:42:47.84Z",
"name": "Documentos",
"size": 49378390,
"webUrl": "https://1drv.ms/f/s!AGG4VLX3T6sHZgSE",
"reactions": {
"commentCount": 0
},
"createdBy": {
"user": {
"displayName": "NAME",
"id": "d9c196d37d2d159e"
}
},
"lastModifiedBy": {
"user": {
"displayName": "NAME",
"id": "d9de396d37d2d159e"
}
},
"parentReference": {
"driveId": "d9c196d37d2d159e",
"driveType": "personal",
"id": "XCC196D37D2D159E!160",
"path": "/drive/root:a_folder"
},
"fileSystemInfo": {
"createdDateTime": "2010-10-07T23:25:28.99Z",
"lastModifiedDateTime": "2010-10-07T23:25:28.99Z"
},
"folder": {
"childCount": 6,
"view": {
"viewType": "thumbnails",
"sortBy": "name",
"sortOrder": "ascending"
}
},
"specialFolder": {
"name": "documents"
}
}
]
}
value[name]: nome da pasta ou arquivo
value[size]: tamanho em bytes
nextPage: url para carregar mais resultados (ver operação “pagination”)
Operação download:
{
"remoteDirectory": "REMOTE_DIRECTORY",
"remoteFileName": "remoteFileName"
"fileName": "file.ext",
"success": true
}
remoteDirectory: caminho do diretório remoto base (relativo ou absoluto)
remoteFileName: caminho do arquivo remoto ou caminho relativo do arquivo remoto
fileName: nome do arquivo local
success: "true" se a operação sucedeu, "false" caso contrário
Operação download by file Id:
{
"fileId": "FILE_ID"
"fileName": "file.ext",
"success": true
}
fileId: identificador único do arquivo
fileName: nome do arquivo local
success: "true" se a operação sucedeu, "false" caso contrário
Operação upload:
{
"remoteFileName": "remote_file.ext",
"remoteDirectory": "Documents"
"fileName": "file.ext",
"success": true
}
remoteFileName: caminho do arquivo remoto ou caminho relativo do arquivo remoto
remoteDirectory: caminho do diretório remoto base (relativo ou absoluto)
fileName: nome do arquivo local
success: "true" se a operação sucedeu, "false" caso contrário
Operação delete:
{
"fileId": "FILE_ID"
"success": true
}
fileId: identificador único do arquivo
success: "true" se a operação sucedeu, "false" caso contrário
IMPORTANTE: a manipulação de arquivos dentro de um pipeline ocorre de forma protegida. Os arquivos ficam disponíveis em diretório temporário que somente o pipeline sendo executado tem acesso.
Para entender melhor o fluxo das mensagens na Plataforma, clique aqui e leia o nosso artigo.