Package com.atlassian.confluence.plugins.restapi.resources

Class GlobalWebhooksResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.GlobalWebhooksResource

@Consumes("application/json")
@Produces("application/json")
@Path("/webhooks")
public class GlobalWebhooksResource
extends Object

Constructor Summary

Constructors

Constructor	Description
GlobalWebhooksResource(com.atlassian.sal.api.message.I18nResolver i18nResolver, com.atlassian.sal.api.permission.PermissionEnforcer permissionEnforcer, OptionalServiceProvider optionalServiceProvider, ConfluenceScopesRequestCache scopesRequestCache)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createWebhook(javax.ws.rs.core.UriInfo uriInfo, com.atlassian.webhooks.internal.rest.RestWebhook webhook)
javax.ws.rs.core.Response	deleteWebhook(int webhookId)
javax.ws.rs.core.Response	findWebhooks(javax.ws.rs.core.UriInfo uriInfo, List<String> events, boolean statistics, int start, int limit)
javax.ws.rs.core.Response	getLatestInvocation(int webhookId, String eventId, Set<String> outcomes)
javax.ws.rs.core.Response	getStatistics(int webhookId, String eventId)
javax.ws.rs.core.Response	getStatisticsSummary(int webhookId)
javax.ws.rs.core.Response	getWebhook(int webhookId, boolean statistics)
javax.ws.rs.core.Response	testWebhook(String url)
javax.ws.rs.core.Response	updateWebhook(int webhookId, com.atlassian.webhooks.internal.rest.RestWebhook webhook)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GlobalWebhooksResource

@Inject
public GlobalWebhooksResource(com.atlassian.sal.api.message.I18nResolver i18nResolver,
 com.atlassian.sal.api.permission.PermissionEnforcer permissionEnforcer,
 OptionalServiceProvider optionalServiceProvider,
 ConfluenceScopesRequestCache scopesRequestCache)

Method Details

createWebhook

@POST
public javax.ws.rs.core.Response createWebhook(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 com.atlassian.webhooks.internal.rest.RestWebhook webhook)
                                        throws ContentTooLongException

Throws:

ContentTooLongException

deleteWebhook

@DELETE
@Path("/{webhookId}")
public javax.ws.rs.core.Response deleteWebhook(@PathParam("webhookId")
 int webhookId)

findWebhooks

@GET
public javax.ws.rs.core.Response findWebhooks(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @QueryParam("event")
 List<String> events,
 @QueryParam("statistics") @DefaultValue("false")
 boolean statistics,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit)

getLatestInvocation

@GET
@Path("/{webhookId}/latest")
public javax.ws.rs.core.Response getLatestInvocation(@PathParam("webhookId")
 int webhookId,
 @QueryParam("event")
 String eventId,
 @QueryParam("outcome")
 Set<String> outcomes)

getStatistics

@GET
@Path("/{webhookId}/statistics")
public javax.ws.rs.core.Response getStatistics(@PathParam("webhookId")
 int webhookId,
 @QueryParam("event")
 String eventId)

getStatisticsSummary

@GET
@Path("/{webhookId}/statistics/summary")
public javax.ws.rs.core.Response getStatisticsSummary(@PathParam("webhookId")
 int webhookId)

getWebhook

@GET
@Path("/{webhookId}")
public javax.ws.rs.core.Response getWebhook(@PathParam("webhookId")
 int webhookId,
 @QueryParam("statistics") @DefaultValue("false")
 boolean statistics)

testWebhook

@POST
@Path("/test")
public javax.ws.rs.core.Response testWebhook(@QueryParam("url")
 String url)
                                      throws ContentTooLongException

Throws:

ContentTooLongException

updateWebhook

@PUT
@Path("/{webhookId}")
public javax.ws.rs.core.Response updateWebhook(@PathParam("webhookId")
 int webhookId,
 com.atlassian.webhooks.internal.rest.RestWebhook webhook)
                                        throws ContentTooLongException

Throws:

ContentTooLongException