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
Modifier and TypeMethodDescriptionaddManagedApplication
(ManagedApplicationView managedApplication) Saves a new managed application.void
createManagedApplicationsFromWebhookSource
(String webhookSourceId, String folderId) Creates managed applications from external deployments webhook sourcevoid
deleteManagedApplication
(String managedApplicationId) Deletes a managed application by id.getManagedApplication
(String managedApplicationId) Gets managed application by its id.getManagedApplications
(String folderId, Long page, Long resultsPerPage, String condition) Gets all managed applications defined by pagination data.default String
updateManagedApplication
(ManagedApplicationView managedApplication) Updates an existing managed application.
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
getManagedApplications
@GET ManagedApplicationPage getManagedApplications(@QueryParam("folderId") String folderId, @DefaultValue("0") @QueryParam("page") Long page, @DefaultValue("100") @QueryParam("resultsPerPage") Long resultsPerPage, @DefaultValue("") @QueryParam("condition") String condition) 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 pagecondition
- Filtering condition- Returns:
- All managed application for given folder
-
getManagedApplication
@GET @Path("/{managedApplicationId}") ManagedApplicationView getManagedApplication(@PathParam("managedApplicationId") String managedApplicationId) Gets managed application by its id.- Parameters:
managedApplicationId
- Managed application id- Returns:
- Managed application (if found) formatted to a view
-
addManagedApplication
Saves a new managed application.- Parameters:
managedApplication
- Managed application model- Returns:
- Created instance of managed application formatted to a view
-
updateManagedApplication
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") String managedApplicationId) Deletes a managed application by id.- Parameters:
managedApplicationId
- The managed application to delete
-
createManagedApplicationsFromWebhookSource
@POST @Path("/create-from-webhook-source/{webhookSourceId:.*/Configuration[^/]*}") void createManagedApplicationsFromWebhookSource(@PathParam("webhookSourceId") String webhookSourceId, @QueryParam("folderId") String folderId) Creates managed applications from external deployments webhook source- Parameters:
webhookSourceId
- The webhook source id of created webhook sourcefolderId
- Folder ID under which the managed applications are set
-