coreAPI: coreAPI - Creates a object of class coreAPI that contains...

In ajwtech/pfsrsdk: Functions for interacting with Platform for Science APIs

Description

coreAPI Creates a object of class coreAPI that contains user and connection information.

Usage

coreAPI(CoreAccountInfo)

Arguments

CoreAccountInfo

file with tenant information in json format.

Details

Creates a object of class list that contains connection information. Requires a json formatted datastring. #'Creates a object of class list that contains connection information coreAPI("path to json"). The json must include the fields shown below. { "values": [ { "key": "tenant", "value": "FULLNAMEOFTENANT" }, { "key": "alias", "value": "SHORTNAMEINURL" }, { "key": "scheme", "value": "https" }, { "key": "host", "value": "HOSTNAME" }, { "key": "port", "value": "443" }, { "key": "context", "value": "" }, { "key": "api_username", "value": "USER" }, { "key": "api_password", "value": "PASSWORD" }, { "key": "semver", "value": "" } ] }

The tenant value may be set to "" if the user only has access to one tenant. As an alternative the environment json object from Postman can be used directly.

Value

Object of class coreAPI

Author(s)

Craig Parman [e-mail]

Scott Russell [e-mail]

Adam Wheeler [e-mail]

Natasha Mora [e-mail]

Examples

## Not run: 
api <- coreAPI("/home/environment.json")

## End(Not run)

ajwtech/pfsrsdk documentation built on June 14, 2019, 10:34 a.m.