Workspace Class

Relativity Services API
Represents a workspace.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.DTOs.Artifact
    kCura.Relativity.Client.DTOs.Workspace

Namespace:  kCura.Relativity.Client.DTOs
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class Workspace : Artifact

The Workspace type exposes the following members.

Constructors

  NameDescription
Public methodWorkspace()
Creates a new instance of the Workspace class.
Public methodWorkspace(List<Guid>)
Initializes a new instance of the Workspace class with the given list of Artifact GUIDs.
Public methodWorkspace(Guid)
Initializes a new instance of the Workspace class with the given Artifact GUID.
Public methodWorkspace(Int32)
Initializes a new instance of the Workspace class with the given ArtifactID.
Top
Properties

  NameDescription
Public propertyAccessible
Indicates whether the workspace has been upgraded to the current version of Relativity.
Public propertyArtifactID
Represents a unique identifier for an Artifact.
(Inherited from Artifact.)
Public propertyArtifactTypeGuids
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.)
Public propertyArtifactTypeID
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.)
Public propertyArtifactTypeName
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.)
Public propertyClient
Indicates the ArtifactID of the client associated with the workspace.
Public propertyCredentials
Represents a list of Credentials related to the Workspace. NOTE: INTERNAL USE ONLY
Public propertyDatabaseLocation
Indicates the name of the server where the database is located.
Public propertyDefaultCacheLocation
Indicates the ArtifactID of the Default Cache Location server associated with the workspace.
Public propertyDefaultDataGridLocation
The path of the physical location for the files associated with Data Grid data for the case. It is specified as a ResourceServer object that represents the Data Grid resource server.
Public propertyDefaultFileLocation
The path of the physical location for the files associated with the case. It is specified as a Choice object that represents the file share resource server.
Public propertyDownloadHandlerApplicationPath
Indicates a string that identifies default URL for code used in downloading files for users.
Public propertyEnableDataGrid
Represents the whether Data Grid has been enabled for the workspace.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
Public propertyItem[Guid]
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[Int32]
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[String]
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.)
Public propertyMatterID
Indicates the ArtifactID of the matter associated with the workspace.
Public propertyName
Represents a string used to identify a workspace, and it is equivalent to the TextIdentifer property on Artifact.
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyResourcePoolID
Returns an integer ID representing the resource pool.
Public propertyRootFolderID
Indicates the ArtifactID assigned to the root folder of the workspace.
Public propertyServerID
Indicates the ArtifactID of the server where the workspace database resides.
Public propertySQLFullTextLanguageCodeID
Returns an integer representing the language used for word-break characters in the full text index.
Public propertyStatus
Represents the status of the workspace.
Public propertySystemCreatedBy
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemCreatedOn
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedBy
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedOn
Represents the DateTime in UTC when the Artifact was last modified. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertyTextIdentifier
Indicates the value of the IdentifierFieldName field available in Fields property of the Artifact. This field may also be available as a Name property for many Artifacts.
(Inherited from Artifact.)
Public propertyWorkspaceAdminGroup
Indicates the Group assigned Admin permissions to Workspace.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current Artifact.
(Inherited from Artifact.)
Top
Remarks

Read and query operations are supported for the Workspace class.
See Also

Reference