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

Interface WorkflowService

All Superinterfaces:

JAXRSService

@Path(value="workflows")
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
void	delete(String anyType, String key) Removes the workflow definition for matching any object type, under the provided key.
javax.ws.rs.core.Response	exportDiagram(String anyType, String key) Exports the workflow diagram representation (if available), for matching any object type and key.
javax.ws.rs.core.Response	get(String anyType, String key) Exports the workflow definition for matching any object type and key.
List<WorkflowDefinitionTO>	list(String anyType) Lists the available workflow definitions, for the given any object type.
void	set(String anyType, String key, String definition) Imports the workflow definition for matching any object type, under the provided key.

Method Detail

list

@GET
 @Path(value="{anyType}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<WorkflowDefinitionTO> list(@NotNull @PathParam(value="anyType")
                                                                                                                                           String anyType)

Lists the available workflow definitions, for the given any object type.

Parameters:

anyType - any object type

Returns:

available workflow definitions, for the given any object type

get

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

Exports the workflow definition for matching any object type and key.

Parameters:

anyType - any object type

key - workflow definition key

Returns:

workflow definition for matching any object type and key

exportDiagram

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

Exports the workflow diagram representation (if available), for matching any object type and key.

Parameters:

anyType - any object type

key - workflow definition key

Returns:

workflow diagram representation

set

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

Imports the workflow definition for matching any object type, under the provided key.

Parameters:

anyType - any object type

key - workflow definition key

definition - workflow definition for matching kind

delete

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

Removes the workflow definition for matching any object type, under the provided key.

Parameters:

anyType - any object type

key - workflow definition key