brapi_post_search_attributes: post /search/attributes

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

post /search/attributes

Description

Submit a search request for Germplasm Attributes

Usage

brapi_post_search_attributes(
  con = NULL,
  attributeDbIds = "",
  attributeNames = "",
  dataTypes = "",
  externalReferenceIDs = "",
  externalReferenceSources = "",
  methodDbIds = "",
  ontologyDbIds = "",
  scaleDbIds = "",
  studyDbId = "",
  traitClasses = "",
  traitDbIds = "",
  page = 0,
  pageSize = 1000
)

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; The human readable Germplasm Attribute names to search for; default: "", when using multiple values supply as c("value1", "value2").
dataTypes	vector of type character; required: FALSE; The scale data types to filter search results; default: "", when using multiple values supply as c("value1", "value2").
externalReferenceIDs	vector of type character; required: FALSE; The external reference IDs to search for. 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; The identifiers for the source system or database of an external reference to search for (use with externalReferenceIDs parameter); default: "", when using multiple values supply as c("value1", "value2").
methodDbIds	vector of type character; required: FALSE; Unique method database indentifier(s) to filter search results; default: "", when using multiple values supply as c("value1", "value2").
ontologyDbIds	vector of type character; required: FALSE; Unique ontology database identiefier(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
scaleDbIds	vector of type character; required: FALSE; List of unique scale database identifier(s) to filter search results; default: "", when using multiple values supply as c("value1", "value2").
studyDbId	vector of type character; required: FALSE; The unique database identifier(s) of studies to filter on; 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 database identifier(s) to filter search results; 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.

Details

Submit a search request for Germplasm Attributes. 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_attributevalues(), brapi_post_search_germplasm()

Other Germplasm Attributes: brapi_get_attributes(), brapi_get_search_attributes_searchResultsDbId()

Examples

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

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

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

## End(Not run)

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