Package com.xebialabs.xlrelease.api.internal

Interface ExternalDeploymentApi

All Superinterfaces:

com.xebialabs.xlrelease.api.ApiService

@Path("/external-deployment")
@Consumes("application/json")
@Produces("application/json")
public interface ExternalDeploymentApi
extends com.xebialabs.xlrelease.api.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
void	deleteWebhook(String webhookSourceId)
ExternalDeploymentView	getExternalDeployments(String folderId, Long maxAge, Long page, Long resultsPerPage, ExternalDeploymentOrderMode orderBy, ExternalDeploymentOrderDirection direction, String condition)
WebhookSourceFiltersView	getWebhookSourceFilters(String webhookSourceId)
void	patchExternalDeployments(String webhookSourceId)
com.xebialabs.xlrelease.status.webhook.events.StatusWebhookEventSource	saveWebhookSourceFilters(String webhookSourceId, List<String> filteredFolders)
default String	serviceName()
WebhookBasicSetupView	setupApplicationStatusWebhook(String serverId, String folderId)

Method Details

serviceName

default String serviceName()

Specified by:

serviceName in interface com.xebialabs.xlrelease.api.ApiService

getExternalDeployments

@GET
ExternalDeploymentView getExternalDeployments(@QueryParam("folderId")
 String folderId,
 @DefaultValue("0") @QueryParam("max-age")
 Long maxAge,
 @DefaultValue("0") @QueryParam("page")
 Long page,
 @DefaultValue("100") @QueryParam("resultsPerPage")
 Long resultsPerPage,
 @DefaultValue("STATUS") @QueryParam("orderBy")
 ExternalDeploymentOrderMode orderBy,
 @DefaultValue("ASC") @QueryParam("order")
 ExternalDeploymentOrderDirection direction,
 @DefaultValue("") @QueryParam("condition")
 String condition)

getWebhookSourceFilters

@GET
@Path("/filters/{webhookSourceId:.*/Configuration[^/]*}")
WebhookSourceFiltersView getWebhookSourceFilters(@PathParam("webhookSourceId")
 String webhookSourceId)

saveWebhookSourceFilters

@PUT
@Path("/filters/{webhookSourceId:.*/Configuration[^/]*}")
com.xebialabs.xlrelease.status.webhook.events.StatusWebhookEventSource saveWebhookSourceFilters(@PathParam("webhookSourceId")
 String webhookSourceId,
 List<String> filteredFolders)

setupApplicationStatusWebhook

@POST
@Path("/setup/{serverId:.*/Configuration[^/]*}")
WebhookBasicSetupView setupApplicationStatusWebhook(@PathParam("serverId")
 String serverId,
 @QueryParam("folderId")
 String folderId)

deleteWebhook

@DELETE
@Path("/delete/{webhookSourceId:.*/Configuration[^/]*}")
void deleteWebhook(@PathParam("webhookSourceId")
 String webhookSourceId)

patchExternalDeployments

@POST
@Path("/patch/{webhookSourceId:.*/Configuration[^/]*}")
void patchExternalDeployments(@PathParam("webhookSourceId")
 String webhookSourceId)