experimentUnpublish: experimentUnpublish Unpublishes an experiment.

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

Description

experimentUnpublish - Unpublishes an experiment.

Usage

experimentUnpublish(coreApi, experimentType, experimentBarcode, ...)

Arguments

coreApi	coreApi object with valid jsessionid
experimentType	experiment entity type
experimentBarcode	barcode of the experiment (Experiments that require a signature cannot be published through the API).
...	additional arguments passed to apiPOST

Details

experimentUnpublish Unpublishes an experiment.

Value

List of length 2, containing entity and response objects:

• entity is the HTTP response content. For PFS version 5.x.x the entity value comes from response$content$response$data For PFS version 6.x.x the entity value comes from response$content

• response is the entire HTTP response.

Author(s)

Craig Parman [e-mail]

Natasha Mora [e-mail]

Scott Russell [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
update <- experimentUnpublish(login$coreApi, experimentType, experimentBarcode, useVerbose = TRUE)
logOut(login$coreApi)

## End(Not run)

AmundsenJunior/pfsrsdk documentation built on July 18, 2019, 8:10 p.m.