Interface BpmnProcessService
- All Superinterfaces:
JAXRSService
- All Known Implementing Classes:
BpmnProcessServiceImpl
REST operations for BPMN processes.
-
Field Summary
Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Removes the BPMN process under the provided key.exportDiagram
(@NotNull String key) Exports the BPMN diagram representation (if available), for matching key.Exports the BPMN process for matching key.list()
Lists the available BPMN processes.void
Imports the BPMN process under the provided key.
-
Method Details
-
list
Lists the available BPMN processes.- Returns:
- available BPMN processs
-
get
@GET @Path("{key}") @Produces({"application/json","application/xml"}) Response get(@NotNull @PathParam("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("{key}/diagram.png") @Produces("image/png") Response exportDiagram(@NotNull @PathParam("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("{key}") @Consumes({"application/json","application/xml"}) @Produces({"application/json","application/xml"}) void set(@NotNull @PathParam("key") @NotNull String key, @NotNull @NotNull String definition) Imports the BPMN process under the provided key.- Parameters:
key
- BPMN process keydefinition
- BPMN process for matching kind
-
delete
@DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key) Removes the BPMN process under the provided key.- Parameters:
key
- BPMN process key
-