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 Type	Method	Description
com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView	addManagedApplication(com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView managedApplication)	Saves a new managed application.
void	deleteManagedApplication(String managedApplicationId)	Deletes a managed application by id.
com.xebialabs.xlrelease.api.v1.views.ManagedApplicationPage	getManagedApplications(String folderId, Long page, Long resultsPerPage)	Gets all managed applications defined by pagination data.
default String	serviceName()
com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView	updateManagedApplication(com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView managedApplication)	Updates an existing managed application.

Method Details

serviceName

default String serviceName()

Specified by:

serviceName in interface ApiService

getManagedApplications

@GET
com.xebialabs.xlrelease.api.v1.views.ManagedApplicationPage getManagedApplications(@QueryParam("folderId")
 String folderId,
 @DefaultValue("0") @QueryParam("page")
 Long page,
 @DefaultValue("100") @QueryParam("resultsPerPage")
 Long resultsPerPage)

Gets all managed applications defined by pagination data.

Parameters:

folderId - Folder ID under which the managed applications are set

page - The number of the page

resultsPerPage - The number of results per page

Returns:

All managed application for given folder

addManagedApplication

@POST
com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView addManagedApplication(com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView managedApplication)

Saves a new managed application.

Parameters:

managedApplication - Managed application model

Returns:

Created instance of managed application formatted to a view

updateManagedApplication

@PUT
com.xebialabs.xlrelease.api.v1.views.ManagedApplicationView updateManagedApplication(com.xebialabs.xlrelease.api.v1.views.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")
 String managedApplicationId)

Deletes a managed application by id.

Parameters:

managedApplicationId - The managed application to delete