api_do_action: General API interaction tool

In UCSF-MSLAB/msbwaiter: Tools to Interact with the MS Bioscreen API

Description

api_do_action is a general API interaction tool that can fetch, delete, update, create, and search bioscreen data.

Usage

api_do_action(action = GET,
  url = "https://msbioscreen-uat.herokuapp.com/api/v1/subjects",
  token = get_token(), json_body_data = NULL, results_per_page = NULL)

Arguments

action	the HTTP method (GET, DELETE, PUT, POST).
url	the url of the page to retrieve.
token	HTTP authorization token. Default is to get environment variable 'MSBWAITER_TOKEN'.
json_body_data	a non-array JSON. This JSON may be used for searching, updating, or creating data. If NULL (default), the body argument is not part of the HTTP request header.
results_per_page	number of results to return per page. If set to NULL (default), the results_per_page query argument in the HTTP request header is equal to its default value.

See Also

api_create, api_update, api_delete, api_get, api_search_by_epicid, api_search_by_updated_at api_check

UCSF-MSLAB/msbwaiter documentation built on May 9, 2019, 5:19 p.m.