/** * @swagger * components: * schemas: * StartCallbackType: * description: The type of callback to use for a ProcessInstance start. * type: integer * oneOf: * - title: CallbackOnProcessInstanceCreated * const: 1 * description: The Engine will resolve immediately after the ProcessInstance was started. * - title: CallbackOnProcessInstanceFinished * const: 2 * description: The Engine will resolve after the first EndEvent was reached. * - title: CallbackOnEndEventReached * const: 3 * description: The Engine will resolve after a specific EndEvent was reached. */ /** * Determines when the Engine will resolve after a new ProcessInstance was started. */ export declare enum StartCallbackType { /** * The Engine will resolve immediately after the ProcessInstance was started. */ CallbackOnProcessInstanceCreated = 1, /** * The Engine will resolve after the first EndEvent was reached. */ CallbackOnProcessInstanceFinished = 2, /** * The Engine will resolve after a specific EndEvent was reached. */ CallbackOnEndEventReached = 3 } /** * @swagger * components: * schemas: * ProcessStartOptions: * description: The options to use for starting a ProcessInstance. * type: object * required: * - processModelId * properties: * processModelId: * description: The ID of the ProcessModel to start. * type: string * startEventId: * description: The ID of a StartEvent at which the ProcessInstance should start. * type: string * correlationId: * description: A correlation ID to use for the ProcessInstance. * type: string * initialToken: * description: The token to use for an initial ProcessToken. * type: object */ /** * Contains configurable options for starting a ProcessInstance with a client interface. */ export declare type ProcessStartOptions> = { /** * The ID of the ProcessModel to start. */ processModelId: string; /** * The ID of a StartEvent at which the ProcessInstance should start. * Must be provided, if the ProcessModel has multiple StartEvents, * but is optional, if the ProcessModel only has one. */ startEventId?: string; /** * The ID of a correlation to which the ProcessInstance should belong. * Default is an auto-generated uuid. */ correlationId?: string; /** * A set of values to use for an initial ProcessToken. */ initialToken?: TToken; }; /** * @swagger * components: * schemas: * ProcessStartRequest: * description: The request object to use for starting a ProcessInstance. * allOf: * - $ref: '#/components/schemas/ProcessStartOptions' * - type: object * properties: * returnOn: * description: | * Determines when the Engine will resolve, after a new request for starting a ProcessInstance was made. * Note: If "CallbackOnEndEventReached" is selected, "endEventId" is no longer optional! * $ref: '#/components/schemas/StartCallbackType' * endEventId: * description: The ID of an EndEvent that should be awaited. Must be provided, of "returnOn" is set to "CallbackOnEndEventReached". * type: string */ /** * Contains configurable options for starting a ProcessInstance. */ export declare type ProcessStartRequest> = ProcessStartOptions & { /** * Determines when the Engine will resolve, after a new request for starting a ProcessInstance was made. * * Note: * If "CallbackOnEndEventReached" is selected, "endEventId" is no longer optional! */ returnOn?: StartCallbackType; /** * The ID of an EndEvent that should be awaited. * Must be provided, of "returnOn" is set to "CallbackOnEndEventReached". */ endEventId?: string; };