brapi_post_search_samples: post /search/samples

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

post /search/samples

Description

Submit a search request for Samples

Usage

brapi_post_search_samples(
  con = NULL,
  externalReferenceIDs = "",
  externalReferenceSources = "",
  germplasmDbIds = "",
  germplasmNames = "",
  observationUnitDbIds = "",
  page = 0,
  pageSize = 1000,
  plateDbIds = "",
  sampleDbIds = "",
  studyDbIds = "",
  studyNames = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
externalReferenceIDs	vector of type character; required: FALSE; External reference identifier(s) 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; Source system or database identifier(s) of an external reference(s) to search for (use with externalReferenceIDs parameter); default: "", when using multiple values supply as c("value1", "value2").
germplasmDbIds	vector of type character; required: FALSE; Vector of database identifiers which uniquely identify germplasm to search for; default: "", when using multiple values supply as c("value1", "value2").
germplasmNames	vector of type character; required: FALSE; Human readable germplasm name(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
observationUnitDbIds	vector of type character; required: FALSE; The unique database identifier(s) of observation unit(s) to search samples 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.
plateDbIds	vector of type character; required: FALSE; The identifier(s), which uniquely identifies a plate or plates of samples; default: "", when using multiple values supply as c("value1 ", "value2").
sampleDbIds	vector of type character; required: FALSE; The identifier(s), which uniquely identifies a sample or samples; default: "", when using multiple values supply as c("value1", "value2").
studyDbIds	vector of type character; required: FALSE; List of unique study database identifier(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
studyNames	vector of type character; required: FALSE; List of study names to filter search results; default: "", when using multiple values supply as c("value1", "value2").

Details

Submit a search request for Samples. 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-genotyping: brapi_get_callsets_callSetDbId_calls(), brapi_get_callsets_callSetDbId(), brapi_get_callsets(), brapi_get_calls(), brapi_get_maps_mapDbId_linkagegroups(), brapi_get_maps_mapDbId(), brapi_get_maps(), brapi_get_markerpositions(), brapi_get_references_referenceDbId_bases(), brapi_get_references_referenceDbId(), brapi_get_referencesets_referenceSetDbId(), brapi_get_referencesets(), brapi_get_references(), brapi_get_samples_sampleDbId(), brapi_get_samples(), brapi_get_search_calls_searchResultsDbId(), brapi_get_search_callsets_searchResultsDbId(), brapi_get_search_markerpositions_searchResultsDbId(), brapi_get_search_references_searchResultsDbId(), brapi_get_search_referencesets_searchResultsDbId(), brapi_get_search_samples_searchResultsDbId(), brapi_get_search_variants_searchResultsDbId(), brapi_get_search_variantsets_searchResultsDbId(), brapi_get_variants_variantDbId_calls(), brapi_get_variants_variantDbId(), brapi_get_variantsets_variantSetDbId_callsets(), brapi_get_variantsets_variantSetDbId_calls(), brapi_get_variantsets_variantSetDbId_variants(), brapi_get_variantsets_variantSetDbId(), brapi_get_variantsets(), brapi_get_variants(), brapi_get_vendor_orders_orderId_plates(), brapi_get_vendor_orders_orderId_results(), brapi_get_vendor_orders_orderId_status(), brapi_get_vendor_orders(), brapi_get_vendor_specifications(), brapi_post_samples(), brapi_post_search_callsets(), brapi_post_search_calls(), brapi_post_search_markerpositions(), brapi_post_search_referencesets(), brapi_post_search_references(), brapi_post_search_variantsets(), brapi_post_search_variants(), brapi_post_variantsets_extract(), brapi_put_samples_sampleDbId()

Other Samples: brapi_get_samples_sampleDbId(), brapi_get_samples(), brapi_get_search_samples_searchResultsDbId(), brapi_post_samples(), brapi_put_samples_sampleDbId()

Examples

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

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

# Saved or Asynchronous Search Response Example
brapi_post_search_samples(con = con,
                          germplasmDbIds = c("germplasm1",
                                             "germplasm3"),
                          page = 0,
                          pageSize = 1000,
                          plateDbIds = c("plate1",
                                         "vendor_plate1"),
                          studyDbIds = "study1")

## End(Not run)

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