Function ScheduledTasksApiAxiosParamCreator

ScheduledTasksApi - axios parameter creator

Export

  • ScheduledTasksApiAxiosParamCreator(configuration?): {
        getTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTasks: ((isHidden?: boolean, isEnabled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        startTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        stopTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateTask: ((taskId: string, taskTriggerInfo: TaskTriggerInfo[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTasks: ((isHidden?: boolean, isEnabled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        startTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        stopTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateTask: ((taskId: string, taskTriggerInfo: TaskTriggerInfo[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get task by id.

      Throws

        • (taskId, options?): Promise<RequestArgs>

        • Parameters

          • taskId: string

            Task Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getTasks: ((isHidden?: boolean, isEnabled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get tasks.

      Throws

        • (isHidden?, isEnabled?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalisHidden: boolean

            Optional filter tasks that are hidden, or not.

          • OptionalisEnabled: boolean

            Optional filter tasks that are enabled, or not.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • startTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Start specified task.

      Throws

        • (taskId, options?): Promise<RequestArgs>

        • Parameters

          • taskId: string

            Task Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • stopTask: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Stop specified task.

      Throws

        • (taskId, options?): Promise<RequestArgs>

        • Parameters

          • taskId: string

            Task Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateTask: ((taskId: string, taskTriggerInfo: TaskTriggerInfo[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Update specified task triggers.

      Throws

        • (taskId, taskTriggerInfo, options?): Promise<RequestArgs>

        • Parameters

          • taskId: string

            Task Id.

          • taskTriggerInfo: TaskTriggerInfo[]

            Triggers.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility