org.genesys.glis.v1.api

Class QueryApi

java.lang.Object

org.genesys.glis.v1.api.QueryApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-09-11T09:48:53.504Z")
public class QueryApi
extends Object

Constructor Summary

Constructors

Constructor and Description
QueryApi()
QueryApi(ApiClient apiClient)

Method Summary

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

public QueryApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listHolders

public List<DOIHolder> listHolders(DOIArray dois)
                            throws ApiException

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.

Parameters:

dois - (optional)

Returns:

List<DOIHolder>

Throws:

ApiException - if fails to make API call

listRelationships

public List<Relationship> listRelationships(String doi,
                                            String role,
                                            String oper)
                                     throws ApiException

Get PGRFA relationships Multiple status values can be provided with comma separated strings

Parameters:

doi - Digital Object Identifier (DOI) associated to the PGRFA for which relations are requested. Mandatory (required)

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. (optional)

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 (optional)

Returns:

List<Relationship>

Throws:

ApiException - if fails to make API call

listTerms

public List<Term> listTerms(List<String> acceptLanguage)
                     throws ApiException

GLIS vocabularies To describe the kind of information that will be found in the targets, GLIS adopts a simple controlled vocabulary.

Parameters:

acceptLanguage - Tags to filter by (optional, default to en)

Returns:

List<Term>

Throws:

ApiException - if fails to make API call

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 ApiException

Find passport data on PGRFA in GLIS

Parameters:

page - Request a particular page (optional, default to 1)

perPage - The number of items returned in a single page (optional, default to 10)

acceptLanguage - Tags to filter by (optional, default to en)

doi - Digital Object Identifier (DOI) associated to the PGRFA (optional)

identifier - Any identifier associated with the PGRFA, excluding the DOI (optional)

genus - Genus of the PGRFA (optional)

species - Species and other taxonomic elements (optional)

name - Any name associated with the PGRFA (optional)

holdwiews - FAO/WIEWS Institute code of the holding institution (optional)

holdpid - Easy-SMTA PID of the holding institution or person (optional)

holdname - Name and surname for persons or Organization name of the holding institution or person (optional)

holdcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the holding institution or person (optional)

methodcode - Code of the method through which the PGRFA has been acquired. See Table 1 for the codes accepted by this element. TODO enum (optional)

provwiews - FAO/WIEWS Institute code of the providing institution (optional)

provpid - Easy-SMTA PID of the providing institution or person (optional)

provname - Name and surname for persons or Organization name of the providing institution (optional)

provcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the providing institution or person (optional)

provenance - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the providing institution or person (optional)

collwiews - FAO/WIEWS Institute code of the collecting institution (optional)

collpid - Easy-SMTA PID of the collecting institution or person (optional)

collname - Name and surname for persons or Organization name of the collecting institution or person (optional)

collcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the collecting institution or person (optional)

bredwiews - FAO/WIEWS Institute code of the breeding institution (optional)

bredpid - Easy-SMTA PID of the breeding institution or person (optional)

bredname - Name and surname for persons or Organization name of the breeding institution or person (optional)

bredcountry - ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the breeding institution or person (optional)

biostatus - Code of the biological status of sample (MCPD SAMPSTAT). (optional)

mlsstatus - Code for the inclusion into the Multilateral System. (optional)

targetkw - Code for the keyword for a target associated to the PGRFA. To obtain the list of keyword codes, please see \"Controlled vocabulary query\". (optional)

Returns:

List<PGRFA>

Throws:

ApiException - if fails to make API call