Function startTask

  • Triggers an immediate run of the specified task outside its normal schedule. The optional source parameter identifies what initiated the run, which is recorded in the run history for auditing purposes.

    Parameters

    • id: string

      The unique identifier of the task to start.

    • query: { source?: string }

      an object with query parameters

      • Optionalsource?: string

        The origin of the trigger. Defaults to manual. For event-triggered tasks, this can be the name of the triggering task.

    • Optionaloptions: ApiCallOptions

    Returns Promise<tasks.StartTaskHttpResponse>

    StartTaskHttpError