brapi_post_search_lists: post /search/lists

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

post /search/lists

Description

Submit a search request for Lists

Usage

brapi_post_search_lists(
  con = NULL,
  dateCreatedRangeEnd = "",
  dateCreatedRangeStart = "",
  dateModifiedRangeEnd = "",
  dateModifiedRangeStart = "",
  externalReferenceIDs = "",
  externalReferenceSources = "",
  listDbIds = "",
  listNames = "",
  listOwnerNames = "",
  listOwnerPersonDbIds = "",
  listSources = "",
  listType = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
dateCreatedRangeEnd	character; required: FALSE; Timestamp to end the search range, when the entity was first created. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
dateCreatedRangeStart	character; required: FALSE; Timestamp to start the search range, when the entity was first created. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
dateModifiedRangeEnd	character; required: FALSE; Timestamp to end the search range, when the entity was last modified. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
dateModifiedRangeStart	character; required: FALSE; Timestamp to start the search range, when the entity was last modified. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
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").
listDbIds	vector of type character; required: FALSE; Unique identifiers of generic lists to searh for; default: "", when using multiple values supply as c("value1", "value2").
listNames	vector of type character; required: FALSE; Names of generic lists to search for; default: "", when using multiple values supply as c("value1", "value2").
listOwnerNames	vector of type character; required: FALSE; Names of list owners to search for; default: "", when using multiple values supply as c("value1", "value2").
listOwnerPersonDbIds	vector of type character; required: FALSE; Unique identifiers of list owner persons to search for; default: "", when using multiple values supply as c("value1", "value2").
listSources	vector of type character; required: FALSE; List sources to search for; default: "", when using multiple values supply as c("value1", "value2").
listType	character; required: FALSE; ; Type of list to search for; default: "", other possible values: "germplasm"| "markers"|"observations"|"observationUnits"| "observationVariables"|"programs"|"samples"| "studies"|"trials".
page	integer; required: FALSE; Which result page is requested. 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

Advanced searching for the list resource. 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-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_programs_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_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 Lists: brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_search_lists_searchResultsDbId(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_put_lists_listDbId()

Examples

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

# Immediate Response Example
brapi_post_search_lists(con = con,
                        listNames = "Example List 1")

# Saved or Asynchronous Search Response Example
brapi_post_search_lists(con = con,
                        externalReferenceIDs = "https://brapi.org/specification",
                        externalReferenceSources = "BrAPI Doc",
                        listDbIds = "list2",
                        listOwnerPersonDbIds = "list_person_1",
                        listType = "germplasm")

## End(Not run)

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