Variable ProjectApiConst

ProjectApi: {
    apiV2ProjectsOptions(options?): AxiosPromise<void>;
    createProject(requestParameters?, options?): AxiosPromise<ProjectDtoResponse>;
    deleteProject(requestParameters, options?): AxiosPromise<void>;
    getProject(requestParameters, options?): AxiosPromise<ProjectDtoResponse>;
    getProjects(requestParameters?, options?): AxiosPromise<ProjectDtoPagedResponse>;
    updateProject(requestParameters, options?): AxiosPromise<void>;
} = apis.ProjectApi

Type declaration

  • apiV2ProjectsOptions:function
    • Parameters

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Responds with the HTTP methods allowed for the endpoint.

      Throws

  • createProject:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectApiCreateProjectRequest = {}

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectDtoResponse>

      Summary

      Creates a new project.

      Throws

  • deleteProject:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectApiDeleteProjectRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Deletes a project.

      Throws

  • getProject:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectApiGetProjectRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectDtoResponse>

      Summary

      Retrieves a project.

      Throws

  • getProjects:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectApiGetProjectsRequest = {}

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectDtoPagedResponse>

      Summary

      Retrieves all projects.

      Throws

  • updateProject:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectApiUpdateProjectRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Updates a project.

      Throws

Generated using TypeDoc