Class GetWorkflowItemsByCriteriaRequest

The GetWorkflowItemByCriteriaRequest class is a REST data model representing a criteria by which workflow items should be filtered for retrieval.

Inheritance

System.Object

GetWorkflowItemsByCriteriaRequest

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: EPiServer.Social.Moderation.Rest.Contracts

Assembly: EPiServer.Social.Moderation.Rest.Contracts.dll

Version: 1.5.4

Syntax

public class GetWorkflowItemsByCriteriaRequest

Constructors

GetWorkflowItemsByCriteriaRequest()

Declaration

public GetWorkflowItemsByCriteriaRequest()

Properties

CalculateTotalCount

Gets or sets whether to calculate total count or not.

Declaration

public bool CalculateTotalCount { get; set; }

Property Value

Type	Description
System.Boolean

ExcludeHistoricalItems

Gets or sets a flag indicating whether or not the result set should be only include items representing the current state of resources within a workflow.

Declaration

public bool ExcludeHistoricalItems { get; set; }

Property Value

Type	Description
System.Boolean

ExtensionFilter

Gets or sets the extension filter.

Declaration

public ExtensionFilter ExtensionFilter { get; set; }

Property Value

Type	Description
ExtensionFilter

ExtensionType

Gets or sets the extension type to filter on.

Declaration

public string ExtensionType { get; set; }

Property Value

Type	Description
System.String

IncludeSubclasses

Gets or sets whether to include subclasses during the filtering.

Declaration

public bool? IncludeSubclasses { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Offset

Gets or sets the offset at which the filtered results should be returned.

Declaration

public int Offset { get; set; }

Property Value

Type	Description
System.Int32

Size

Gets or sets the size of the number of matching workflows to returned.

Declaration

public int Size { get; set; }

Property Value

Type	Description
System.Int32

Sort

Gets or sets the sort rules for the filtered set.

Declaration

public string Sort { get; set; }

Property Value

Type	Description
System.String

State

Gets or sets the workflow state to which items should be restricted.

Declaration

public WorkflowStateRestModel State { get; set; }

Property Value

Type	Description
WorkflowStateRestModel

Target

Gets or sets a reference representing the item target within the workflow to which items should be restricted.

Declaration

public string Target { get; set; }

Property Value

Type	Description
System.String

Workflow

Gets or sets a workflow ID filtering the result set to only items associated with that workflow.

Declaration

public string Workflow { get; set; }

Property Value

Type	Description
System.String