Лёгкое программирование под Autodesk Vault. Часть 22
Vault API предоставляет множество методов для работы с файлами. Поскольку большинство информации расположено в файлах, это довольно большая область API.
Так, вы можете увидеть количество методов по службам, которые содержат слово "file" в имени.
|
Служба |
Количество методов |
|
DocumentService |
96 |
|
ItemService |
11 |
|
DocumentServiceExtensions |
9 |
|
PackageService |
7 |
|
FilestoreService |
4 |
|
ChangeOrderService |
1 |
Количество методов по службам, в процентах:
Количество методов для работы с файлами, по операциям:
|
Операция |
Количество методов |
|
Get |
62 |
|
Find |
15 |
|
Set |
11 |
|
Delete |
9 |
|
Update |
9 |
|
Add |
4 |
|
Download |
3 |
|
Upload |
3 |
|
Create |
2 |
|
Generate |
2 |
|
Checkin |
1 |
|
Checkout |
1 |
|
Move |
1 |
|
Promote |
1 |
|
Reserve |
1 |
|
Rollback |
1 |
|
Undo |
1 |
|
Validate |
1 |
В процентах:
Ниже представлена сводная таблица со всеми методами для работы с файлами.
|
Operation |
Object |
Option |
Service |
Name |
|
Add |
DesignVisualizationFileAttachment |
DocumentService |
AddDesignVisualizationFileAttachment |
|
|
FileNamingScheme |
DocumentService |
AddFileNamingScheme |
||
|
UploadedFile |
DocumentService |
AddUploadedFile |
||
|
UploadedFileWithBehaviors |
DocumentService Extensions |
AddUploadedFileWithBehaviors |
||
|
Checkin |
UploadedFile |
DocumentService |
CheckinUploadedFile |
|
|
Checkout |
File |
DocumentService |
CheckoutFile |
|
|
Create |
ItemsAndBOM |
FromFile |
PackageService |
CreateItemsAndBOMFromFile |
|
FromUploadedFile |
PackageService |
CreateItemsAndBOMFromUploadedFile |
||
|
Delete |
File |
FromFolder |
DocumentService |
DeleteFileFromFolder |
|
FromFolderUnconditional |
DocumentService |
DeleteFileFromFolderUnconditional |
||
|
Files |
FromFolder |
DocumentService |
DeleteFilesFromFolder |
|
|
FromFolderUnconditional |
DocumentService |
DeleteFilesFromFolderUnconditional |
||
|
FileNamingScheme |
DocumentService |
DeleteFileNamingScheme |
||
|
FileVersions |
DocumentService |
DeleteFileVersions |
||
|
ByMasterIds |
DocumentService |
DeleteFileVersionsByMasterIds |
||
|
ByMasterIdsUnconditional |
DocumentService |
DeleteFileVersionsByMasterIdsUnconditional |
||
|
FileVersionsUnconditional |
DocumentService |
DeleteFileVersionsUnconditional |
||
|
Download |
File |
PackageService |
DownloadFile |
|
|
FilePart |
FilestoreService |
DownloadFilePart |
||
|
PackageService |
DownloadFilePart |
|||
|
Find |
Files |
ByDatesAndChecksums |
DocumentService |
FindFilesByDatesAndChecksums |
|
ByDatesPathsAndChecksums |
DocumentService |
FindFilesByDatesPathsAndChecksums |
||
|
ByFoldersDatesNamesAndChecksums |
DocumentService |
FindFilesByFoldersDatesNamesAndChecksums |
||
|
ByFoldersNamesAndChecksums |
DocumentService |
FindFilesByFoldersNamesAndChecksums |
||
|
ByPathsAndChecksums |
DocumentService |
FindFilesByPathsAndChecksums |
||
|
BySearchConditions |
DocumentService |
FindFilesBySearchConditions |
||
|
FileFolders |
BySearchConditions |
DocumentService |
FindFileFoldersBySearchConditions |
|
|
FilePaths |
ByDateAndChecksum |
DocumentService |
FindFilePathsByDateAndChecksum |
|
|
ByDateNameAndChecksum |
DocumentService |
FindFilePathsByDateNameAndChecksum |
||
|
ByNameAndChecksum |
DocumentService |
FindFilePathsByNameAndChecksum |
||
|
InFileSet |
BySearchConditions |
DocumentService |
FindInFileSetBySearchConditions |
|
|
LatestFiles |
ByMasterIds |
DocumentService |
FindLatestFilesByMasterIds |
|
|
ByPaths |
DocumentService |
FindLatestFilesByPaths |
||
|
FileElementFacetSets |
BySearchClause |
DocumentService Extensions |
FindFileElementFacetSetsBySearchClause |
|
|
FileElements |
BySearchClause |
DocumentService Extensions |
FindFileElementsBySearchClause |
|
|
Generate |
FileNumber |
DocumentService |
GenerateFileNumber |
|
|
FileNumbers |
DocumentService |
GenerateFileNumbers |
||
|
Get |
File |
ById |
DocumentService |
GetFileById |
|
ByVersion |
DocumentService |
GetFileByVersion |
||
|
Files |
ByHistoryType |
DocumentService |
GetFilesByHistoryType |
|
|
ByIds |
DocumentService |
GetFilesByIds |
||
|
ByMasterId |
DocumentService |
GetFilesByMasterId |
||
|
ByMasterIds |
DocumentService |
GetFilesByMasterIds |
||
|
ByVersions |
DocumentService |
GetFilesByVersions |
||
|
Folders |
ByFileMasterId |
DocumentService |
GetFoldersByFileMasterId |
|
|
ByFileMasterIds |
DocumentService |
GetFoldersByFileMasterIds |
||
|
Items |
ByAttachmentFileId |
ItemService |
GetItemsByAttachmentFileId |
|
|
ByFileId |
ItemService |
GetItemsByFileId |
||
|
ByFileIdAndLinkTypeOptions |
ItemService |
GetItemsByFileIdAndLinkTypeOptions |
||
|
Watermark |
ByItemIdAndFileId |
ItemService |
GetWatermarkByItemIdAndFileId |
|
|
ChangeOrderFiles |
ByFileMasterId |
ChangeOrderService |
GetChangeOrderFilesByFileMasterId |
|
|
FileFolders |
ByLabelId |
DocumentService |
GetFileFoldersByLabelId |
|
|
LatestFiles |
ByIds |
DocumentService |
GetLatestFilesByIds |
|
|
ByMasterIds |
DocumentService |
GetLatestFilesByMasterIds |
||
|
ByFolderId |
DocumentService |
GetLatestFilesByFolderId |
||
|
ByFolderIds |
DocumentService |
GetLatestFilesByFolderIds |
||
|
AllFileNamingSchemes |
DocumentService |
GetAllFileNamingSchemes |
||
|
AssociatedFilePaths |
ByIds |
DocumentService |
GetAssociatedFilePathsByIds |
|
|
BlockExplorerDesignFileCheckin |
DocumentService |
GetBlockExplorerDesignFileCheckin |
||
|
BOM |
ByFileId |
DocumentService |
GetBOMByFileId |
|
|
ByFileIds |
DocumentService |
GetBOMByFileIds |
||
|
BulkFileThreshold |
DocumentService |
GetBulkFileThreshold |
||
|
ContentSourceIds |
ByFileIds |
DocumentService |
GetContentSourceIdsByFileIds |
|
|
DesignVisualizationAttachments |
ByFileMasterIds |
DocumentService |
GetDesignVisualizationAttachmentsByFileMasterIds |
|
|
DownloadTickets |
ByFileIds |
DocumentService |
GetDownloadTicketsByFileIds |
|
|
EnforceInventorProjectFile |
DocumentService |
GetEnforceInventorProjectFile |
||
|
FileAssociationLites |
ByIds |
DocumentService |
GetFileAssociationLitesByIds |
|
|
FileAssociationRestrictions |
ById |
DocumentService |
GetFileAssociationRestrictionsById |
|
|
FileAssociations |
ByIds |
DocumentService |
GetFileAssociationsByIds |
|
|
FileDeleteRestrictions |
ByMasterId |
DocumentService |
GetFileDeleteRestrictionsByMasterId |
|
|
ByMasterIds |
DocumentService |
GetFileDeleteRestrictionsByMasterIds |
||
|
FileRenameRestrictions |
ByMasterId |
DocumentService |
GetFileRenameRestrictionsByMasterId |
|
|
ByMasterIds |
DocumentService |
GetFileRenameRestrictionsByMasterIds |
||
|
FileStatusSetRestrictions |
ByMasterIds |
DocumentService |
GetFileStatusSetRestrictionsByMasterIds |
|
|
FileVersionDeleteRestrictions |
ByMasterIds |
DocumentService |
GetFileVersionDeleteRestrictionsByMasterIds |
|
|
ByFileIds |
DocumentService |
GetFileVersionDeleteRestrictionsByFileIds |
||
|
InventorProjectFileLocation |
DocumentService |
GetInventorProjectFileLocation |
||
|
LatestAssociatedFilePaths |
ByMasterIds |
DocumentService |
GetLatestAssociatedFilePathsByMasterIds |
|
|
LatestDuplicateFilePaths |
DocumentService |
GetLatestDuplicateFilePaths |
||
|
LatestFileAssociations |
ByMasterIds |
DocumentService |
GetLatestFileAssociationsByMasterIds |
|
|
LatestFile |
ByMasterId |
DocumentService |
GetLatestFileByMasterId |
|
|
LatestFileIds |
ByIds |
DocumentService |
GetLatestFileIdsByIds |
|
|
ByFoldersIds |
DocumentService |
GetLatestFileIdsByFoldersIds |
||
|
LatestFilePaths |
ByNames |
DocumentService |
GetLatestFilePathsByNames |
|
|
RevisionAssociatedFilePaths |
ByIds |
DocumentService |
GetRevisionAssociatedFilePathsByIds |
|
|
RevisionFileAssociations |
ByIds |
DocumentService |
GetRevisionFileAssociationsByIds |
|
|
ByIds2 |
DocumentService |
GetRevisionFileAssociationsByIds2 |
||
|
TrackFileStatus |
DocumentService |
GetTrackFileStatus |
||
|
UniqueFileNameRequired |
DocumentService |
GetUniqueFileNameRequired |
||
|
WorkspaceSyncFileLimit |
DocumentService |
GetWorkspaceSyncFileLimit |
||
|
AllowedFileLifeCycleStateTransitionIds |
DocumentService Extensions |
GetAllowedFileLifeCycleStateTransitionIds |
||
|
LifeCycleStateIds |
ByFileMasterIds |
DocumentService Extensions |
GetLifeCycleStateIdsByFileMasterIds |
|
|
ContentSourcePropertyDefinitions |
ByFileMasterId |
ItemService |
GetContentSourcePropertyDefinitionsByFileMasterId |
|
|
RegisteredExternalFileUploaderNames |
FilestoreService |
GetRegisteredExternalFileUploaderNames |
||
|
ItemBOMFileAssociations |
ByDate |
ItemService |
GetItemBOMFileAssociationsByDate |
|
|
ItemFileAssociations |
ByItemIds |
ItemService |
GetItemFileAssociationsByItemIds |
|
|
RestrictAssignDesignFiles |
ItemService |
GetRestrictAssignDesignFiles |
||
|
PreviewInfo |
FromFile |
PackageService |
GetPreviewInfoFromFile |
|
|
FromUploadedFile |
PackageService |
GetPreviewInfoFromUploadedFile |
||
|
Move |
File |
DocumentService |
MoveFile |
|
|
Promote |
Files |
ItemService |
PromoteFiles |
|
|
Reserve |
FileNamingDescriptions |
DocumentService |
ReserveFileNamingDescriptions |
|
|
Rollback |
FileNamingDescriptions |
DocumentService |
RollbackFileNamingDescriptions |
|
|
Set |
BlockExplorerDesignFileCheckin |
DocumentService |
SetBlockExplorerDesignFileCheckin |
|
|
BulkFileThreshold |
DocumentService |
SetBulkFileThreshold |
||
|
EnforceInventorProjectFile |
DocumentService |
SetEnforceInventorProjectFile |
||
|
InventorProjectFileLocation |
DocumentService |
SetInventorProjectFileLocation |
||
|
TrackFileStatus |
DocumentService |
SetTrackFileStatus |
||
|
UniqueFileNameRequired |
DocumentService |
SetUniqueFileNameRequired |
||
|
WorkspaceSyncFileLimit |
DocumentService |
SetWorkspaceSyncFileLimit |
||
|
DefaultFileNamingScheme |
DocumentService |
SetDefaultFileNamingScheme |
||
|
FileStatus |
ByMasterId |
DocumentService |
SetFileStatusByMasterId |
|
|
ByMasterIds |
DocumentService |
SetFileStatusByMasterIds |
||
|
RestrictAssignDesignFiles |
ItemService |
SetRestrictAssignDesignFiles |
||
|
Undo |
CheckoutFile |
DocumentService |
UndoCheckoutFile |
|
|
Update |
Items |
FromFiles |
ItemService |
UpdateItemsFromFiles |
|
FileNamingScheme |
DocumentService |
UpdateFileNamingScheme |
||
|
FileAssociationReferences |
DocumentService |
UpdateFileAssociationReferences |
||
|
FileProperties |
DocumentService |
UpdateFileProperties |
||
|
FilePropertyDefinitions |
DocumentService |
UpdateFilePropertyDefinitions |
||
|
FileCategories |
DocumentService Extensions |
UpdateFileCategories |
||
|
FileLifeCycleDefinitions |
DocumentService Extensions |
UpdateFileLifeCycleDefinitions |
||
|
FileLifeCycleStates |
DocumentService Extensions |
UpdateFileLifeCycleStates |
||
|
FileRevisionNumbers |
DocumentService Extensions |
UpdateFileRevisionNumbers |
||
|
Upload |
FilePart |
FilestoreService |
UploadFilePart |
|
|
PackageService |
UploadFilePart |
|||
|
ExternalFile |
FilestoreService |
UploadExternalFile |
||
|
Validate |
BOM |
ByFileId |
DocumentService |
ValidateBOMByFileId |
Информация о файле хранится в классе File. Он содержит следующие поля:
|
Имя |
Описание |
|
Cat |
Информация о категории этого файла. Для файлов в категории "None", объект FileCat будет иметь идентификатор 0. |
|
CheckedOut |
Если значение TRUE, то последняя версия этого файла находится в извлеченном состоянии. Всякий раз, когда файл выдается, создается новая версия в качестве заполнителя. |
|
CkInDate |
Дата и время, когда файл был возвращен. Это свойство действительно только значение когда CheckedOut равно FALSE. |
|
CkOutMach |
Сетевой идентификатор компьютера, с которого возвращен файл. Этот параметр действителен только когда значение CheckedOut равно TRUE. |
|
CkOutSpec |
Путь к файлу на компьютере клиента, на который была произведена выдача файла. Этот параметр действителен только когда значение CheckedOut равно TRUE. |
|
CkOutUserId |
Идентификатор пользователя, который получил файл. Этот параметр действителен только когда значение CheckedOut равно TRUE. |
|
Cksum |
Контрольная сумма файла. Этот параметр действителен только когда значение CheckedOut равно FALSE. |
|
Cloaked |
Если значение равно TRUE, вошедший пользователь не имеет права на просмотр файла. Единственные возможные данные в скрытом файле является Id и MasterId. Все остальные данные будет NULL или 0. |
|
Comm |
Строка комментария, задаваемая пользователем. Если значение CheckedOut равно TRUE, то это свойство содержит комментарий, заданный во время проверки. Если значение CheckedOut равно FALSE, то это свойство содержит комментарий заданный в процессе возврата файла в хранилище. Возврат файла в хранилище сбрасывает комментарий для этой версии. |
|
ControlledByChangeOrder |
Если значение равно TRUE, то файл управляется запросом на изменение. Если FALSE, то обратное. |
|
CreateDate |
Содержит дату и время, когда эта версия файла была создана в Vault. Для первой версии файла, эта дата будет соответствовать значению свойства CkInDate. Для более поздних версий это значение будет иметь время, когда предыдущая версия была выдана из хранилища. |
|
CreateUserId |
Идентификатор пользователя, который вернул в хранилище, либо выгрузил файл. |
|
CreateUserName |
Имя пользователя, который вернул в хранилище, либо выгрузил файл. |
|
DesignVisAttmtStatus |
Статус файла визуализации (. DWF ). |
|
FileClass |
Классификация файла. |
|
FileLfCyc |
Информация о жизненном цикле файла. |
|
FileRev |
Информация о редакции этого файла. Для файлов в "нулевой" редакции, объект FileRev будет иметь идентификатор 0. |
|
FileSize |
Размер файла в байтах. Это свойство действительно только когда значение CheckedOut равно FALSE. |
|
FileStatus |
Содержит отметку о необходимости обновления файла. |
|
FolderId |
Идентификатор родительской папки. |
|
Hidden |
Если это значение равно FALSE, то файл должен быть скрыт от клиента. |
|
Id |
Уникальный идентификатор файла. |
|
IsOnSite |
В много-узловой среде, это свойство содержит информацию о том, находится ли файл на локальном узле. Если значение равно TRUE, файл находится на локальном узле. Если FALSE то файл находится не на локальном сайте. Это значение всегда будет равно TRUE в среде с одним узлом. |
|
Locked |
Содержит информацию о том, может ли файл быть изменен вошедшим в систему пользователем. |
|
MasterId |
Уникальный идентификатор для того, чтобы сгруппировать все версии файла. Другими словами, различные версии файла будет иметь другой Id но одинаковый же MasterId. |
|
MaxCkInVerNum |
Максимальное значение версии этого файла, которая в настоящее время зарегистрирована в хранилище. |
|
ModDate |
Дата последнего изменения файла. Это значение устанавливается клиентом, который выгрузил файл в хранилище. |
|
Name |
Имя файла. Это значение применяется ко всем версиям файла. ' VERNAME ' содержит имя для конкретной версии файла. |
|
VerName |
Историческое имя, которое соответствует этой версии файла. |
|
VerNum |
Версия файла. Файл, который только что был добавлен в хранилище, будет иметь значение Vernum равным 1. |
Автор перевода: Дмитрий Емельянов
Обсуждение: http://adn-cis.org/forum/index.php?topic=781
Опубликовано 29.05.2014Отредактировано 30.05.2014 в 18:23:20
