geonode.resource.api.views

Attributes

logger

Classes

ExecutionRequestViewset

API endpoint that allows users to be viewed or edited.

Functions

resource_service_search(request[, resource_type])	Return a list of resources matching the filtering criteria.
resource_service_exists(request, uuid)	Returns a JSON boolean success field indicating the outcome of the 'exists' operation.
resource_service_execution_status(request, execution_id)	Main dispatcher endpoint to follow an API request status progress

Module Contents

geonode.resource.api.views.logger

geonode.resource.api.views.resource_service_search(request, resource_type: str = None)

Return a list of resources matching the filtering criteria.

Sample requests:

• Get all ResourceBases the user has access to:

  http://localhost:8000/api/v2/resource-service/search

• Get all ResourceBases filtered by type criteria the user has access to:

  http://localhost:8000/api/v2/resource-service/search/layer

• Get ResourceBases filtered by model criteria the user has access to:

  http://localhost:8000/api/v2/resource-service/search/?filter={“title__icontains”:”foo”}

geonode.resource.api.views.resource_service_exists(request, uuid: str)

Returns a JSON boolean success field indicating the outcome of the ‘exists’ operation.

• Example: GET http://localhost:8000/api/v2/resource-service/exists/13decd74-df04-11eb-a0c1-00155dc3de71

  Response:

  200 OK
  {
      "success": true
  }
  

geonode.resource.api.views.resource_service_execution_status(request, execution_id: str)

Main dispatcher endpoint to follow an API request status progress

• GET input: <str: execution id>

• output: <ExecutionRequest>

class geonode.resource.api.views.ExecutionRequestViewset

Bases: dynamic_rest.viewsets.WithDynamicViewSetMixin, rest_framework.mixins.ListModelMixin, rest_framework.mixins.RetrieveModelMixin, rest_framework.viewsets.GenericViewSet

API endpoint that allows users to be viewed or edited.

authentication_classes

permission_classes

filter_backends

serializer_class

pagination_class

http_method_names = ['get', 'delete']

get_queryset(queryset=None)

delete(*args, **kwargs)