Open Data Catalog v2.0.0
Drupal\dkan_datastore\WebServiceApi Class Reference
Inheritance diagram for Drupal\dkan_datastore\WebServiceApi:

Public Member Functions

 __construct (Service $datastoreService, RequestStack $requestStack)
 
 summary ($identifier)
 
 import ()
 
 delete ($identifier)
 
 deleteMultiple ()
 
 list ()
 

Static Public Member Functions

static create (ContainerInterface $container)
 

Protected Attributes

 $datastoreService
 

Detailed Description

Definition at line 17 of file WebServiceApi.php.

Constructor & Destructor Documentation

◆ __construct()

Drupal\dkan_datastore\WebServiceApi::__construct ( Service  $datastoreService,
RequestStack  $requestStack 
)

Api constructor.

Definition at line 37 of file WebServiceApi.php.

Member Function Documentation

◆ create()

static Drupal\dkan_datastore\WebServiceApi::create ( ContainerInterface  $container)
static

Create controller object from dependency injection container.

Definition at line 45 of file WebServiceApi.php.

◆ delete()

Drupal\dkan_datastore\WebServiceApi::delete (   $identifier)

Drop.

Parameters
string$identifierThe uuid of a dataset.

Definition at line 125 of file WebServiceApi.php.

◆ deleteMultiple()

Drupal\dkan_datastore\WebServiceApi::deleteMultiple ( )

Drop multiples.

Returns
\Symfony\Component\HttpFoundation\JsonResponse Json response.

Definition at line 146 of file WebServiceApi.php.

◆ import()

Drupal\dkan_datastore\WebServiceApi::import ( )

Import.

Definition at line 78 of file WebServiceApi.php.

◆ list()

Drupal\dkan_datastore\WebServiceApi::list ( )

Returns a list of import jobs and data about their status.

Returns
\Symfony\Component\HttpFoundation\JsonResponse The json response.

Definition at line 170 of file WebServiceApi.php.

◆ summary()

Drupal\dkan_datastore\WebServiceApi::summary (   $identifier)

Returns the dataset along with datastore headers and statistics.

Parameters
string$identifierIdentifier.
Returns
\Symfony\Component\HttpFoundation\JsonResponse The json response.

Definition at line 60 of file WebServiceApi.php.

Member Data Documentation

◆ $datastoreService

Drupal\dkan_datastore\WebServiceApi::$datastoreService
protected

Definition at line 25 of file WebServiceApi.php.