dotnet/src/apis/IProcessModelConsumerApi.cs
/// <summary>
/// Starts an instance for a given ProcessDefinition. Process variables and correlation id may be supplied in the request payload.
/// </summary>
/// <returns>A set of informations about the started ProcessInstance; such as the used ProcessInstance ID or the assigned Correlation ID.</returns>
/// <param name="identity">The requesting users <see cref="EssentialProjects.IAM.Contracts.IIdentity">identity</see>. Should usually contain an auth token.</param>
/// <param name="processModelId">The ID of the ProcessDefinition to be retrieved.</param>
/// <param name="startEventId">The ID of a specific StartEvent to start the process with.</param>
/// <param name="processStartRequestPayload">The payload for the Start request. Contains variables for the ProcessInstance and optionally a CorrelationId.</param>
/// <param name="callbackType"><see cref="StartCallbackType">Callback type</see></param>
/// <param name="endEventId">The ID of the end event to wait for, when callbackType == StartCallbackType.CallbackOnEndEventReached.</param>
Starts an instance for a given ProcessDefinition. Process variables and correlation id may be supplied in the request payload.
Starts an instance for a given ProcessDefinition . Process variables and correlation id may be supplied in the request payload .
Task<ProcessStartResponsePayload> StartProcessInstance<TInputValues>(
            IIdentity identity,
            string processModelId,
            string startEventId,
            ProcessStartRequestPayload<TInputValues> processStartRequestPayload,
            StartCallbackType callbackType = StartCallbackType.CallbackOnProcessInstanceCreated,
            string endEventId = "")
        where TInputValues : new();
Task < ProcessStartResponsePayload > StartProcessInstance < TInputValues > ( IIdentity identity , string processModelId , string startEventId , ProcessStartRequestPayload < TInputValues > processStartRequestPayload , StartCallbackType callbackType = StartCallbackType . CallbackOnProcessInstanceCreated , string endEventId = " " ) where TInputValues : new ( ) ;
Starts an instance for a given ProcessDefinition.
Starts an instance for a given ProcessDefinition .
A set of informations about the started ProcessInstance; such as the used ProcessInstance ID or the assigned Correlation ID.
A set of informations about the started ProcessInstance ; such as the used ProcessInstance ID or the assigned Correlation ID .
identity
IIdentity
The requesting users identity
The requesting users identity
processModelId
string
The ID of the ProcessDefinition to be retrieved.
The ID of the ProcessDefinition to be retrieved .
startEventId
string
The ID of a specific StartEvent to start the process with.
The ID of a specific StartEvent to start the process with .
processStartRequestPayload
ProcessStartRequestPayload<TInputValues>
The payload for the Start request. Contains variables for the ProcessInstance and optionally a CorrelationId.
The payload for the Start request . Contains variables for the ProcessInstance and optionally a CorrelationId .
callbackType
StartCallbackType
None
endEventId
string
The ID of the end event to wait for, when callbackType == StartCallbackType.CallbackOnEndEventReached.
The ID of the end event to wait for when callbackType == StartCallbackType . CallbackOnEndEventReached .