CommandApi - functional programming interface

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        commandControllerCreate(
            commandCreateDTO?: CommandCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputDTOAPI>,
        >;
        commandControllerCreateArgument(
            commandArgumentCreateDTO?: CommandArgumentCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandArgumentDTOAPI>,
        >;
        commandControllerGetExecutions(
            id: string,
            success?: any,
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputArrayDTOAPI>,
        >;
        commandControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputDTOAPI>,
        >;
        commandControllerRemove(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
        >;
        commandControllerRemoveArgument(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
        >;
        commandControllerSearch(
            commandSearchInputDTO?: CommandSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputArrayDTOAPI>,
        >;
        commandControllerTrigger(
            id: string,
            commandTriggerDTO?: CommandTriggerDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        commandControllerUpdate(
            id: string,
            commandUpdateDTO?: CommandUpdateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputDTOAPI>,
        >;
        commandControllerUpdateArgument(
            id: string,
            commandArgumentUpdateDTO?: CommandArgumentUpdateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandArgumentDTOAPI>,
        >;
    }

    • commandControllerCreate:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerCreate

        Parameters

        • OptionalcommandCreateDTO: CommandCreateDTO

          CommandCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputDTOAPI>,
        >

    • commandControllerCreateArgument:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerCreateArgument

        Parameters

        • OptionalcommandArgumentCreateDTO: CommandArgumentCreateDTO

          CommandArgumentCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandArgumentDTOAPI>,
        >

    • commandControllerGetExecutions:function
      • Required permissions: READ_MODULES
        OperationId: CommandControllerGetExecutions

        Parameters

        • id: string
        • Optionalsuccess: any
        • OptionaleventSearchInputDTO: EventSearchInputDTO

          EventSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputArrayDTOAPI>,
        >

    • commandControllerGetOne:function
      • Required permissions: READ_MODULES
        OperationId: CommandControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputDTOAPI>,
        >

    • commandControllerRemove:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerRemove

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>

    • commandControllerRemoveArgument:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerRemoveArgument

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>

    • commandControllerSearch:function
      • Required permissions: READ_MODULES
        OperationId: CommandControllerSearch

        Parameters

        • OptionalcommandSearchInputDTO: CommandSearchInputDTO

          CommandSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputArrayDTOAPI>,
        >

    • commandControllerTrigger:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerTrigger

        Parameters

        • id: string
        • OptionalcommandTriggerDTO: CommandTriggerDTO

          CommandTriggerDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    • commandControllerUpdate:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerUpdate

        Parameters

        • id: string
        • OptionalcommandUpdateDTO: CommandUpdateDTO

          CommandUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandOutputDTOAPI>,
        >

    • commandControllerUpdateArgument:function
      • Required permissions: MANAGE_MODULES
        OperationId: CommandControllerUpdateArgument

        Parameters

        • id: string
        • OptionalcommandArgumentUpdateDTO: CommandArgumentUpdateDTO

          CommandArgumentUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CommandArgumentDTOAPI>,
        >