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
-
-
Field Summary
-
Fields inherited from interface com.xebialabs.xlrelease.api.ApiService
DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Applicationcreate(Application application)Creates a new application.ApplicationViewcreateApplication(ApplicationForm applicationForm)voiddeleteApplication(java.lang.String applicationId)Deletes an application.ApplicationViewgetApplication(java.lang.String applicationId)ApplicationgetById(java.lang.String applicationId)Gets an application by id.java.util.List<Application>search(ApplicationFilters filters)Searches applications by filters.java.util.List<ApplicationView>searchApplications(ApplicationFilters applicationFilters)default java.lang.StringserviceName()Applicationupdate(Application application)Updates an existing application.ApplicationViewupdateApplication(java.lang.String applicationId, ApplicationForm applicationForm)
-
-
-
Method Detail
-
serviceName
default java.lang.String serviceName()
- Specified by:
serviceNamein interfaceApiService
-
createApplication
@POST ApplicationView createApplication(ApplicationForm applicationForm)
-
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)
-
searchApplications
@POST @Path("/search") java.util.List<ApplicationView> searchApplications(ApplicationFilters applicationFilters)
-
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- anApplicationobject describing the new application- Returns:
- created
Applicationobject
-
getById
Application getById(java.lang.String applicationId)
Gets an application by id.- Parameters:
applicationId- the application identifier- Returns:
- found
Applicationobject
-
update
Application update(Application application)
Updates an existing application.- Parameters:
application- anApplicationobject describing the new properties of the application- Returns:
- updated
Applicationobject
-
search
java.util.List<Application> search(ApplicationFilters filters)
Searches applications by filters.- Parameters:
filters- anApplicationFiltersobject describing the search criteria- Returns:
- list of matching
Applications
-
-