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

Interface WorkflowService

All Superinterfaces:

JAXRSService

@Path(value="workflows/{anyTypeKind}")
public interface WorkflowService
extends JAXRSService

REST operations for workflow definition.

Field Summary

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

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportDefinition(AnyTypeKind anyTypeKind) Exports workflow definition for matching kind.
javax.ws.rs.core.Response	exportDiagram(AnyTypeKind anyTypeKind) Exports workflow diagram representation.
void	importDefinition(AnyTypeKind anyTypeKind, String definition) Imports workflow definition for matching kind.

Method Detail

exportDefinition

@GET
 @Produces(value={"application/json","application/xml"})
javax.ws.rs.core.Response exportDefinition(@NotNull @PathParam(value="anyTypeKind")
                                                                                                         AnyTypeKind anyTypeKind)

Exports workflow definition for matching kind.

Parameters:

anyTypeKind - any object type

Returns:

workflow definition for matching kind

exportDiagram

@GET
 @Path(value="diagram.png")
 @Produces(value="image/png")
javax.ws.rs.core.Response exportDiagram(@NotNull @PathParam(value="anyTypeKind")
                                                                                                       AnyTypeKind anyTypeKind)

Exports workflow diagram representation.

Parameters:

anyTypeKind - any object type

Returns:

workflow diagram representation

importDefinition

@PUT
 @Consumes(value={"application/json","application/xml"})
void importDefinition(@NotNull @PathParam(value="anyTypeKind")
                                                                                    AnyTypeKind anyTypeKind,
                                                                                    @NotNull
                                                                                    String definition)

Imports workflow definition for matching kind.

Parameters:

anyTypeKind - any object type

definition - workflow definition for matching kind