Commit 853c011b authored by Matija Obreza's avatar Matija Obreza
Browse files

Merge branch '3-documentation' into 'master'

Resolve "Documentation"

Closes #3

See merge request !6
parents 196902d4 7134c02f
......@@ -4,38 +4,38 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**doi** | **String** | |
**url** | **String** | | [optional]
**user** | [**Location**](Location.md) | | [optional]
**m01** | [**Location**](Location.md) | | [optional]
**m02** | **String** | | [optional]
**m03** | [**LocalDate**](LocalDate.md) | | [optional]
**m04** | [**TermValue**](TermValue.md) | | [optional]
**doi** | **String** | Digital Object Identifier (DOI) associated to the PGRFA |
**url** | **String** | GLIS landing page for the PGRFA | [optional]
**user** | [**Location**](Location.md) | GLIS user account who registered the PGRFA | [optional]
**m01** | [**Location**](Location.md) | The organization, individual or legal entity conserving the PGRFA | [optional]
**m02** | **String** | The identifier that is used to identify the PGRFA material to distinguish it from other PGRFA conserved by the holder. Precisely one identifier is specified for the material. | [optional]
**m03** | **String** | Date on which PGRFA came into management of the holder of the PGRFA. Date fragments are also accepted, e.g. when only year or year and month are defined. | [optional]
**m04** | [**TermValue**](TermValue.md) | Considering the date given for the previous field (Date), what event occurred on that date that resulted in the holder becoming the PGRFA holder. | [optional]
**m05** | [**Names**](Names.md) | | [optional]
**r01** | [**List<Target>**](Target.md) | The URLs of websites where additional information on the PGRFA can be found. Each target is associated to one or more controlled vocabulary term code (see Controlled vocabulary query below). | [optional]
**r03** | [**TermValue**](TermValue.md) | | [optional]
**r04** | [**Species**](Species.md) | | [optional]
**r05** | **List<String>** | | [optional]
**r06** | [**List<OtherIdentifier>**](OtherIdentifier.md) | | [optional]
**r07** | [**TermValue**](TermValue.md) | * 0 Not available under the MLS * 1 Available under the MLS * 11 The sample is of a crop listed in Annex I and is under the management and control of a Contracting Party to the Treaty and declared to be in the public domain * 12 The sample is in a collection subject to an agreement concluded under Article 15 of the Treaty * 13 The holder received the sample with SMTA * 14 The holder has voluntarily placed the sample in the MLS * 15 The sample is derived from, and distinct from, material previously received from the MLS, is still under development and not yet ready for commercialization, and may be made available at the discretion of the developer | [optional]
**r08** | **Boolean** | | [optional]
**a01** | [**Location**](Location.md) | | [optional]
**a02** | **String** | | [optional]
**a03** | **String** | ISO-3166 apha-3 code of country of provenance | [optional]
**a04** | [**List<Location>**](Location.md) | | [optional]
**a05** | **String** | | [optional]
**a06** | **String** | | [optional]
**a07** | **String** | | [optional]
**a08** | [**BigDecimal**](BigDecimal.md) | Decimal degrees | [optional]
**a09** | [**BigDecimal**](BigDecimal.md) | Decimal degrees | [optional]
**a10** | **String** | Uncertainty of lat/lon coordinates | [optional]
**a11** | [**TermValue**](TermValue.md) | | [optional]
**a12** | [**TermValue**](TermValue.md) | | [optional]
**a13** | [**BigDecimal**](BigDecimal.md) | | [optional]
**a14** | **String** | Partial date YYYY-MM?-DD? | [optional]
**a15** | [**TermValue**](TermValue.md) | | [optional]
**a16** | [**List<Location>**](Location.md) | | [optional]
**a17** | **String** | | [optional]
**r01** | [**List<Target>**](Target.md) | The URLs of websites where additional information on the PGRFA can be found. Each target is associated to one or more controlled vocabulary term code. | [optional]
**r03** | [**TermValue**](TermValue.md) | Describes the conditions of provenance of the PGRFA. MCPD equivalent is Biological status of accession [SAMPSTAT]. | [optional]
**r04** | [**Species**](Species.md) | Species: Specific epithet of the scientific name Species authority: Authority for the specific epithet Subtaxa: Any additional infra-specific taxon: subspecies, variety, form, Group Subtaxon authority: Authority for the subtaxon | [optional]
**r05** | **List<String>** | Registered names or other designations, such as the name of a landrace, traditional variety or modern cultivar, or some other name or designation used to identify a breeder’s selection or elite line or variety. | [optional]
**r06** | [**List<OtherIdentifier>**](OtherIdentifier.md) | Any other identifiers that have been assigned to identify the PGRFA material. | [optional]
**r07** | [**TermValue**](TermValue.md) | * 0 Not available under the MLS * 1 Available under the MLS * 11 The sample is of a crop listed in Annex I and is under the management and control of a Contracting Party to the Treaty and declared to be in the public domain * 12 The sample is in a collection subject to an agreement concluded under Article 15 of the Treaty * 13 The holder received the sample with SMTA * 14 The holder has voluntarily placed the sample in the MLS * 15 The sample is derived from, and distinct from, material previously received from the MLS, is still under development and not yet ready for commercialization, and may be made available at the discretion of the developer | [optional]
**r08** | **Boolean** | Describes whether the PGRFA is still available or permanently lost after being registered. | [optional]
**a01** | [**Location**](Location.md) | Location or name of the person or organization that provided the PGRFA to the holder. | [optional]
**a02** | **String** | Unique identifier used by the provider to identify the PGRFA under the provider’s management. | [optional]
**a03** | **String** | ISO-3166 apha-3 code of country in which the PGRFA material was either collected or bred or selected, or the first country in the known history of the PGRFA. | [optional]
**a04** | [**List<Location>**](Location.md) | Location of the home base of the person(s) or organization(s) that originally collected the PGRFA from in situ conditions. | [optional]
**a05** | **String** | Identifier assigned by the collector(s) to the PGRFA collected. MCPD equivalent is Collecting number [COLLNUMB]. | [optional]
**a06** | **String** | The identifier, if any, of the mission during which the PGRFA was collected. | [optional]
**a07** | **String** | Location information below the country level that describes where the PGRFA was collected. | [optional]
**a08** | [**BigDecimal**](BigDecimal.md) | Latitude of the location where the PGRFA was collected in decimal degrees. | [optional]
**a09** | [**BigDecimal**](BigDecimal.md) | Longitude of the location where the PGRFA was collected in decimal degrees. | [optional]
**a10** | **String** | Uncertainty of the latitude/longitude coordinates of the location where the PGRFA was collected. | [optional]
**a11** | [**TermValue**](TermValue.md) | The geodetic datum or spatial reference system upon which the latitude/longitude coordinates of the collecting location are based. | [optional]
**a12** | [**TermValue**](TermValue.md) | The method used to estimate latitude/longitude coordinates of the location where the PGRFA was collected. | [optional]
**a13** | [**BigDecimal**](BigDecimal.md) | Elevation of collecting site. | [optional]
**a14** | **String** | Date on which the PGRFA was collected. Partial dates are allowed (YYYY-MM?-DD?). | [optional]
**a15** | [**TermValue**](TermValue.md) | A description of the nature of the location where the PGRFA was collected. | [optional]
**a16** | [**List<Location>**](Location.md) | Location where the material was bred. | [optional]
**a17** | **String** | The pedigree (genealogy) or other description of the ancestry of the PGRFA and how it was bred. | [optional]
**info** | [**UpdateInformation**](UpdateInformation.md) | | [optional]
......
......@@ -33,8 +33,8 @@ easySmta.setPassword("YOUR PASSWORD");
RelsApi apiInstance = new RelsApi();
String doi = "doi_example"; // String | Digital Object Identifier (DOI) associated to the PGRFA for which relations are requested. Mandatory
String role = "role_example"; // String | Role of doi in the relationships. Optional, defaults to 'any'
String oper = "oper_example"; // String | Relational operator code to filter the relations. Optional; if specified, only the relations with the given operator will be returned.
String role = "role_example"; // String | Role of doi in the relationships. Optional, defaults to 'any'. Role in the relationship * any - Any role, default. * subject - DOI provided is the subject in the relationship. * object - DOI provided is the object in the relationship.
String oper = "oper_example"; // String | Relational operator code to filter the relations. Optional; if specified, only the relations with the given operator will be returned. Relational code * acfr - Acquired from. The PGRFA was received from a Provider. The related DOI identifies the Provider's sample * crfr - Created from. The PGRFA was obtained through crossing parent PGRFAs. The related DOIs identify the parent samples * defr - Derived from. The PGRFA was obtained from another sample. The related DOI identifies such original sample
try {
List<Relationship> result = apiInstance.listRelationships(doi, role, oper);
System.out.println(result);
......@@ -49,8 +49,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**doi** | **String**| Digital Object Identifier (DOI) associated to the PGRFA for which relations are requested. Mandatory |
**role** | **String**| Role of doi in the relationships. Optional, defaults to &#39;any&#39; | [optional]
**oper** | **String**| Relational operator code to filter the relations. Optional; if specified, only the relations with the given operator will be returned. | [optional]
**role** | **String**| Role of doi in the relationships. Optional, defaults to &#39;any&#39;. Role in the relationship * any - Any role, default. * subject - DOI provided is the subject in the relationship. * object - DOI provided is the object in the relationship. | [optional]
**oper** | **String**| Relational operator code to filter the relations. Optional; if specified, only the relations with the given operator will be returned. Relational code * acfr - Acquired from. The PGRFA was received from a Provider. The related DOI identifies the Provider&#39;s sample * crfr - Created from. The PGRFA was obtained through crossing parent PGRFAs. The related DOIs identify the parent samples * defr - Derived from. The PGRFA was obtained from another sample. The related DOI identifies such original sample | [optional]
### Return type
......
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment