brapi_get_serverinfo: get /serverinfo

View source: R/brapi_get_serverinfo.R

brapi_get_serverinfoR Documentation

get /serverinfo

Description

Get the list of implemented Calls

Usage

brapi_get_serverinfo(con = NULL, dataType = "")

Arguments

con

list; required: TRUE; BrAPI connection object

dataType

character; required: FALSE; The data format supported by the call.; default: "", other possible values: "application/json"| "text/csv"| "text/tsv"| "application/flapjack"

Details

Implementation Notes: Having a consistent structure for the path string of each call is very important for teams to be able to connect and find errors. Read more on Github.Here are the rules for the path of each call that should be returned:

  • Every word in the call path should match the documentation exactly, both in spelling and capitalization. Note that path strings are all lower case, but path parameters are camel case.

  • Each path should start relative to "/" and therefore should not include "/"

  • No leading or trailing slashes ("/")

  • Path parameters are wrapped in curly braces ("{}"). The name of the path parameter should be spelled exactly as it is specified in the documentation.

Examples:

  • GOOD "call": "germplasm/{germplasmDbId}/pedigree"

  • BAD "call": "germplasm/{id}/pedigree"

  • BAD "call": "germplasm/{germplasmDBid}/pedigree"

  • BAD "call": "brapi/v2/germplasm/{germplasmDbId}/pedigree"

  • BAD "call": "/germplasm/{germplasmDbId}/pedigree/"

  • BAD "call": "germplasm/<germplasmDbId>/pedigree"

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_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()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_serverinfo(con = con)

## End(Not run)


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