Para interagir com uma unidade Box®, adicione uma etapa em uma cadeia que use um comando de conexão Box. Por exemplo:
- Carregar, fazer download, mover, pesquisar ou excluir arquivos
- Criar e excluir pastas
- Buscar URLs de arquivos e pastas
Para habilitar esses comandos, primeiro um administrador de TI cria um conector Box.
Copiar arquivo
Para copiar um arquivo na Box, use o comando Copy file.
Chamada de API equivalente: https://developer.box.com/reference/post-file-requests-id-copy/
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo a ser copiado. |
| Nome do arquivo |
Digite o nome do arquivo a ser copiado. Opcional se você digitar ID do arquivo. |
| Nome da pasta principal |
Digite o nome da pasta que contém o arquivo a ser copiado. Opcional se você digitar ID do arquivo. |
| ID da pasta de destino |
Digite o ID da pasta de destino para a qual você copiará o arquivo (opcional). Para a raiz, digite 0. |
| Nome da pasta de destino |
Digite o nome da pasta para a qual você deseja copiar. Opcional se você digitar ID da pasta de destino. |
| Nome |
Para renomear a cópia do arquivo, digite seu nome (opcional). |
Saídas
| Saída |
Tipo de saída |
| Arquivo |
JSON |
| ID do arquivo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Copiar pasta
Para copiar uma pasta na Box, use o comando Copy folder.
Chamada de API equivalente: https://developer.box.com/guides/folders/single/copy/
Propriedades
| Propriedade |
Detalhes |
| ID da pasta |
Digite o ID da pasta a ser copiada. |
| Nome da pasta |
Digite o nome da pasta a ser copiada. Opcional se você digitar ID da pasta. |
| ID da pasta de destino |
Digite o ID da pasta na qual você deseja salvar a cópia. |
| Nome da pasta de destino |
Digite o nome da pasta na qual você deseja salvar a cópia. Opcional se você digitar ID da pasta de destino. |
| Novo nome da pasta |
Para renomear a cópia do arquivo, digite seu nome (opcional). |
Saídas
| Saída |
Tipo de saída |
| Pasta |
JSON |
| ID da pasta |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Criar pasta
Para criar uma pasta no Box, use o comando Create folder.
Chamada de API equivalente: https://developer.box.com/guides/folders/single/create/
Propriedades
| Propriedade |
Detalhes |
| Nome da pasta |
Digite o nome da nova pasta. |
| ID da pasta de destino |
Digite o ID da pasta de destino. Para a raiz, digite 0. |
| Nome da pasta de destino |
Digite o nome da pasta de destino (opcional). |
Saídas
| Saída |
Tipo de saída |
| Pasta |
JSON |
| ID da pasta |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Excluir arquivo
Para excluir um arquivo na Box, use o comando Delete file.
Chamada de API equivalente: https://developer.box.com/guides/file-requests/delete/
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo a ser excluído. |
| Nome do arquivo |
Digite o nome do arquivo a ser excluído. Opcional se você digitar ID do arquivo. |
| Nome da pasta principal |
Digite o nome da pasta que contém o arquivo a ser excluído. Opcional se você digitar ID do arquivo. |
Saídas
| Saída |
Tipo de saída |
| ID do arquivo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Excluir pasta
Para excluir uma pasta no Box, use o comando Delete folder.
Chamada de API equivalente: https://developer.box.com/guides/folders/single/delete/
Entradas
Propriedades
| Propriedade |
Detalhes |
| ID da pasta |
Digite o ID da pasta a ser excluída |
| Nome da pasta |
Digite o nome da pasta a ser excluída. Opcional se você digitar ID da pasta. |
| Nome da pasta pai |
Digite o nome da pasta que contém a pasta a ser excluída. Opcional se você digitar ID da pasta. |
| Recursive* |
Para excluir pastas recursivamente se elas contiverem itens, marque essa caixa. |
Saídas
| Saída |
Tipo de saída |
| ID da pasta |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Baixar arquivo
Para fazer download de um arquivo do Box, use o comando Download file.
Chamada de API equivalente: https://developer.box.com/guides/downloads/file/
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo a ser baixado. |
| Nome do arquivo |
Digite o nome do arquivo a ser baixado. Opcional se você digitar ID do arquivo. |
| Nome da pasta principal |
Digite o nome da pasta que contém o arquivo a ser baixado. Opcional se você digitar ID do arquivo. |
Saídas
| Saída |
Tipo de saída |
| Linhas |
Inteiro |
| Arquivo |
Arquivo |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Obter informações do arquivo
Para recuperar metadados sobre um arquivo na Box, use o comando Get file info.
Chamada de API equivalente: https://developer.box.com/reference/get-files-id/
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo para o qual você deseja procurar metadados. |
| Nome do arquivo |
Digite o nome do arquivo para o qual você deseja procurar metadados. Opcional se você digitar ID do arquivo. |
| Nome da pasta principal |
Digite o nome da pasta que contém o arquivo para o qual você deve procurar metadados. Opcional se você digitar ID do arquivo. |
Saídas
| Saída |
Tipo de saída |
| Informações do arquivo |
JSON |
| ID do arquivo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Obter informações da pasta
Para recuperar metadados sobre uma pasta no Box, use o comando Get folder info.
Chamada de API equivalente: https://developer.box.com/reference/get-folders-id/
Propriedades
| Propriedade |
Detalhes |
| ID da pasta |
Digite o ID da pasta para a qual você deseja obter metadados. |
| Nome da pasta |
Digite o nome da pasta para a qual você deseja obter metadados. Opcional se você digitar ID da pasta. |
Saídas
| Saída |
Tipo de saída |
| Informações da pasta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Obter itens da pasta
Para recuperar todos os itens de uma pasta no Box, use o comando Get folder items.
Chamada de API equivalente: https://developer.box.com/reference/get-folders-id-items/
Propriedades
| Propriedade |
Detalhes |
| ID da pasta |
Digite o ID da pasta da qual você deseja recuperar os itens. |
| Nome da pasta |
Digite o nome da pasta da qual você deseja recuperar os itens. Opcional se você digitar ID da pasta. |
| Nome da pasta pai |
Digite o nome da pasta que contém a pasta da qual você deseja recuperar itens. Opcional se você digitar ID da pasta. |
| Direção |
Selecione a ordem de classificação para os itens da pasta. |
| Limite |
Digite o limite de entradas retornadas. |
Saídas
| Saída |
Tipo de saída |
| Total |
Inteiro |
| Entradas |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Pesquisar
Para pesquisar um objeto na Box, use o comando Search.
Chamada de API equivalente: https://developer.box.com/guides/search/
Propriedades
| Propriedade |
Detalhes |
| Consulta |
Digite a consulta de pesquisa. |
| Extensões de arquivo |
Digite as extensões de arquivo para limitar os resultados da pesquisa. |
| Tipo |
Selecione o tipo de objetos a serem procurados. Para todos os tipos, deixe em branco. |
| Limite |
Digite o número de resultados a serem retornados. |
Saídas
| Saída |
Tipo de saída |
| Entradas |
JSON |
| Total |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Atualizar informações do arquivo
Para atualizar o nome, a descrição ou a pasta principal de um arquivo no Box, use o comando Update file info.
Chamada de API equivalente: https://developer.box.com/guides/file-requests/update/
Propriedades
| Propriedade |
Detalhes |
| ID do arquivo |
Digite o ID do arquivo a ser atualizado. |
| Nome do arquivo |
Digite o nome do arquivo a ser atualizado. Opcional se você digitar ID do arquivo. |
| Nome da pasta principal |
Digite o nome da pasta que contém o arquivo a ser atualizado. Opcional se você digitar ID do arquivo. |
| Nome |
Digite o novo nome do arquivo. |
| Descrição |
Digite a descrição do arquivo. |
| ID da pasta de destino |
Digite o ID da pasta para a qual você deseja mover o arquivo (opcional). |
| Nome da pasta de destino |
Digite o nome da pasta para a qual você deseja mover o arquivo. Opcional se você digitar ID da pasta de destino. |
Saídas
| Saída |
Tipo de saída |
| Arquivo |
JSON |
| ID do arquivo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Atualizar pasta
Para atualizar o nome, a descrição ou a pasta principal de uma pasta no Box, use o comando Update folder.
Chamada de API equivalente: https://developer.box.com/reference/put-folders-id/
Propriedades
| Propriedade |
Detalhes |
| ID da pasta |
Digite o ID da pasta a ser atualizada. |
| Nome da pasta |
Digite o nome da pasta a ser atualizada. Opcional se você digitar ID da pasta. |
| ID da pasta de destino |
Digite o ID da pasta para a qual você deseja mover a pasta (opcional). Para a raiz, digite 0. |
| Nome da pasta de destino |
Digite o nome da pasta para a qual você deseja mover a pasta. Opcional se você digitar ID da pasta de destino. |
| Nome |
Digite o novo nome da pasta. |
| Descrição |
Digite a descrição da pasta. |
Saídas
| Saída |
Tipo de saída |
| Pasta |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Carregar arquivo
Para fazer upload de um arquivo para o Box, use o comando Upload file.
Chamada de API equivalente: https://developer.box.com/guides/file-requests/update/
Propriedades
| Propriedade |
Detalhes |
| Arquivo |
Digite o arquivo a ser carregado. |
| ID da pasta de destino |
Digite o ID da pasta de destino para armazenar o arquivo. |
| Nome da pasta de destino |
Digite o nome da pasta de destino para armazenar o arquivo. Opcional se você digitar ID da pasta de destino. |
| Nome |
Digite o novo nome do arquivo. |
Saídas
| Saída |
Tipo de saída |
| Arquivo |
JSON |
| ID do arquivo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Carregar versão do arquivo
Para fazer upload de uma nova versão de um arquivo para o Box, use o comando Upload file version.
Chamada de API equivalente: https://developer.box.com/guides/uploads/direct/file-version/
Propriedades
| Propriedade |
Detalhes |
| Arquivo |
Digite o arquivo para carregar uma nova versão. |
| ID do arquivo |
Digite o ID do arquivo para criar uma nova versão. |
| Nome |
Digite o nome do arquivo do qual você deseja fazer upload de uma nova versão. Opcional se você digitar ID do arquivo. |
| Nome da pasta principal |
Digite o nome da pasta que contém o arquivo do qual você deseja fazer upload de uma nova versão. Opcional se você digitar ID do arquivo. |
Saídas
| Saída |
Tipo de saída |
| Linhas |
Inteiro |
| Arquivo |
JSON |
| ID do arquivo |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |