Difference between revisions of "GCube Data Catalogue for GRSF"
(Created page with "'''** THIS PAGE IS UNDER CONSTRUCTION **''' __TOC__ = GCube Data Catalogue: support for GRSF = In the following page are reported the relevant information for the GRSF Data...") |
|||
| Line 4: | Line 4: | ||
= GCube Data Catalogue: support for GRSF = | = GCube Data Catalogue: support for GRSF = | ||
| − | In the following page are reported the relevant information for the GRSF Data Catalogue, which is available [https://i-marine.d4science.org/group/grsf/data-catalogue here]. The catalogue | + | In the following page are reported the relevant information for the GRSF Data Catalogue, which is available [https://i-marine.d4science.org/group/grsf/data-catalogue here]. The catalogue stores, as well as allows the publication of, products of two types: Stock and Fishery. A part from the default set of metadata, each type of product will also have specific fields. Some of them will also become automatically tags of the product. The same reasoning applies for group associations. In fact a set of groups was already created and the product will be automatically associated to them during publication, if that is the case. Fields that fire tags creation or groups association will be shown in the following as well. |
== Metadata == | == Metadata == | ||
| Line 84: | Line 84: | ||
=== Stock Metadata === | === Stock Metadata === | ||
| + | |||
| + | TODO | ||
=== Fishery Metadata === | === Fishery Metadata === | ||
| + | |||
| + | TODO | ||
== GRSF Publication Web Service == | == GRSF Publication Web Service == | ||
| − | Publication of products is performed by means of a RESTful web service. | + | Publication of products is performed by means of a RESTful web service. Each call to the service requires the security token of the user for the context in which he wish to publish or exploit the other functionalities. Please note that in case of product publication it is needed that the user has enough privileges. The list of roles and associated privileges for the catalogue users is reported [https://wiki.gcube-system.org/gcube/GCube_Data_Catalogue#Users.2C_Roles_and_Groups here]. The VRE Manager assignes them. |
=== Stock JSON Format === | === Stock JSON Format === | ||
Revision as of 18:03, 11 October 2016
** THIS PAGE IS UNDER CONSTRUCTION **
Contents
GCube Data Catalogue: support for GRSF
In the following page are reported the relevant information for the GRSF Data Catalogue, which is available here. The catalogue stores, as well as allows the publication of, products of two types: Stock and Fishery. A part from the default set of metadata, each type of product will also have specific fields. Some of them will also become automatically tags of the product. The same reasoning applies for group associations. In fact a set of groups was already created and the product will be automatically associated to them during publication, if that is the case. Fields that fire tags creation or groups association will be shown in the following as well.
Metadata
Common Metadata
The following table shows the set of "core" metadata, that is the ones shared by both Stock and Fishery types. Some of them are retrieved during publication and will be filled automatically
| Label | Field Name (API) | Definition | Guidelines | Example |
|---|---|---|---|---|
| Title* | title | Name given to the dataset. | It is evaluated using the stock_name or fishery_name attribute (see below) | Skipjack tuna - Eastern Pacific |
| Description | description | Short description explaining the content and its origins. | Description of a few sentences, written in plain language. Should provide a sufficiently comprehensive overview of the resource for anyone,to understand its content, origins, and any continuing work on it.. | This product contains attributes of ... |
| Tags | tags | An array of Taxonomic terms stored as tags. | They are automatically extracted from the product | |
| License* | lincese_title | the license that applies to published dataset. | ||
| Organization* | organization | Organization the datasets belongs to | The product organization is chosen according the Status attribute (i.e., Pending or Confirmed) | |
| Version | version | Version of dataset | Increase manually after editing | 1.0 |
| Author* | Owner of dataset | The person who created the dataset in the format: Surname, Name. The field is automatically filled. | Bloggs, Joe | |
| Author Contact | Contact details of owner | The email or other contact details of the person who created the dataset. The field is automatically filled. | joe@example.com | |
| Mantainer | Mantainer of the dataset | The person or the authority that maintains the dataset | A person: Bloggs, Joe. An authority: D4Science | |
| Mantainer
Contact |
Contact details of mantainer | The email or other contact details of the person who maintains the dataset. | joe@example.com |
mandatory fields are marked with an asterisk (*)
Stock Metadata
TODO
Fishery Metadata
TODO
GRSF Publication Web Service
Publication of products is performed by means of a RESTful web service. Each call to the service requires the security token of the user for the context in which he wish to publish or exploit the other functionalities. Please note that in case of product publication it is needed that the user has enough privileges. The list of roles and associated privileges for the catalogue users is reported here. The VRE Manager assignes them.
Stock JSON Format
TODO
Fishery JSON Format
TODO
Publication Examples
TODO
