@camunda8/sdk
    Preparing search index...

    Interface ThrowErrorRequest

    interface ThrowErrorRequest {
        errorCode: string;
        errorMessage?: string;
        jobKey: string;
        variables?: JSONDoc;
    }
    Index

    Properties

    errorCode: string

    the error code that will be matched with an error catch event

    errorMessage?: string

    an optional error message that provides additional context

    jobKey: string

    the unique job identifier, as obtained when activating the job

    variables?: JSONDoc

    JSON document that will instantiate the variables at the local scope of the error catch event that catches the thrown error; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.