ArtifactRequest Class

Relativity Services API
Represents a request for an operation to be performed on an Artifact in a workspace.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.ArtifactRequest

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

public class ArtifactRequest

The ArtifactRequest type exposes the following members.

Constructors

  NameDescription
Public methodArtifactRequest()
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Guid)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Int32)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(String)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Guid, Guid)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Guid, Int32)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Int32, Guid)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Int32, Int32)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(String, Guid)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(String, Int32)
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Guid, Guid,Field[])
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Guid, Int32,Field[])
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Int32, Guid,Field[])
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(Int32, Int32,Field[])
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(String, Guid,Field[])
Initializes a new instance of the ArtifactRequest class.
Public methodArtifactRequest(String, Int32,Field[])
Initializes a new instance of the ArtifactRequest class.
Top
Properties

  NameDescription
Public propertyArtifactGuid
Provides a GUID representing an Artifact in Relativity. Use as an alternative to ArtifactID.
Public propertyArtifactID
Indicates the unique identifier for an Artifact. Use as an alternative to an ArtifactGuid.
Public propertyArtifactTypeGuid
Indicates the GUID for the type of an item that an Artifact represents. Use as an alternative to ArtifactTypeID or ArtifactTypeName.
Public propertyArtifactTypeID
Indicates the identifier for the type of item that the Artifact represents. Use as an alternative to ArtifactTypeName or ArtifactTypeGuid.
Public propertyArtifactTypeName
Indicates the name of the Artifact type. Use as an alternative to ArtifactTypeID or ArtifactTypeGuid.
Public propertyFields
Provides a collection fields, containing values that describe an Artifact.
Public propertyParentArtifactID
Indicates the identifier for the parent or container of an Artifact.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodgetFieldByName
Returns the field whose Name matches the name passed in. Note that this is just a helper function, and that its runtime is linear with the number of fields.
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
Converts the object to it's string representation, beginning with "ArtifactRequest( ArtifactID=[ArtifactID], ParentArtifactID=[ParentArtifactID], ArtifactTypeID=[ArtifactTypeID], ArtifactTypeName="[ArtifactTypeName]"", and continuing with a line for each field name and value pair.
(Overrides Object.ToString().)
Top
Remarks

An ArtifactRequest object can hold information about Documents and custom objects, as well as metadata about the workspace structure, including fields, choices, and folders that it contains. An ArtifactRequest object is a slimmed-down version of an Artifact object.
See Also

Reference