ArtifactManagerProxy.ExecuteRelativityScript Method

Relativity Services API
Executes a Relativity Script configured in a workspace by the Relativity Administrator.

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
Copy
public RelativityScriptResult ExecuteRelativityScript(
	APIOptions apiOpt,
	int scriptArtifactID,
	List<RelativityScriptInput> inputs
)

Parameters

apiOpt
Type: kCura.Relativity.Client.APIOptions
The APIOptions object containing the session token from the Login() call and the workspace ID.
scriptArtifactID
Type: System.Int32
The ArtifactID of the script.
inputs
Type: System.Collections.Generic.List<RelativityScriptInput>
The input parameters for the script.

Return Value

Type: RelativityScriptResult
Returns a ResultSet that provides the output of the execution of the script.
Remarks
This method returns a RelativityScriptResult object that may include the status of the operation and the number of database rows affected by the script.
Remarks
The logged-in user must be a Relativity Script Administrator to use this method.
See Also

Reference

ArtifactManagerProxy Class
kCura.Relativity.Client Namespace