Package com.xebialabs.xlrelease.api.v1

Interface ApplicationApi

  • All Superinterfaces:
    ApiService
    @Path("/api/v1/applications")
@Consumes("application/json")
@Produces("application/json")
public interface ApplicationApi
extends ApiService

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      com.xebialabs.xlrelease.domain.environments.Application create​(com.xebialabs.xlrelease.domain.environments.Application application)
      Creates a new application.
      com.xebialabs.xlrelease.api.v1.views.ApplicationView createApplication​(com.xebialabs.xlrelease.api.v1.form.ApplicationForm applicationForm)  
      void deleteApplication​(java.lang.String applicationId)
      Deletes an application.
      com.xebialabs.xlrelease.api.v1.views.ApplicationView getApplication​(java.lang.String applicationId)  
      com.xebialabs.xlrelease.domain.environments.Application getById​(java.lang.String applicationId)
      Gets an application by id.
      java.util.List<com.xebialabs.xlrelease.domain.environments.Application> search​(com.xebialabs.xlrelease.api.v1.filter.ApplicationFilters filters)
      Searches applications by filters.
      java.util.List<com.xebialabs.xlrelease.api.v1.views.ApplicationView> searchApplications​(com.xebialabs.xlrelease.api.v1.filter.ApplicationFilters applicationFilters)  
      default java.lang.String serviceName()  
      com.xebialabs.xlrelease.domain.environments.Application update​(com.xebialabs.xlrelease.domain.environments.Application application)
      Updates an existing application.
      com.xebialabs.xlrelease.api.v1.views.ApplicationView updateApplication​(java.lang.String applicationId, com.xebialabs.xlrelease.api.v1.form.ApplicationForm applicationForm)  

    • Method Detail

      • serviceName

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

      • createApplication

        @POST
com.xebialabs.xlrelease.api.v1.views.ApplicationView createApplication​(com.xebialabs.xlrelease.api.v1.form.ApplicationForm applicationForm)

      • getApplication

        @GET
@Path("/{applicationId:.*/Application[^/]*}")
com.xebialabs.xlrelease.api.v1.views.ApplicationView getApplication​(@PathParam("applicationId")
                                                                    java.lang.String applicationId)

      • updateApplication

        @PUT
@Path("/{applicationId:.*/Application[^/]*}")
com.xebialabs.xlrelease.api.v1.views.ApplicationView updateApplication​(@PathParam("applicationId")
                                                                       java.lang.String applicationId,
                                                                       com.xebialabs.xlrelease.api.v1.form.ApplicationForm applicationForm)

      • searchApplications

        @POST
@Path("/search")
java.util.List<com.xebialabs.xlrelease.api.v1.views.ApplicationView> searchApplications​(com.xebialabs.xlrelease.api.v1.filter.ApplicationFilters applicationFilters)

      • deleteApplication

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

      • create

        com.xebialabs.xlrelease.domain.environments.Application create​(com.xebialabs.xlrelease.domain.environments.Application application)
        Creates a new application.
        Parameters:
        application - an Application object describing the new application
        Returns:
        created Application object

      • getById

        com.xebialabs.xlrelease.domain.environments.Application getById​(java.lang.String applicationId)
        Gets an application by id.
        Parameters:
        applicationId - the application identifier
        Returns:
        found Application object

      • update

        com.xebialabs.xlrelease.domain.environments.Application update​(com.xebialabs.xlrelease.domain.environments.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<com.xebialabs.xlrelease.domain.environments.Application> search​(com.xebialabs.xlrelease.api.v1.filter.ApplicationFilters filters)
        Searches applications by filters.
        Parameters:
        filters - an ApplicationFilters object describing the search criteria
        Returns:
        list of matching Applications