Exposes the available Services API functionality.
Inheritance Hierarchy
kCura.Relativity.Client.RSAPIClient
Namespace: kCura.Relativity.Client
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The RSAPIClient type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | RSAPIClient(Uri, AuthenticationType) |
Instantiate the RSAPIClient, specifying the Services API location and authentication type.
|
| RSAPIClient(Uri, AuthenticationType, RSAPIClientSettings) |
Instantiate the RSAPIClient, specifying the Services API location, authentication type, and settings.
|
Properties
| Name | Description | |
|---|---|---|
 | APIOptions |
Provides an instance of APIOptions associated with the current RSAPIClient instance.
|
| AuthType |
Used to provide the type of Authentication and set credentials when required by the type.
|
| EndpointUri |
The location of the Services API.
|
| Repositories |
Used to access the group of repositories.
|
Methods
| Name | Description | |
|---|---|---|
| Clear |
Clears the value of a file field in Relativity.
|
| ConvertToScriptInputList |
Outputs a list of RelativityScriptInput objects for use with the ExecuteRelativityScript method.
|
| Create |
Creates the specified ArtifactRequests.
|
| CreateBatchesForBatchSetAsync(APIOptions, Int32) |
Asynchronously creates batches for a given batchset. This method monitors the process by default.
|
| CreateBatchesForBatchSetAsync(APIOptions, Int32, Boolean) |
Asynchronously creates batches for a given batchset.
|
| Delete |
Deletes the specified ArtifactRequests.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Download(FileRequest) |
Download the contents of a Relativity file field as a Stream object.
|
| Download(FileRequest, String) |
Download the contents of a Relativity file field to disk.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteBatch |
Executes Create, Update, Delete, MassEdit and/or MassCreate Commands within a database transaction.
|
| ExecuteRelativityScript |
Executes a Relativity Script configured in a workspace by the Relativity Administrator.
|
| ExportApplication |
Exports an application.
|
| FlagProcessForCancellationAsync |
Cancels a running process.
|
| GenerateRelativityAuthenticationToken |
Generate Relativity Authorization Token from Session Token
|
| GetAuthenticationToken | Obsolete.
This method is obsolete. Do not use.
|
| GetFileFieldDownloadURL |
Get a URL to download the file contained in a file field.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLicense |
Gets serialized license object.
|
| GetProcessState |
Returns information on the state of an active long-running process within the system.
|
| GetRelativityScriptInputs |
Gets a list of inputs required for a script configured in a workspace by a Relativity Administrator.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InstallApplication |
Installs an Application.
|
| InstallLibraryApplication |
Imports a Application to the Application Library.
|
| Login |
Returns a string used to identify the current session, and establishes a session with the Services API.
|
| LoginWithCredentials |
Returns a string used to identify the current session, and establishes a session with the Services API.
|
| Logout |
Terminates the session with the Relativity.Services API
|
| MassCreate |
Creates new custom objects in bulk using Field values provided by a template Artifact.
|
| MassCreateWithAPIParameters |
MassCreate will create RDO instances based upon the Field values provided by a 'template' ArtifactRequest. The template provides the
default values. An RDO instance will be created for each ArtifactRequest in the ArtifactRequests list. Any field values provided in an ArtifactRequest
will override the defaults provided by the template ArtifactRequest.
|
| MassCreateWithDetails |
Creates new custom objects in bulk using Field values provided by a template Artifact. The results contain the IDs for the
created artifacts.
|
| MassDelete |
Deletes all artifacts of the type specified in the MassDeleteOptions whose identifier matches items specified in the artifact identifiers list.
|
| MassDeleteAllDocuments |
Deletes all documents in a workspace.
|
| MassDeleteAllObjects |
Deletes all artifacts of the type specified.
|
| MassDeleteDocuments |
Deletes all artifacts of the type specified in the MassDeleteOptions whose identifier matches items specified in the artifact identifiers list.
|
| MassEdit |
Updates Documents with Field values from a template.
|
| MonitorProcessState |
Registers the current proxy to monitor and raise status events for a running process.
|
| PurgeBatchesOfBatchSetAsync(APIOptions, Int32) |
Asynchronously purges batches associated with a given batchset.
|
| PurgeBatchesOfBatchSetAsync(APIOptions, Int32, Boolean) |
Asynchronously purges batches associated with a given batchset.
|
| PushResourceFiles |
Creates or Updates a Resource File.
|
| Query |
Queries Relativity to find Artifacts matching the selection criteria.
|
| QuerySubset |
Fetches search results not returned in the first call to Query.
|
| Read |
Searches for the objects specified in the ArtifactRequest list and reads them.
|
| TokenLogin |
Logs on using a token.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Updates the specified ArtifactRequest objects.
|
| Upload |
Populates the contents of a file field in Relativity.
|
| ValidateEndpoint |
Tries to create a channel with the EndpointUri.
|
Events
| Name | Description | |
|---|---|---|
 | Cancel |
Occurs when the cancellation of an upload or download operation succeeds.
|
| DownloadComplete |
Occurs when a download operation succeeds.
|
| Failure |
Occurs when a download or upload file transfer encounters an error.
|
| ProcessCancelled |
Occurs when a running process is cancelled.
|
| ProcessComplete |
Occurs when a running process has completed.
|
| ProcessCompleteWithError |
Occurs when a running process has completed.
|
| ProcessFailure |
Occurs when a running process has failed during execution.
|
| ProcessProgress |
Occurs when there is a notable change in the progress of a running process.
|
| Progress |
Occurs when the percentage completed for an upload or download operation changes.
|
| RSAPIClientServiceOperationFailed |
The ServiceOperationFailed event is raised when an error occurs attempting to perform an operation.
|
| UploadComplete |
Occurs when an upload operation succeeds.
|
See Also