Interface ApplicationApi

  • All Superinterfaces:
    ApiService

    @Path("/api/v1/applications")
    @Consumes("application/json")
    @Produces("application/json")
    public interface ApplicationApi
    extends ApiService
    • Method Detail

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService
      • getApplication

        @GET
        @Path("/{applicationId:.*/Application[^/]*}")
        ApplicationView getApplication​(@PathParam("applicationId")
                                       java.lang.String applicationId)
      • updateApplication

        @PUT
        @Path("/{applicationId:.*/Application[^/]*}")
        ApplicationView updateApplication​(@PathParam("applicationId")
                                          java.lang.String applicationId,
                                          ApplicationForm applicationForm)
      • deleteApplication

        @DELETE
        @Path("/{applicationId:.*/Application[^/]*}")
        void deleteApplication​(@PathParam("applicationId")
                               java.lang.String applicationId)
        Deletes an application.
        Parameters:
        applicationId - the application identifier
      • create

        Application create​(Application application)
        Creates a new application.
        Parameters:
        application - an Application object describing the new application
        Returns:
        created Application object
      • getById

        Application getById​(java.lang.String applicationId)
        Gets an application by id.
        Parameters:
        applicationId - the application identifier
        Returns:
        found Application object
      • update

        Application update​(Application application)
        Updates an existing application.
        Parameters:
        application - an Application object describing the new properties of the application
        Returns:
        updated Application object
      • search

        java.util.List<Application> search​(ApplicationFilters filters)
        Searches applications by filters.
        Parameters:
        filters - an ApplicationFilters object describing the search criteria
        Returns:
        list of matching Applications