org.apache.syncope.common.rest.api.service

Interface BpmnProcessService

All Superinterfaces:

JAXRSService

@Path(value="flowable/bpmnProcesses")
public interface BpmnProcessService
extends JAXRSService

REST operations for BPMN processes.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
void	delete(@NotNull String key) Removes the BPMN process under the provided key.
javax.ws.rs.core.Response	exportDiagram(@NotNull String key) Exports the BPMN diagram representation (if available), for matching key.
javax.ws.rs.core.Response	get(@NotNull String key) Exports the BPMN process for matching key.
List<BpmnProcess>	list() Lists the available BPMN processes.
void	set(@NotNull String key, @NotNull String definition) Imports the BPMN process under the provided key.

Method Detail

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
List<BpmnProcess> list()

Lists the available BPMN processes.

Returns:

available BPMN processs

get

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/xml"})
javax.ws.rs.core.Response get(@NotNull @PathParam(value="key")
                                                                                                                  @NotNull String key)

Exports the BPMN process for matching key.

Parameters:

key - BPMN process key

Returns:

BPMN process for matching key

exportDiagram

@GET
 @Path(value="{key}/diagram.png")
 @Produces(value="image/png")
javax.ws.rs.core.Response exportDiagram(@NotNull @PathParam(value="key")
                                                                                                             @NotNull String key)

Exports the BPMN diagram representation (if available), for matching key.

Parameters:

key - BPMN process key

Returns:

BPMN diagram representation

set

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
void set(@NotNull @PathParam(value="key")
                                                                                                                                                      @NotNull String key,
                                                                                                                                                      @NotNull
                                                                                                                                                      @NotNull String definition)

Imports the BPMN process under the provided key.

Parameters:

key - BPMN process key

definition - BPMN process for matching kind

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                      @NotNull String key)

Removes the BPMN process under the provided key.

Parameters:

key - BPMN process key