GetDMObjectResponse Properties
An object defining properties for the GetDMObjectResponse class.
DecryptedVersionSecret
Gets the decrypted secret information for the version of the document management object.
Type: DMObjectVersionSecret
This property provides access to the decrypted security information for the object's version. It is marked with [Ignored] attribute and creates a new DMObjectVersionSecret instance using version-related properties. Returns null if VersionId is not set.
SecretKey
Gets or sets the encrypted secret key for the document management object.
Type: string
This property contains the encrypted secret key used for securing the object. It is marked with the [EncryptData] attribute and uses the DecryptedObjectSecret for encryption/decryption.
Id
Gets or sets the unique identifier of the document management object.
Type: long
This property represents the primary identifier for the document management object in the system. It is used for referencing and retrieving the object.
Tags
Gets or sets the list of tags associated with the document management object.
This property contains a list of tags that help categorize and identify the object. The tags are stored as individual strings and are typically used for searching and organizing document management objects.
DeletedAt
Gets or sets the date and time when the document management object was deleted.
Type: DateTimeOffset?
This property stores the timestamp of when the object was deleted, including timezone information. It is nullable and will be null if the object has not been deleted.
DeletedBy
Gets or sets information about the user who deleted the document management object.
Type: ClientUserInfo
This property contains detailed user information about who deleted the object. It will be null if the object has not been deleted.
TokenId
Gets or sets the token identifier used for security purposes.
Type: string
This property stores the security token identifier used for authentication and authorization. It is marked with the [Ignored] attribute to exclude it from serialization.
MetaDataFieldsValues
Gets or sets the list of metadata field values associated with the document management object.
Type: List<MetaDataFieldValue>
This property contains a collection of metadata field values that provide additional information about the object. Each MetaDataFieldValue in the list represents a specific metadata field and its value, allowing for rich metadata management.
Version
Gets or sets the version identifier string of the document management object.
Type: string
This property contains the version identifier in string format. It represents the version number or label assigned to this version of the object.
VersionSecretKey
Gets or sets the encrypted secret key for the version of the document management object.
Type: string
This property contains the encrypted secret key used for securing the object's version information. It is marked with the [EncryptData] attribute and uses the DecryptedVersionSecret for encryption/decryption operations.
OriginType
Gets or sets the original type of the document management object.
Type: DMObjectType
Accepted Values:
Name Value Repository 0 Folder 1 File 2 Content 3 Shortcut 4
This property indicates the initial or original type of the object in the document management system. It is used to track the object's original classification, which may differ from its current type.
ModifiedBy
Gets or sets information about the user who last modified the document management object.
Type: ClientUserInfo
This property contains detailed user information about who last modified the object. It may be null if the object has never been modified after its creation.
Description
Gets or sets the multilingual descriptions of the document management object.
Type: Dictionary<string, string>
This property contains a dictionary of language codes and corresponding descriptions for the object. Similar to the Name property, it supports multilingual content where dictionary keys represent language codes and values represent the localized descriptions.
Type
Gets or sets the type of the document management object.
Type: DMObjectType
Accepted Values:
Name Value Repository 0 Folder 1 File 2 Content 3 Shortcut 4
This property indicates the current type of the object (Repository, Folder, File, Content, or Shortcut) in the document management system. It determines how the object behaves and what operations can be performed on it.
Name
Gets or sets the multilingual names of the document management object.
Type: Dictionary<string, string>
This property contains a dictionary of language codes and corresponding names for the object, supporting multilingual display of the object's name. The dictionary keys represent language codes, and the values represent the localized names.
DecryptedObjectSecret
Gets the decrypted secret information for the document management object.
Type: DMObjectSecret
This property provides access to the decrypted security information for the object. It is marked with [Ignored] attribute and creates a new DMObjectSecret instance using the object's Id, Type, and TokenId. This property is used for encryption/decryption operations.
ParentBreadCrumb
Gets or sets the breadcrumb path to the parent of the document management object.
Type: string
This property contains the hierarchical path to the object's parent, typically used for navigation and displaying the object's location in the document management system hierarchy.
VersionId
Gets or sets the unique identifier of the object's version.
This property stores the identifier of the specific version of the file. It is only used for file type objects and will be null for other types of objects (Repository, Folder, etc.).
CreatedAt
Gets or sets the date and time when the document management object was created.
Type: DateTimeOffset
This property stores the exact timestamp of when the object was created, including timezone information. It is automatically set during object creation.
IsBranch
Gets or sets whether the document management object is a branch version.
Type: bool
This property indicates if the current object represents a branch in the version control system. It is used in conjunction with version control features to manage different branches of the same object.
CreatedBy
Gets or sets information about the user who created the document management object.
Type: ClientUserInfo
This property contains detailed user information about who initially created the object, including their user ID, name, and other relevant user details.
ModifiedAt
Gets or sets the date and time when the document management object was last modified.
Type: DateTimeOffset?
This property stores the timestamp of the last modification made to the object, including timezone information. It is nullable and will be null if the object has never been modified after its creation.
ReasonForDeleting
Gets or sets the reason provided for deleting the document management object.
Type: string
This property stores the explanation or reason given when the object was deleted. It will be null if the object has not been deleted or if no reason was provided during deletion.
CommitId
Gets or sets the commit identifier for the document management object version.
Type: long
This property stores the identifier of the commit that created this version of the object. It is used in the version control system to track changes and maintain version history.
ExistThumbnail
Gets or sets whether a thumbnail exists for the document management object.
Type: bool
This property indicates if the object has an associated thumbnail image. It is typically used for file objects that can have visual previews.
VersionDate
Gets or sets the date and time when this version of the document management object was created.
Type: DateTimeOffset?
This property stores the timestamp when this specific version was created, including timezone information. It is nullable and may be null if versioning is not applicable to the object.