Class ActionJob

Represents a script action job.

Inheritance
System.Object
ActionJob
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework.Models
Assembly: Relativity.Testing.Framework.dll
Syntax
public class ActionJob

Properties

| Improve this Doc View Source

Actions

Gets or sets a list of RESTful operations that a user has permissions to perform on the script action job.

Declaration
public List<HttpAction> Actions { get; set; }
Property Value
Type Description
System.Collections.Generic.List<HttpAction>
| Improve this Doc View Source

AllowHtmlTagsInOutput

Gets or sets a value indicating whether html tags should be rendered by the browser.

Declaration
public bool AllowHtmlTagsInOutput { get; set; }
Property Value
Type Description
System.Boolean
Remarks

If set to "true", allows HTML tags to be interpreted by the browser instead of rendered as markup.

| Improve this Doc View Source

Columns

Gets or sets the column information when the ReturnType is Table.

Declaration
public List<ActionColumn> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ActionColumn>
Remarks

This property will only be set when the ReturnType is Table. This property will only be set when the action has completed successfully.

| Improve this Doc View Source

ErrorMessage

Gets or sets the error message when an error.

Declaration
public string ErrorMessage { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Meta

Gets or sets a list of unsupported and read-only properties on the script action job.

Declaration
public Meta Meta { get; set; }
Property Value
Type Description
Meta
| Improve this Doc View Source

Name

Gets or sets the name of the action.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
Remarks

This value is optional and is declared in the script definition.

| Improve this Doc View Source

ReturnType

Gets or sets the return type of the action.

Declaration
public ActionReturnType ReturnType { get; set; }
Property Value
Type Description
ActionReturnType
| Improve this Doc View Source

RowsAffected

Gets or sets the number of rows affected by the completed action when the ReturnType is Status.

Declaration
public int? RowsAffected { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

This property will only be set when the ReturnType is Status. This property will only be set when the action has completed sucessfully.

| Improve this Doc View Source

Status

Gets or sets the current status of the job.

Declaration
public RunJobStatus Status { get; set; }
Property Value
Type Description
RunJobStatus