topic Vault API - How to rename a file in Vault Customization Forum

Vault API - How to rename a file

Anonymous — Wed, 15 Jul 2015 12:41:20 GMT

I am trying to rename a file accordance to a pattern, but it seems I have trouble doing it - do I need to checkout and checkin file after the change? If yes can you provide a code sample (C#) how to checkout file, rename it, checkin using Vault API? Thank you.

Re: Vault API - How to rename a file

minkd — Wed, 15 Jul 2015 14:49:28 GMT

The CheckInUploadedFile method has a newFilename parameter.

You rename a file by checking it out and checking it in with a new name.

-Dave

Re: Vault API - How to rename a file

Anonymous — Wed, 15 Jul 2015 17:20:38 GMT

Thanks. When I use conn.WebServiceManager.DocumentService.CheckoutFile there is no checked out file at the location I specified (C:\tmp"). What I am doing wrong?

Re: Vault API - How to rename a file

Anonymous — Wed, 15 Jul 2015 20:11:39 GMT

CheckinUploadedFile asks me for uploaded file, but I don't know how to do it. If you can provide a code example for checkout, checkin it would be great.

Re: Vault API - How to rename a file

minkd — Wed, 15 Jul 2015 21:14:46 GMT

Please see this blog post: http://justonesandzeros.typepad.com/blog/2013/05/how-to-acquire-files.html

-Dave

Re: Vault API - How to rename a file

darius.simkunas — Thu, 16 Jul 2015 11:38:58 GMT

Hi,

File checkedOutNewFile = CheckOut(folders[0], selectedFile);

if (checkedOutNewFile != null)

{

CheckIn(folders[0], checkedOutNewFile, newname, Coment);

}

public File CheckOut(Folder folder, File file)

{

string localPath = _connection.WorkingFoldersManager.GetWorkingFolder(folder.FullName).FullPath;

if (!System.IO.Directory.Exists(localPath))

System.IO.Directory.CreateDirectory(localPath);

AcquireFilesSettings settings = new VDF.Vault.Settings.AcquireFilesSettings(_connection);

settings.OptionsRelationshipGathering.FileRelationshipSettings.VersionGatheringOption = Autodesk.DataManagement.Client.Framework.Vault.Currency.VersionGatheringOption.Latest;

settings.OptionsResolution.OverwriteOption = AcquireFilesSettings.AcquireFileResolutionOptions.OverwriteOptions.ForceOverwriteAll;

settings.LocalPath = new VDF.Currency.FolderPathAbsolute(localPath);

settings.AddFileToAcquire(

new VDF.Vault.Currency.Entities.FileIteration(_connection, file),

VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Download | VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Checkout);

VDF.Vault.Results.AcquireFilesResults result = _connection.FileManager.AcquireFiles(settings);

foreach (var r in result.FileResults)

{

return m_serviceManager.DocumentService.GetFileById(r.File.EntityIterationId);

}

public File CheckIn(Folder folder, File file, string newname,string comm)

{

string localPath = _connection.WorkingFoldersManager.GetWorkingFolder(folder.FullName).FullPath;

string filePath = System.IO.Path.Combine(localPath, file.Name);

VDF.Vault.Currency.Entities.FileIteration ff = _connection.FileManager.CheckinFile(

new VDF.Vault.Currency.Entities.FileIteration(_connection, file), comm, false, null, null,

true, newname, file.FileClass, false,

new VDF.Currency.FilePathAbsolute(filePath));

return m_serviceManager.DocumentService.GetFileById(ff.EntityIterationId);

}

Re: Vault API - How to rename a file

Anonymous — Thu, 16 Jul 2015 11:58:44 GMT

Thank you, Dave.

Re: Vault API - How to rename a file

Anonymous — Thu, 16 Jul 2015 11:59:07 GMT

Thank you!

Re: Vault API - How to rename a file

Anonymous — Wed, 22 Jul 2015 15:20:53 GMT

I have renamed file successfully as per your code. But, now, the links are broken. What I have missed. How I can keep links while renaming the file?

Re: Vault API - How to rename a file

darius.simkunas — Wed, 30 Mar 2016 05:45:05 GMT

VDF.Vault.Results.AcquireFilesResults result = null;

File checkedOutNewFile = CheckOut(folders[0], selectedFile, ref result);

        if (checkedOutNewFile != null)
             {
               CheckIn(folders[0], checkedOutNewFile, newname, Coment, result);
              }

public File CheckOut(Folder folder, File file, ref VDF.Vault.Results.AcquireFilesResults result)
       {
           if (folder == null)
               folder = _connection.WebServiceManager.DocumentService.GetFolderById(file.FolderId);
           string localPath = _connection.WorkingFoldersManager.GetWorkingFolder(folder.FullName).FullPath;
           if (!System.IO.Directory.Exists(localPath))
               System.IO.Directory.CreateDirectory(localPath);

           AcquireFilesSettings settings = new VDF.Vault.Settings.AcquireFilesSettings(_connection);
           settings.OptionsRelationshipGathering.FileRelationshipSettings.VersionGatheringOption = Autodesk.DataManagement.Client.Framework.Vault.Currency.VersionGatheringOption.Latest;
           settings.LocalPath = new VDF.Currency.FolderPathAbsolute(localPath);

           settings.AddFileToAcquire(
               new VDF.Vault.Currency.Entities.FileIteration(_connection, file),
               VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Download | VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Checkout);
           result = _connection.FileManager.AcquireFiles(settings);

           foreach (var r in result.FileResults)
           {

                   return m_serviceManager.DocumentService.GetFileById(r.File.EntityIterationId);

           }
           return null;
       }
       public File CheckIn(Folder folder, File file, string newname, string comm, VDF.Vault.Results.AcquireFilesResults result)
       {

if (folder == null)
folder = _connection.WebServiceManager.DocumentService.GetFolderById(file.FolderId);

string localPath = _connection.WorkingFoldersManager.GetWorkingFolder(folder.FullName).FullPath;
string filePath = System.IO.Path.Combine(localPath, file.Name);

           FileAssocParam[] assparamsarr = null;
           if (result != null)
           {
               FileRelationshipGatheringSettings settings = new FileRelationshipGatheringSettings();
               settings.IncludeChildren = true;
               var fassoc = _connection.FileManager.GetFileAssociationLites(new long[] { result.FileResults.First().NewFileIteration.EntityIterationId }, settings);

               List<FileAssocParam> assparams = new List<FileAssocParam>();
               foreach (var **** in fassoc)
               {
                   FileAssocParam param = new FileAssocParam();
                   param.CldFileId = ****.CldFileId;
                   param.RefId = ****.RefId;
                   param.Source = ****.Source;
                   param.Typ = ****.Typ;
                   param.ExpectedVaultPath = ****.ExpectedVaultPath;
                   assparams.Add(param);
               }
               assparamsarr = assparams.ToArray();
           }
           VDF.Vault.Currency.Entities.FileIteration ff = _connection.FileManager.CheckinFile(
              new VDF.Vault.Currency.Entities.FileIteration(_connection, file),
              comm,
              false,
              assparamsarr,
              null,
              true,
              newname,
              file.FileClass,
              false,
              new VDF.Currency.FilePathAbsolute(filePath));

               return m_serviceManager.DocumentService.GetFileById(ff.EntityIterationId);

       }