GetWorkflowInstances

Accepts IDs for a workflow instance and returns data related to the instance.

InputsData TypeDescription
scheduleWorkflowInstanceFilter

Accepts a given instance filter object and returns a collection of all workflow instances for that schedule.

OutputsDescription
Collection<WorkflowInstanceData> 

Returns data containing information related to start time (in descending order). If the instance no longer exists in the database, it returns an empty collection.

Data Contracts

The WorkflowInstanceFilter object passes into the GetWorkflowInstances method and can filter by schedule address. You can impose limits on the number of results returned. It contains the following properties.

[DataContract]
public class WorkflowInstanceFilter
{
  [DataMember]       
  public WorkflowIdentifier ScheduleId;     

  [DataMember]       
  public int NumResults;
}

The WorkflowInstanceData object contains the following properties.

[DataContract]
public class WorkflowInstanceData
{       
  [DataMember]        
  public WorkflowInstanceState State;        

  [DataMember]        
  public DateTime StartTime;        

  [DataMember]        
  public Guid Id;        

  [DataMember]        
  public string ScheduleAddress;
}