menu

Views

Actions

class viewflow.rest.views.actions.BaseTaskActionView(**kwargs)

finalize_response(request, response, *args, **kwargs)

Returns the final response object.

get_serializer(*args, **kwargs)

Return the serializer instance that should be used for validation/deserialization input, and output serialization .

get_serializer_context()

Extra context provided to the action input serializer.

initial(request, *args, **kwargs)

Runs anything that needs to occur prior to calling the method handler.

class viewflow.rest.views.actions.ActivateNextTaskView(**kwargs)

class viewflow.rest.views.actions.AssignTaskView(**kwargs)

Assign task to the current user

class viewflow.rest.views.actions.CancelTaskView(**kwargs)

class viewflow.rest.views.actions.PerformTaskView(**kwargs)

class viewflow.rest.views.actions.UnassignTaskView(**kwargs)

class viewflow.rest.views.actions.UndoTaskView(**kwargs)

Detail

class viewflow.rest.views.detail.DetailFlowView(**kwargs)

class viewflow.rest.views.detail.DetailTaskView(**kwargs)

get_object()

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_context()

Extra context provided to the serializer class.

initial(request, *args, **kwargs)

Runs anything that needs to occur prior to calling the method handler.

serializer_class

alias of viewflow.rest.serializers.TaskListSerializer

class viewflow.rest.views.detail.DetailSubprocessView(**kwargs)

serializer_class

alias of viewflow.rest.serializers.SubprocessTaskSerializer

class viewflow.rest.views.detail.DetailProcessView(**kwargs)

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer(*args, **kwargs)

Return the serializer instance that should be used for validating and deserializing input, and for serializing output.

get_serializer_class()

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

get_serializer_context()

Extra context provided to the serializer class.

List

class viewflow.rest.views.list.FlowListView(*args, **kwargs)

class viewflow.rest.views.list.AllProcessListView(*args, **kwargs)

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

serializer_class

alias of viewflow.rest.serializers.ProcessSerializer

class viewflow.rest.views.list.AllTaskListView(*args, **kwargs)

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

serializer_class

alias of viewflow.rest.serializers.TaskListSerializer

class viewflow.rest.views.list.ProcessListView(**kwargs)

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_class()

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

get_serializer_context()

Extra context provided to the serializer class.

class viewflow.rest.views.list.TaskListView(**kwargs)

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_context()

Extra context provided to the serializer class.

serializer_class

alias of viewflow.rest.serializers.TaskListSerializer

Schema

class viewflow.rest.views.chart.FlowChartView(**kwargs)

class viewflow.rest.views.schema.SchemaView(*args, **kwargs)

schema_generator_class

alias of viewflow.rest.schemas.SchemaGenerator

Start

class viewflow.rest.views.start.BaseStartFlowView(**kwargs)

Base class for generic start views

get_serializer_context()

Extra context provided to the action input serializer.

class viewflow.rest.views.start.CreateProcessView(**kwargs)

Task

class viewflow.rest.views.task.BaseFlowView(**kwargs)

Base class for generic flow views

get_serializer_context()

Extra context provided to the action input serializer.

class viewflow.rest.views.task.UpdateProcessView(**kwargs)

Mixins

class viewflow.rest.views.mixins.FlowListMixin(*args, **kwargs)

Mixin for list views that contains multiple flows

class viewflow.rest.views.mixins.FlowViewPermissionMixin

Mixin for flow views, check the view permission.

class viewflow.rest.views.mixins.TaskActivationMixin

class viewflow.rest.views.mixins.TaskResponseMixin

Mixin for Flow Views with task instance in response

class viewflow.rest.views.mixins.ProcessViewMixin

class viewflow.rest.views.mixins.StartActivationMixin

Mixin for flow start views. Instantiate self.activation instance

class viewflow.rest.views.mixins.StartActivationMixin

Mixin for flow start views. Instantiate self.activation instance