DocumentService Class
Autodesk.Connectivity.WebServices›Autodesk.Connectivity.WebServices
Contains methods for manipulating files and folders within a vault.
Syntax
public sealed class DocumentService : DocumentServiceBase, IWebService Public NotInheritable Class DocumentService
Inherits DocumentServiceBase
Implements IWebService Properties
| Name | Description |
|---|---|
| AddFileEvents | A collection of Web Service Command Events for add File operations. |
| AddFolderEvents | A collection of Web Service Command Events for add Folder operations. |
| AllowInvokeEvents | Tells if invoke events should fire. This value is true by default. |
| CheckinFileEvents | A collection of Web Service Command Events for checkin File operations. |
| CheckoutFileEvents | A collection of Web Service Command Events for checkout File operations. |
| ClientCertificate | Client certificate for making web service calls over an SSL connection. |
| CurrentlySetSession | This is information about the current session of the signed-in user. |
| DeleteFileEvents | A collection of Web Service Command Events for delete File operations. |
| DeleteFolderEvents | A collection of Web Service Command Events for delete Folder operations. |
| DownloadFileEvents | A collection of Web Service Command Events for download File operations. |
| MoveFileEvents | A collection of Web Service Command Events for move File operations. |
| MoveFolderEvents | A collection of Web Service Command Events for move Folder operations. |
| QueryString | The query string. |
| RedirectedTo | Contains the ADMS that handled the replication redirect (if applicable). |
| Session | This is information about the session of the signed-in user. |
| WebServiceManager | A reference to the WebServiceManager that created this object. Value may be null. |
Methods
| Name | Description |
|---|---|
| AddDesignRepresentationFileAttachment | Adds an attachment to a Design Representation file without increasing the version of the file. |
| AddDesignVisualizationFileAttachment | Adds an attachment to a Design Visualization file without increasing the version of the file. |
| AddFileNamingScheme | Creates a new file naming scheme. |
| AddFolder | Creates a new folder in the Vault. |
| AddLabel | Creates a new label in the Vault. |
| AddLink | Adds a new Link. |
| AddUploadedFile | Creates a File object based on binary data previously uploaded. |
| CheckinUploadedFile | Checks-in a file based on binary data previously uploaded |
| CheckoutFile | Checks out a file from the vault. |
| CheckRolePermissions | Check if the current logged in user has permission to execute specific web service APIs |
| DeleteFileFromFolder | Deletes a file. |
| DeleteFileFromFolderUnconditional | Deletes a file unconditionally. |
| DeleteFileNamingScheme | Deletes a file naming scheme |
| DeleteFilesFromFolder | Deletes multiple files. |
| DeleteFilesFromFolderUnconditional | Deletes multiple files unconditionally. |
| DeleteFileVersions | Deletes specific versions of a file. |
| DeleteFileVersionsByMasterIds | Purges older versions of a file based on certian criteria. |
| DeleteFileVersionsByMasterIdsUnconditional | Purges older versions of a file based on certain criteria. |
| DeleteFileVersionsUnconditional | Deletes specific versions of a file. |
| DeleteFolderHierarchy | Deletes a vault folder and all its subfolders. |
| DeleteFolderHierarchyUnconditional | Deletes a folder and all its subfolders unconditionally. |
| DeleteLabel | Deletes the specified label. |
| DeleteLinks | Deletes a set of Links. |
| FindAllFilesByDatesAndChecksums | |
| FindFileFoldersBySearchConditions | Performs a search on the Vault for a list of FileFolders. |
| FindFilePathsByDateAndChecksum | Returns a set of file paths based on the create date and checksum. |
| FindFilePathsByDateNameAndChecksum | Finds a file and its related folders based on date, name and checksum values. |
| FindFilePathsByNameAndChecksum | Returns a set of file paths based on a name and checksum. |
| FindFilesByDatesAndChecksums | Find a set of Files based on checksum and create date information. |
| FindFilesByDatesPathsAndChecksums | Returns a set of Files based on lists of dates, paths and checksums. |
| FindFilesByFoldersDatesNamesAndChecksums | Find Files based on folders, dates, file names and checksums. |
| FindFilesByFoldersNamesAndChecksums | Returns a set of Files based on lists of folders, file names and checksums. |
| FindFilesByIds | Find files by ids. |
| FindFilesByPathsAndChecksums | Returns a set of Files based on a list of paths and checksums. |
| FindFilesBySearchConditions | Performs a search on the Vault files. |
| FindFoldersByIds | Gets a Folder object based on its ID. |
| FindFoldersByPaths | Gets a list of Folder objects based on their paths. |
| FindFoldersBySearchConditions | Performs a Folder search. |
| FindInFileSetBySearchConditions | Performs a search within a group of files. |
| FindLabelByName | Find a label based on its name. |
| FindLabelsByNames | Find labels based on a list of names. |
| FindLatestFilesByMasterIds | Finds the latest version of a set of files based on their master IDs. |
| FindLatestFilesByPaths | Gets only the latest versions of the files in a specified set of file paths. |
| FindLinksBySearchConditions | Gets the links on an entity that matches a set of search criteria. |
| GenerateFileNumber | Generates a new file name based on a numbering scheme. |
| GenerateFileNumbers | Generates new file names based on numbering schemes. |
| GetAllFileNamingSchemes | Gets all the file naming schemes. |
| GetAllLabels | Get a list of all labels. |
| GetAssociatedFilePathsByIds | Gets associated file paths for a list of file Ids. |
| GetBlockExplorerDesignFileCheckin | Tells if a non-CAD client should prevent CAD files from being checked in. |
| GetBOMByFileId | Gets the Bill of Materials data for a file. |
| GetBOMByFileIds | Gets the Bill of Materials data for a set of files. |
| GetBreakDesignVisualizationLinkCommandList | Gets which client operations should break links to design visualization files. |
| GetBulkFileThreshold | Gets the threshold values for bulk file edit operations. |
| GetComponentProperties | Gets property data for a file which has been assigned to an item. |
| GetContentSourceIdsByFileIds | Tells which content source is associated with a set of files. |
| GetDesignVisualizationAttachmentsByFileMasterIds | Gets the design visualization attachments for all versions of a set of files. |
| GetDownloadTicketsByFileIds | Gets a ticket that you can use to download binary data from the filestore service. Use this function when downloading specific file versions. |
| GetDownloadTicketsByMasterIds | Gets a ticket that you can use to download binary data from the filestore service. Use this function when downloading the latest file versions. |
| GetDWFPublishFolderLocation | Gets the location where DWF files are published. |
| GetDWFPublishPreserveFolderHierarchy | Gets the DWF Publish Preserve Folder Hierarchy option. |
| GetEditedPropertiesByMasterIds | Gets property values that were edited between the latest version and the latest released version. |
| GetEnableDWFAttachment | Determines whether DWF attachments are enabled. |
| GetEnableItemPropertyWritebackToFiles | Gets the value of the administrator option for enabling item property write back to files |
| GetEnforceInventorProjectFile | Gets the "Enforce Inventor Project File" property. |
| GetEnforceWorkingFolder | Gets the Enforce Working Folder property. |
| GetFileAssociationLitesByIds | This method gets all files associations of a set of files by file Id. The resulting objects will contain file IDs only instead of full File objects. |
| GetFileAssociationRestrictionsById | Gets any restrictions for setting dependencies between file versions. |
| GetFileAssociationsByIds | This method gets all files associations of a set of files by file Id. |
| GetFileById | Gets a File object based on its ID. |
| GetFileByVersion | Gets data on a specific version of a file in the Vault. |
| GetFileDeleteRestrictionsByMasterId | Gets all of the delete restrictions on a file. |
| GetFileDeleteRestrictionsByMasterIds | Gets all of the delete restrictions on a set of files. |
| GetFileFoldersByLabelId | Gets a list of FileFolder objects based on a label ID. |
| GetFileRenameRestrictionsByMasterId | Gets any rename restrictions on a file. |
| GetFileRenameRestrictionsByMasterIds | Gets any rename restrictions on a set of files. |
| GetFilesByHistoryType | Gets historical data about a set of files. |
| GetFilesByIds | Gets a list of Files based on their file IDs. |
| GetFilesByMasterId | Gets all the versions of a file. |
| GetFilesByMasterIds | Gets an array of files based on their master IDs. |
| GetFilesByVersions | Gets data on a specific version of a file in the Vault. |
| GetFileStatusSetRestrictionsByMasterIds | Gets any restrictions on setting the status of a File. |
| GetFileVersionDeleteRestrictionsByFileIds | Gets any restrictions on deleting a specific versions of Files. This function can be used to pre-check any issues before running DeleteFileVersions. |
| GetFileVersionDeleteRestrictionsByMasterIds | Gets any restrictions on deleting a specific versions of Files. This function can be used to pre-check any issues before running DeleteFileVersionsByMasterIds. |
| GetFilterConfigXml | Gets the contents of filterConfig.xml which is a server file that contains the property mapping of AutoCAD block attributes. |
| GetFolderById | Gets a Folder object based on its ID. |
| GetFolderByPath | Gets a folder object based on its path. |
| GetFolderDeleteRestrictionsById | Gets all of the delete restrictions on a folder. |
| GetFolderDeleteRestrictionsByIds | Gets all of the delete restrictions on a set of folders. |
| GetFolderIdsByParentIds | Gets the IDs of the folders underneith a set of folders. |
| GetFolderMoveRestrictions | Gets all move restrictions on a folder. |
| GetFolderRenameRestrictions | Gets all restrictions for renaming a folder. |
| GetFolderRoot | Gets the root Vault folder. |
| GetFoldersByFileMasterId | Gets all the folders that a set of files is shared in. |
| GetFoldersByFileMasterIds | Gets all the folders that a set of files is shared in. |
| GetFoldersByIds | Gets a Folder object based on its ID. |
| GetFoldersByParentId | Gets the sub-folders of a vault folder. |
| GetFoldersByParentIds | Gets the sub-folders of a set of parent folders. |
| GetFoldersByPaths | Gets a list of Folder objects based on their paths. |
| GetInventorProjectFileLocation | Gets the Vault location of the Inventor project file to use. This setting is only valid if the Enforce Inventor Project File setting is true. |
| GetLatestAssociatedFilePathsByMasterIds | Gets the latest associated file paths of files by their master Ids. |
| GetLatestDuplicateFilePaths | Gets file paths for the latest version of any files in the Vault that share the same file name. |
| GetLatestFileAssociationsByMasterIds | Gets the latest file associations for a list of files by their master IDs. |
| GetLatestFileByMasterId | Gets the latest version of a file. |
| GetLatestFileIdsByFoldersIds | Gets the file IDs for the latest versions of all files within a set of folders. |
| GetLatestFileIdsByIds | Gets the file ID of latest version on a set of Files. |
| GetLatestFilePathsByNames | Gets the latest file paths for a set of files, by file name. |
| GetLatestFilesByFolderId | Gets the latest versions of all files within a folder. |
| GetLatestFilesByFolderIds | Gets the latest versions of all files within a set of folders. |
| GetLatestFilesByIds | Gets the latest version on a set of Files. |
| GetLatestFilesByMasterIds | Gets the latest version of a file. |
| GetLinksByIds | Gets a set of Links based on their IDs. |
| GetLinksByParentIds | Gets a set of Link objects originating from a given set of entities. |
| GetLinksByTargetEntityIds | Gets the Link objects that point to a set of Entities. |
| GetMetaOnLinks | Gets the meta data for a set of links. |
| GetRequiredWorkingFolderLocation | The working folder that the client is expected to have. This setting is only valid if the Enforce Working Folder setting is true. |
| GetRevisionAssociatedFilePathsByIds | Gets the associated files and path information for a given set of files. The returned files will point to the latest version within a revision. |
| GetRevisionFileAssociationsByIds | This method gets all files associations of a set of files by file ID. The returned files will point to the latest version within a revision. |
| GetRevisionFileAssociationsByIds2 | This method gets all files associations of a set of files by file ID. The returned files will point to the latest version within a revision. |
| GetTrackFileStatus | Tells if the file status feature is enabled. |
| GetTurnOffWarningForUserGeneratedDesignVisualization | Gets the setting that indicates if a warning should be displayed for user generated design visualization files. |
| GetUniqueFileNameExcludedExts | |
| GetUniqueFileNameExcludedExtsAllowed | |
| GetUniqueFileNameExcludedFolders | |
| GetUniqueFileNameExcludedFoldersAllowed | |
| GetUniqueFileNameRequired | Determines whether unique file names are required. |
| GetWorkspaceSyncFileLimit | Gets the maximum number of files for a Workspace Sync operation. |
| MoveFile | Moves a file from one folder to another. |
| MoveFolder | Moves a folder from one location to beneath a different parent folder. |
| MoveLink | Moves a link to a different Folder. |
| PurgeAllFilesFromFolders | |
| RemoveDesignRepresentationFileAttachment | Remove an attachment to a Design Representation file without increasing the version of the file. |
| ReserveFileNamingDescriptions | Reserves a set of file names for a given naming scheme. |
| RollbackFileNamingDescriptions | Rolls back the generated file names. |
| SetBlockExplorerDesignFileCheckin | Sets if a non-CAD client should prevent CAD files from being checked in. |
| SetBomByFileId | Associates a BOM with an existing File Iteration |
| SetBreakDesignVisualizationLinkCommandList | Sets which client operations should break links to design visualization files. |
| SetBulkFileThreshold | Sets the threshold values for bulk file edit operations. |
| SetDefaultFileNamingScheme | Sets the default naming scheme. |
| SetDesignVisualizationAttachmentStatusById | Sets the status of a design visualization |
| SetDWFPublishFolderLocation | Sets the location where DWF files are published to. |
| SetDWFPublishPreserveFolderHierarchy | Sets the DWF Publish Preserve Folder Hierarchy option. |
| SetEnableDWFAttachment | Sets whether DWF attachments are enabled. |
| SetEnableItemPropertyWritebackToFiles | Sets the value of the administrator option for enabling item property write back to files |
| SetEnforceInventorProjectFile | Sets the "Enforce Inventor Project File" property. |
| SetEnforceWorkingFolder | Enables or disables the Enforce Working Folder setting. |
| SetFileStatusByMasterId | Sets the status of a File. |
| SetFileStatusByMasterIds | Sets the status for a set of Files. |
| SetInventorProjectFileLocation | Sets the Vault location of the Inventor project file to use. This setting is only valid if the Enforce Inventor Project File setting is true. |
| SetRequiredWorkingFolderLocation | Sets the Require Working Folder setting. |
| SetTrackFileStatus | Turn on or off the option to track file status. |
| SetTurnOffWarningForUserGeneratedDesignVisualization | Sets the setting that indicates if a warning should be displayed for user generated design visualization files. |
| SetUniqueFileNameExcludedExts | |
| SetUniqueFileNameExcludedExtsAllowed | |
| SetUniqueFileNameExcludedFolders | |
| SetUniqueFileNameExcludedFoldersAllowed | |
| SetUniqueFileNameRequired | Sets whether filenames must be unique. |
| SetWorkspaceSyncFileLimit | Sets the maximum number of files for a Workspace Sync operation. |
| UndoCheckoutFile | Performs the undo checkout operation. |
| UpdateFileAssociationReferences | Updates meta-data to an existing file association. |
| UpdateFileNamingScheme | Updates a file naming scheme. |
| UpdateFileProperties | Updates the properties on a checked out file. |
| UpdateFilePropertyDefinitions | Updates the property definitions associated with a set of files. |
| UpdateFolderName | Sets or modifies the folder name. |
| UpdateFolderUNCPath | Sets or modifies the UNC path of a Folder. |
| UpdateLabel | Sets or modifies the name and comment of a label. |
| ValidateBOMByFileId | Checks to make sure a BOM contains no errors. |
| ArchiveFilesVersionsByMasterIds | |
| ArchiveFileVersionsByMasterId | |
| ArchiveFolder | |
| ArchiveFolders | |
| DeleteFilesWithTrashSetting | |
| DeleteFilesWithTrashSettingUnconditional | |
| DeleteFileWithTrashSetting | |
| DeleteFileWithTrashSettingUnconditional | |
| DeleteFolderHierarchyWithTrashSetting | |
| DeleteFolderHierarchyWithTrashSettingUnconditional | |
| DeleteTrashedFileFromFolder | |
| DeleteTrashedFilesFromFolder | |
| DeleteTrashedFolder | |
| DeleteTrashedFolders | |
| GetComponentPropertiesByIds | |
| GetTrashBinAutoCleanupEnabled | |
| GetTrashBinEnabled | |
| GetTrashedFiles | |
| GetTrashedFolders | |
| RestoreArchiveCandidateFileByMasterId | |
| RestoreArchiveCandidateFilesByMasterIds | |
| RestoreArchiveCandidateFolder | |
| RestoreArchiveCandidateFolders | |
| RestoreFile | |
| RestoreFiles | |
| RestoreFolder | |
| RestoreFolders | |
| SetTrashBinAutoCleanupEnabled | |
| SetTrashBinEnabled |
Returned By
Where you get a DocumentService — members that return one.
Inheritance Hierarchy
- System.Object
- Autodesk.Connectivity.WebServices.ServiceBase
- Autodesk.Connectivity.WebServices.ServiceBase<T>
- Autodesk.Connectivity.WebServices.DocumentServiceBase
- Autodesk.Connectivity.WebServices.DocumentService