onadata.apps.api.viewsets.data_viewset module

Module contents

The /data API endpoint.

class onadata.apps.api.viewsets.data_viewset.AuthenticatedDataViewSet(**kwargs)

Bases: DataViewSet

Authenticated requests only.

permission_classes = (<class 'onadata.apps.api.permissions.ConnectViewsetPermissions'>,)

class onadata.apps.api.viewsets.data_viewset.DataViewSet(**kwargs)

Bases: AnonymousUserPublicFormsMixin, AuthenticateHeaderMixin, ETagsMixin, CacheControlMixin, DefaultBaseViewset, ModelViewSet

This endpoint provides access to submitted data.

data_count = None

destroy(request, *args, **kwargs)

Deletes submissions data.

enketo(request, *args, **kwargs)

Data Enketo URLs endpoint

extra_lookup_fields = None

filter_backends = (<class 'onadata.libs.filters.AnonDjangoObjectPermissionFilter'>, <class 'onadata.libs.filters.XFormOwnerFilter'>, <class 'onadata.libs.filters.DataFilter'>)

filter_queryset(queryset, view=None)

Returns and filters queryset based on context and query params.

get_object(queryset=None)

Returns the appropriate object based on context.

get_serializer_class()

Returns appropriate serializer class based on context.

history(request, *args, **kwargs)

Return submission history.

labels(request, *args, **kwargs)

Data labels API endpoint.

list(request, *args, **kwargs)

Returns list of data API endpoints for different forms.

lookup_field = 'pk'

lookup_fields = ('pk', 'dataid')

paginate_queryset(queryset)

Returns a paginated queryset.

pagination_class

alias of CountOverridablePageNumberPagination

permission_classes = (<class 'onadata.apps.api.permissions.XFormPermissions'>,)

public_data_endpoint = 'public'

queryset

renderer_classes = [<class 'rest_framework.renderers.JSONRenderer'>, <class 'rest_framework_jsonp.renderers.JSONPRenderer'>, <class 'rest_framework_csv.renderers.CSVRenderer'>, <class 'onadata.libs.renderers.renderers.XLSRenderer'>, <class 'onadata.libs.renderers.renderers.XLSXRenderer'>, <class 'onadata.libs.renderers.renderers.CSVRenderer'>, <class 'onadata.libs.renderers.renderers.CSVZIPRenderer'>, <class 'onadata.libs.renderers.renderers.SAVZIPRenderer'>, <class 'onadata.libs.renderers.renderers.InstanceXMLRenderer'>, <class 'onadata.libs.renderers.renderers.SurveyRenderer'>, <class 'onadata.libs.renderers.renderers.GeoJsonRenderer'>, <class 'onadata.libs.renderers.renderers.KMLRenderer'>, <class 'onadata.libs.renderers.renderers.OSMRenderer'>, <class 'onadata.libs.renderers.renderers.FLOIPRenderer'>]

retrieve(request, *args, **kwargs)

Returns API data for the targeted object.

serializer_class

alias of DataSerializer

set_object_list(query, fields, sort, start, limit, is_public_request)

Set the submission instances queryset.

onadata.apps.api.viewsets.data_viewset.delete_instance(instance, user)

Function that calls Instance.set_deleted and catches any exception that may occur.

Parameters:

• instance

• user

Returns:

onadata.apps.api.viewsets.data_viewset.get_data_and_form(kwargs)

Checks if the dataid in kwargs is a valid integer.