amsGetArtifact
Get an Artifact from the AMS
Description
Get an artifact from the AMS given its artifact id.
Usage
amsGetArtifact(path, projectName, artifactId=NULL, version = -1,
url, apiToken, port = 2185)
Arguments
| path |
a character value, giving the path name for the artifact to be checked out.
This can be found in the object returned by amsListArtifacts.
|
| projectName |
a character value, giving the project name containing path.
|
| artifactId |
character value, giving the entityId of the artifact to get.
This is an alternative way to specify the artifact.
This should be NULL if path and project are supplied.
|
| version |
the version of the artifact to get.
The default of -1 gets the latest versions.
|
| url |
the url for the AMS.
The default is the cached value saved when amsLogin was called.
|
| apiToken |
a character value, the API token to connect to the AMS.
The default is cached value created when amsLogin was called.
|
| port |
an numeric value, the port for connecting to the AMS.
The default is cached value saved when amsLogin was called.
|
Details
A warning will be issued if the return status is not 200 (success).
Value
a list with components:
| data |
the S object contained in the artifact.
This is extracted from the body component
using the amsUnpackObject function.
|
| body |
a character vector with the body of the results from the connection to the AMS.
This is in JSON format.
The amsUnpackObject function can extract the S object from the body.
|
| status |
an integer return code from the connection to the AMS.
A value of 200 indicates a successful operation.
|
| headers |
a character vector containing the headers returned
from the connection to the AMS.
|
See Also
amsListArtifacts
Examples
## Not run:
zlist_art <- amsListArtifacts("MyProj")
zget_art <- amsGetArtifact(zlist_art[["entityId"]])
zget_art$data
## End(Not run)