onadata.apps.restservice package

Subpackages

• onadata.apps.restservice.management package
  • Subpackages
    • onadata.apps.restservice.management.commands package
      • Submodules
      • onadata.apps.restservice.management.commands.textit_v1_to_v2 module
      • Module contents
  • Module contents
• onadata.apps.restservice.migrations package
  • Submodules
  • onadata.apps.restservice.migrations.0001_initial module
    • Migration
      • Migration.dependencies
      • Migration.operations
  • onadata.apps.restservice.migrations.0002_auto_20160524_0458 module
    • Migration
      • Migration.dependencies
      • Migration.operations
  • onadata.apps.restservice.migrations.0003_restservice_active module
    • Migration
      • Migration.dependencies
      • Migration.operations
  • onadata.apps.restservice.migrations.0004_restservice_inactive_reason module
    • Migration
      • Migration.dependencies
      • Migration.operations
  • onadata.apps.restservice.migrations.0005_auto_20190125_0517 module
    • Migration
      • Migration.dependencies
      • Migration.operations
  • Module contents
• onadata.apps.restservice.services package
  • Submodules
  • onadata.apps.restservice.services.f2dhis2 module
    • ServiceDefinition
      • ServiceDefinition.id
      • ServiceDefinition.send()
      • ServiceDefinition.verbose_name
  • onadata.apps.restservice.services.generic_json module
    • ServiceDefinition
      • ServiceDefinition.id
      • ServiceDefinition.send()
      • ServiceDefinition.verbose_name
  • onadata.apps.restservice.services.generic_xml module
    • ServiceDefinition
      • ServiceDefinition.id
      • ServiceDefinition.send()
      • ServiceDefinition.verbose_name
  • onadata.apps.restservice.services.textit module
    • ServiceDefinition
      • ServiceDefinition.clean_keys_of_slashes()
      • ServiceDefinition.id
      • ServiceDefinition.send()
      • ServiceDefinition.verbose_name
  • Module contents
• onadata.apps.restservice.tests package
  • Subpackages
    • onadata.apps.restservice.tests.viewsets package
      • Submodules
      • onadata.apps.restservice.tests.viewsets.test_restservicesviewset module
      • Module contents
  • Submodules
  • onadata.apps.restservice.tests.test_restservice module
    • RestServiceTest
      • RestServiceTest.add_rest_service_with_username_and_id_string_in_uppercase()
      • RestServiceTest.setUp()
      • RestServiceTest.test_add_rest_service_with_wrong_id_string()
      • RestServiceTest.test_add_service()
      • RestServiceTest.test_anon_service_view()
      • RestServiceTest.test_clean_keys_of_slashes()
      • RestServiceTest.test_create_rest_service()
      • RestServiceTest.test_delete_service()
      • RestServiceTest.test_rest_service_not_set()
      • RestServiceTest.test_service_definition()
      • RestServiceTest.test_textit_service()
      • RestServiceTest.wait()
  • Module contents
• onadata.apps.restservice.viewsets package
  • Submodules
  • onadata.apps.restservice.viewsets.restservices_viewset module
    • RestServicesViewSet
      • RestServicesViewSet.basename
      • RestServicesViewSet.description
      • RestServicesViewSet.detail
      • RestServicesViewSet.filter_backends
      • RestServicesViewSet.get_serializer_class()
      • RestServicesViewSet.name
      • RestServicesViewSet.permission_classes
      • RestServicesViewSet.queryset
      • RestServicesViewSet.retrieve()
      • RestServicesViewSet.serializer_class
      • RestServicesViewSet.suffix
    • get_serializer_class()
  • Module contents

Submodules

onadata.apps.restservice.forms module

restservice forms.

class onadata.apps.restservice.forms.RestServiceForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None)

Bases: Form

RestService form class.

base_fields = {'service_name': <django.forms.fields.CharField object>, 'service_url': <django.forms.fields.URLField object>}

declared_fields = {'service_name': <django.forms.fields.CharField object>, 'service_url': <django.forms.fields.URLField object>}

property media

Return all media required to render the widgets on this form.

onadata.apps.restservice.interface module

Base class.

class onadata.apps.restservice.interface.RestServiceInterface

Bases: object

RestServiceInterface base class.

send(url, data=None)

The class method to implement when sending data.

onadata.apps.restservice.models module

RestService model

class onadata.apps.restservice.models.RestService(*args, **kwargs)

Bases: Model

Properties for an external service.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

active

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_created

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_modified

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_name_display(*, field=<django.db.models.fields.CharField: name>)

get_service_definition()

Returns ServiceDefinition class

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

inactive_reason

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property long_name

Service verbose name.

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

service_url

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

xform

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

xform_id

onadata.apps.restservice.models.delete_merged_datasets_service(sender, instance, **kwargs)

Delete the service to the individual forms of a merged dataset.

onadata.apps.restservice.models.delete_metadata(sender, instance, **kwargs)

Delete related metadata on deletion of the RestService.

onadata.apps.restservice.models.propagate_merged_datasets(sender, instance, **kwargs)

Propagate the service to the individual forms of a merged dataset.

onadata.apps.restservice.signals module

RestService signals module

onadata.apps.restservice.signals.call_webhooks(sender, **kwargs)

Call webhooks signal.

onadata.apps.restservice.tasks module

restservice async functions.

onadata.apps.restservice.utils module

restservice utility functions.

onadata.apps.restservice.utils.call_service(submission_instance)

Sends submissions to linked services.

onadata.apps.restservice.views module

restservice views.

onadata.apps.restservice.views.add_service(request, username, id_string)

Add a service.

onadata.apps.restservice.views.delete_service(request, username, id_string)

Delete a service view.

Module contents

restservice module.