R/brapi_post_search_lists.R

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

#' @title
#' post /search/lists
#'
#' @description
#' Submit a search request for Lists
#'
#' @param con list; required: TRUE; BrAPI connection object
#' @param 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).
#' @param 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).
#' @param 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).
#' @param 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).
#' @param 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").
#' @param 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").
#' @param 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").
#' @param listNames vector of type character; required: FALSE; Names of generic
#'    lists to search for; default: "", when using multiple values
#'    supply as c("value1", "value2").
#' @param listOwnerNames vector of type character; required: FALSE; Names of
#'    list owners to search for; default: "", when using multiple
#'    values supply as c("value1", "value2").
#' @param 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").
#' @param listSources vector of type character; required: FALSE; List sources to
#'    search for; default: "", when using multiple values supply as
#'    c("value1", "value2").
#' @param listType character; required: FALSE; ; Type of list to search for;
#'    default: "", other possible values: "germplasm"|
#'    "markers"|"observations"|"observationUnits"|
#'    "observationVariables"|"programs"|"samples"|
#'    "studies"|"trials".
#' @param page integer; required: FALSE; Which result page is requested. The
#'    page indexing starts at 0 (the first page is 'page'= 0). Default is `0`.
#' @param 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).
#'
#' @return data.frame
#'
#' @author Maikel Verouden
#'
#' @references \href{https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI-Core/2.0#/Lists/post_search_lists }{BrAPI SwaggerHub}
#'
#' @family brapi-core
#' @family Lists
#'
#' @examples
#' \dontrun{
#' 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")
#' }
#'
#' @export
brapi_post_search_lists <- function(con = NULL,
                                    dateCreatedRangeEnd = '',
                                    dateCreatedRangeStart = '',
                                    dateModifiedRangeEnd = '',
                                    dateModifiedRangeStart = '',
                                    externalReferenceIDs = '',
                                    externalReferenceSources = '',
                                    listDbIds = '',
                                    listNames = '',
                                    listOwnerNames = '',
                                    listOwnerPersonDbIds = '',
                                    listSources = '',
                                    listType = '',
                                    page = 0,
                                    pageSize = 1000) {
  ## Create a list of used arguments
  usedArgs <- brapirv2:::brapi_usedArgs(origValues = FALSE)
  ## Check if BrAPI server can be reached given the connection details
  brapi_checkCon(con = usedArgs[["con"]], verbose = FALSE)
  ## Check validity of used and required arguments
  brapirv2:::brapi_checkArgs(usedArgs, reqArgs = "")
  ## Obtain the call url
  callurl <- brapirv2:::brapi_POST_callURL(usedArgs = usedArgs,
                                           callPath = "/search/lists",
                                           reqArgs = "",
                                           packageName = "BrAPI-Core",
                                           callVersion = 2.0)
  ## Build the Body
  callbody <- brapirv2:::brapi_POST_callBody(usedArgs = usedArgs,
                                             reqArgs = "")

  try({
    ## Make the call and receive the response
    resp <- brapirv2:::brapi_POST(url = callurl, body = callbody, usedArgs = usedArgs)
    ## Message about call status
    if (httr::status_code(resp) == 200) {
      message(paste0("Immediate Response.", "\n"))
    } else if (httr::status_code(resp) == 202) {
      message(paste0("Saved or Asynchronous Response has provided a searchResultsDbId.", "\n"))
      message(paste0("Use the GET /search/lists/{searchResultsDbId} call to retrieve the paginated output.", "\n"))
    } else {
      stop(paste0("The POST /search/lists call resulted in Server status, ", httr::http_status(resp)[["message"]]))
    }
    ## Extract the content from the response object in human readable form
    cont <- httr::content(x = resp, as = "text", encoding = "UTF-8")
    ## Convert the content object into a data.frame
    out <- brapirv2:::brapi_result2df(cont, usedArgs)
  })
  ## Set class of output
  class(out) <- c(class(out), "brapi_post_search_lists")
  ## Show pagination information from metadata
  brapirv2:::brapi_serverinfo_metadata(cont)
  return(out)
}