Package com.xebialabs.xlrelease.api.v1
Interface ManagedApplicationApi
-
- All Superinterfaces:
ApiService
@Path("/api/v1/managed-application") @Consumes("application/json") @Produces("application/json") public interface ManagedApplicationApi 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 ManagedApplicationView
addManagedApplication(ManagedApplicationView managedApplication)
Saves a new managed application.void
deleteManagedApplication(java.lang.String managedApplicationId)
Deletes a managed application by id.ManagedApplicationPage
getManagedApplications(java.lang.String folderId, java.lang.Long page, java.lang.Long resultsPerPage)
Gets all managed applications defined by pagination data.default java.lang.String
serviceName()
ManagedApplicationView
updateManagedApplication(ManagedApplicationView managedApplication)
Updates an existing managed application.
-
-
-
Method Detail
-
serviceName
default java.lang.String serviceName()
- Specified by:
serviceName
in interfaceApiService
-
getManagedApplications
@GET ManagedApplicationPage getManagedApplications(@QueryParam("folderId") java.lang.String folderId, @DefaultValue("0") @QueryParam("page") java.lang.Long page, @DefaultValue("100") @QueryParam("resultsPerPage") java.lang.Long resultsPerPage)
Gets all managed applications defined by pagination data.- Parameters:
folderId
- Folder ID under which the managed applications are setpage
- The number of the pageresultsPerPage
- The number of results per page- Returns:
- All managed application for given folder
-
addManagedApplication
@POST ManagedApplicationView addManagedApplication(ManagedApplicationView managedApplication)
Saves a new managed application.- Parameters:
managedApplication
- Managed application model- Returns:
- Created instance of managed application formatted to a view
-
updateManagedApplication
@PUT ManagedApplicationView updateManagedApplication(ManagedApplicationView managedApplication)
Updates an existing managed application.- Parameters:
managedApplication
- Managed application model to update- Returns:
- Updated managed application model
-
deleteManagedApplication
@DELETE @Path("/{managedApplicationId}") void deleteManagedApplication(@PathParam("managedApplicationId") java.lang.String managedApplicationId)
Deletes a managed application by id.- Parameters:
managedApplicationId
- The managed application to delete
-
-