amsListArtifacts
List Artifacts in an AMS Project
Description
Lists the artifacts in an AMS project.
Usage
amsListArtifacts(projectName, url, apiToken, port = 2185, raw = FALSE)
Arguments
projectName |
a character value, the name of the project.
This can be obtained by a call to amsListProjects.
|
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.
|
raw |
a logical value, if TRUE, return a list with the raw results
from the connection to the AMS.
The default is to extract the project names and ids from the raw results
in a data.frame.
|
Details
The path in the return object (when raw=FALSE)
and the projectName can be used to get or check out a particular
artifact from the AMS
(see amsGetArtifact and asmCheckoutArtifact).
A warning will be issued if the return status is not 200 (success).
Value
The default (
raw=FALSE is a
data.frame with columns including:
path |
a character value, the unique path (within the project) for the artifact.
|
projectId |
the id for the project.
|
entityId |
the id for the artifact.
This can be used to retrieve the artifact from the AMS.
|
If
raw=TRUE, a list is returned with components:
body |
a character vector with the body of the results from the connection to the AMS.
This is in JSON format.
|
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
amsGetArtifact, asmCheckoutArtifact
Examples
## Not run:
projTable <- amsListProjects()
zlist_art <- amsListArtifacts(projTable[1, "projectName"])
zlist_art
## End(Not run)