Search Results for

    Show / Hide Table of Contents

    Class BusinessProcess

    Business process

    Inheritance
    object
    BusinessProcess
    BusinessProcessDetails
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [JsonConverter(typeof(JsonInheritanceConverter), new object[] { "kind" })]
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class BusinessProcess

    Properties

    BusinessProcessScope

    Scope of the business process.

    Declaration
    [JsonProperty("businessProcessScope", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    [JsonConverter(typeof(StringEnumConverter))]
    public BusinessProcessScope BusinessProcessScope { get; set; }
    Property Value
    BusinessProcessScope

    ContinuationBusinessProcessId

    Id of the business process that will be automatically started after the completion of the current one, if any.

    Declaration
    [JsonProperty("continuationBusinessProcessId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string ContinuationBusinessProcessId { get; set; }
    Property Value
    string

    CurrentState

    Current state of the business process.

    Declaration
    [JsonProperty("currentState", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string CurrentState { get; set; }
    Property Value
    string

    EndDate

    When the business process finished.

    Declaration
    [JsonProperty("endDate", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime EndDate { get; set; }
    Property Value
    DateTime

    Finished

    Is the business process finished.

    Declaration
    [JsonProperty("finished", Required = Required.Always)]
    public bool Finished { get; set; }
    Property Value
    bool

    Id

    ID of the business process.

    Declaration
    [JsonProperty("id", Required = Required.Always)]
    [Required]
    public string Id { get; set; }
    Property Value
    string

    LastReportedProgress

    Timestamp when the business process last reported progress.

    Declaration
    [JsonProperty("lastReportedProgress", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public DateTime? LastReportedProgress { get; set; }
    Property Value
    DateTime?

    LifeCycle

    Current life cycle of the business process.

    Declaration
    [JsonProperty("lifeCycle", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    [JsonConverter(typeof(StringEnumConverter))]
    public BusinessProcessLifeCycle LifeCycle { get; set; }
    Property Value
    BusinessProcessLifeCycle

    ProcessDefinitionId

    ID of the business process definition associated to the business process.

    Declaration
    [JsonProperty("processDefinitionId", Required = Required.Always)]
    [Required]
    public string ProcessDefinitionId { get; set; }
    Property Value
    string

    ReferenceDocType

    Type of the document that is modified by the running of the business process. Used during the cancellation of the business process.

    Declaration
    [JsonProperty("referenceDocType", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string ReferenceDocType { get; set; }
    Property Value
    string

    ReferenceId

    ID of the document that is modified by the running of the business process. Used during the cancellation of the business process.

    Declaration
    [JsonProperty("referenceId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string ReferenceId { get; set; }
    Property Value
    string

    StartDate

    When the business process started.

    Declaration
    [JsonProperty("startDate", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime StartDate { get; set; }
    Property Value
    DateTime

    StateHistory

    List containing the history of all the state transitions of the business process.

    Declaration
    [JsonProperty("stateHistory", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<BusinessProcessState> StateHistory { get; set; }
    Property Value
    ICollection<BusinessProcessState>

    SupportsCancellation

    True if the business process execution can be cancelled. False otherwise.

    Declaration
    [JsonProperty("supportsCancellation", Required = Required.Always)]
    public bool SupportsCancellation { get; set; }
    Property Value
    bool

    Methods

    FromJson(string)

    Declaration
    public static BusinessProcess FromJson(string data)
    Parameters
    string data

    Returns
    BusinessProcess

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX