brapi_get_search_programs_searchResultsDbId: get /search/programs/{searchResultsDbId}

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

get /search/programs/{searchResultsDbId}

Description

Get the results of a Programs search request

Usage

brapi_get_search_programs_searchResultsDbId(
  con = NULL,
  searchResultsDbId = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
searchResultsDbId	character; required: TRUE; Unique identifier which references the search results
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

Returns the result of the advanced searching for the programs resource.

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-core: brapi_get_commoncropnames(), brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_locations_locationDbId(), brapi_get_locations(), brapi_get_people_personDbId(), brapi_get_people(), brapi_get_programs_programDbId(), brapi_get_programs(), brapi_get_search_lists_searchResultsDbId(), brapi_get_search_locations_searchResultsDbId(), brapi_get_search_people_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_trials_searchResultsDbId(), brapi_get_seasons_seasonDbId(), brapi_get_seasons(), brapi_get_serverinfo(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_get_trials_trialDbId(), brapi_get_trials(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_post_locations(), brapi_post_people(), brapi_post_programs(), brapi_post_search_lists(), brapi_post_search_locations(), brapi_post_search_people(), brapi_post_search_programs(), brapi_post_search_studies(), brapi_post_search_trials(), brapi_post_seasons(), brapi_post_studies(), brapi_post_trials(), brapi_put_lists_listDbId(), brapi_put_locations_locationDbId(), brapi_put_people_personDbId(), brapi_put_programs_programDbId(), brapi_put_seasons_seasonDbId(), brapi_put_studies_studyDbId(), brapi_put_trials_trialDbId()

Other Programs: brapi_get_programs_programDbId(), brapi_get_programs(), brapi_post_programs(), brapi_post_search_programs(), brapi_put_programs_programDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
con[["token"]] <- "YYYY"
# Saved or Asynchronous Search Response Example
out <-
 brapi_post_search_programs(con = con,
                            commonCropNames = c("Tomatillo",
                                                "Paw Paw"),
                            abbreviations = c("P1", "P3"),
                            leadPersonNames = "Bob Robertson",
                            objectives = c("Global Population Improvement",
                                           "XYZ"),
                            programDbIds = c("program1", "program3"))
searchResultsDbId <- out$searchResultsDbId
brapi_get_search_programs_searchResultsDbId(con = con,
                                            searchResultsDbId = searchResultsDbId)

## End(Not run)

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