QueryApi (GLIS API client (spring-resttemplate) 1.1 API)

java.lang.Object
- org.genesys.glis.v1.api.QueryApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-09-10T16:57:15.984Z")
 @Component(value="org.genesys.glis.v1.api.QueryApi")
public class QueryApi
extends Object

Constructor Summary

Constructors
Constructor and Description

QueryApi()

QueryApi(ApiClient apiClient)

Constructors
Constructor and Description
`QueryApi()`
`QueryApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiClient`	`getApiClient()`
`List<DOIHolder>`	`listHolders(DOIArray dois)` Query for holder of PGRFA by DOIs Query GLIS for WIEWS code of the holder for each submitted DOI.
`List<Relationship>`	`listRelationships(String doi, String role, String oper)` Get PGRFA relationships Multiple status values can be provided with comma separated strings
`List<Term>`	`listTerms(List<String> acceptLanguage)` GLIS vocabularies To describe the kind of information that will be found in the targets, GLIS adopts a simple controlled vocabulary.
`List<PGRFA>`	search(Integer page, Integer perPage, List<String> acceptLanguage, String doi, String identifier, String genus, String species, String name, String holdwiews, String holdpid, String holdname, String holdcountry, String methodcode, String provwiews, String provpid, String provname, String provcountry, String provenance, String collwiews, String collpid, String collname, String collcountry, String bredwiews, String bredpid, String bredname, String bredcountry, String biostatus, String mlsstatus, String targetkw) Find passport data on PGRFA in GLIS
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryApi
```
public QueryApi()
```
  - QueryApi
```
@Autowired
public QueryApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - listHolders
```
public List<DOIHolder> listHolders(DOIArray dois)
                            throws org.springframework.web.client.RestClientException
```
    Query for holder of PGRFA by DOIs Query GLIS for WIEWS code of the holder for each submitted DOI. At this time, the call has a limit of 1,000 DOIs.
    200 - successful operation
    
    Parameters:
    
    dois - The dois parameter
    
    Returns:
    
    List<DOIHolder>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listRelationships
```
public List<Relationship> listRelationships(String doi,
                                            String role,
                                            String oper)
                                     throws org.springframework.web.client.RestClientException
```
    Get PGRFA relationships Multiple status values can be provided with comma separated strings
    200 - successful operation
    400 - Invalid status value
    
    Parameters:
    
    doi - Digital Object Identifier (DOI) associated to the PGRFA for which relations are requested. Mandatory
    
    role - 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.
    
    oper - 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
    
    Returns:
    
    List<Relationship>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listTerms
```
public List<Term> listTerms(List<String> acceptLanguage)
                     throws org.springframework.web.client.RestClientException
```
    GLIS vocabularies To describe the kind of information that will be found in the targets, GLIS adopts a simple controlled vocabulary.
    200 - successful operation
    
    Parameters:
    
    acceptLanguage - Tags to filter by
    
    Returns:
    
    List<Term>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - search
```
public List<PGRFA> search(Integer page,
                          Integer perPage,
                          List<String> acceptLanguage,
                          String doi,
                          String identifier,
                          String genus,
                          String species,
                          String name,
                          String holdwiews,
                          String holdpid,
                          String holdname,
                          String holdcountry,
                          String methodcode,
                          String provwiews,
                          String provpid,
                          String provname,
                          String provcountry,
                          String provenance,
                          String collwiews,
                          String collpid,
                          String collname,
                          String collcountry,
                          String bredwiews,
                          String bredpid,
                          String bredname,
                          String bredcountry,
                          String biostatus,
                          String mlsstatus,
                          String targetkw)
                   throws org.springframework.web.client.RestClientException
```
    Find passport data on PGRFA in GLIS
    200 - Successful operation
    404 - PGRFA not found
    429 - Too Many Requests
    
    Parameters:
    
    page - Request a particular page
    
    perPage - The number of items returned in a single page
    
    acceptLanguage - Tags to filter by
    
    doi - Digital Object Identifier (DOI) associated to the PGRFA
    
    identifier - Any identifier associated with the PGRFA, excluding the DOI
    
    genus - Genus of the PGRFA
    
    species - Species and other taxonomic elements
    
    name - Any name associated with the PGRFA
    
    holdwiews - FAO/WIEWS Institute code of the holding institution
    
    holdpid - Easy-SMTA PID of the holding institution or person
    
    holdname - Name and surname for persons or Organization name of the holding institution or person
    
    holdcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the holding institution or person
    
    methodcode - Code of the method through which the PGRFA has been acquired. See Table 1 for the codes accepted by this element. TODO enum
    
    provwiews - FAO/WIEWS Institute code of the providing institution
    
    provpid - Easy-SMTA PID of the providing institution or person
    
    provname - Name and surname for persons or Organization name of the providing institution
    
    provcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the providing institution or person
    
    provenance - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the providing institution or person
    
    collwiews - FAO/WIEWS Institute code of the collecting institution
    
    collpid - Easy-SMTA PID of the collecting institution or person
    
    collname - Name and surname for persons or Organization name of the collecting institution or person
    
    collcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the collecting institution or person
    
    bredwiews - FAO/WIEWS Institute code of the breeding institution
    
    bredpid - Easy-SMTA PID of the breeding institution or person
    
    bredname - Name and surname for persons or Organization name of the breeding institution or person
    
    bredcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the breeding institution or person
    
    biostatus - Code of the biological status of sample (MCPD SAMPSTAT).
    
    mlsstatus - Code for the inclusion into the Multilateral System.
    
    targetkw - Code for the keyword for a target associated to the PGRFA. To obtain the list of keyword codes, please see \"Controlled vocabulary query\".
    
    Returns:
    
    List<PGRFA>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

Class QueryApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryApi

QueryApi

Method Detail

getApiClient

setApiClient

listHolders

listRelationships

listTerms

search