brapi_post_search_attributevalues: post /search/attributevalues

In mverouden/brapir-v2: Client to Access BrAPI Compliant Plant Breeding Databases

post /search/attributevalues

Description

Submit a search request for Germplasm AttributeValues

Usage

brapi_post_search_attributevalues(
  con = NULL,
  attributeDbIds = "",
  attributeNames = "",
  attributeValueDbIds = "",
  dataTypes = "",
  externalReferenceIDs = "",
  externalReferenceSources = "",
  germplasmDbIds = "",
  germplasmNames = "",
  methodDbIds = "",
  ontologyDbIds = "",
  page = 0,
  pageSize = 1000,
  scaleDbIds = "",
  traitClasses = "",
  traitDbIds = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
attributeDbIds	vector of type character; required: FALSE; The unique Germplasm Attribute database identifier(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
attributeNames	vector of type character; required: FALSE; Human readable Germplasm Attribute names to search for; default: "", when using multiple values supply as c("value1", "value2").
attributeValueDbIds	vector of type character; required: FALSE; The unique Germplasm Attribute Value database identifiers to search for; default: "", when using multiple values supply as c("value1", "value2").
dataTypes	vector of type character; required: FALSE; List of scale data types to filter search results; default: "", when using multiple values supply as c("value1", "value2").
externalReferenceIDs	vector of type character; required: FALSE; List of external reference IDs. Could be a simple strings or a URIs. (use with externalReferenceSources parameter); default: "", when using multiple values supply as c("value1", "value2").
externalReferenceSources	vector of type character; required: FALSE; List of identifiers for the source system or database of an external reference (use with externalReferenceIDs parameter); default: "", when using multiple values supply as c("value1", "value2").
germplasmDbIds	vector of type character; required: FALSE; List of IDs which uniquely identify germplasm to search for; default: "", when using multiple values supply as c("value1", "value2").
germplasmNames	vector of type character; required: FALSE; List of human readable names to identify germplasm to search for; default: "", when using multiple values supply as c("value1", "value2").
methodDbIds	vector of type character; required: FALSE; List of methods to filter search results; default: "", when using multiple values supply as c("value1", "value2").
ontologyDbIds	vector of type character; required: FALSE; List of ontology IDs to search for; default: "", when using multiple values supply as c("value1", "value2").
page	integer; required: FALSE; Used to request a specific page of data to be returned. The page indexing starts at 0 (the first page is page = 0). Default is 0.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.
scaleDbIds	vector of type character; required: FALSE; List of scales to filter search results; default: "", when using multiple values supply as c("value1", "value2").
traitClasses	vector of type character; required: FALSE; List of trait classes to filter search results; default: "", when using multiple values supply as c("value1", "value2").
traitDbIds	vector of type character; required: FALSE; List of trait unique ID to filter search results; default: "", when using multiple values supply as c("value1", "value2").

Details

Submit a search request for Germplasm Attributevalues. Function will return either the search results (Status 200 for an immediate response) or a searchResultsDbId (Status 202 for both a saved and an asynchronous search).

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-germplasm: brapi_get_attributes(), brapi_get_attributevalues(), brapi_get_germplasm(), brapi_get_search_attributes_searchResultsDbId(), brapi_get_search_attributevalues_searchResultsDbId(), brapi_get_search_germplasm_searchResultsDbId(), brapi_post_search_attributes(), brapi_post_search_germplasm()

Other Germplasm Attribute Values: brapi_get_attributevalues(), brapi_get_search_attributevalues_searchResultsDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
con[["token"]] <- "YYYY"

# Immediate Response Example
brapi_post_search_attributevalues(con = con, page = 0, pageSize = 1000)

# Saved or Asynchronous Search Response Example
brapi_post_search_attributevalues(con = con,
                                  attributeDbIds = c("attribute1",
                                                     "attribute2"),
                                  attributeNames = "Rht-B1b",
                                  attributeValueDbIds = "attribute_val1",
                                  externalReferenceIDs = "https://brapi.org/specification",
                                  externalReferenceSources = "BrAPI Doc",
                                  page = 0,
                                  pageSize = 1000)

## End(Not run)

mverouden/brapir-v2 documentation built on April 22, 2022, 9:24 a.m.