amsCommitArtifact
Commit an Artifact Change to the AMS
Description
Commits an update to an artifact made by amsUpdateArtifact to the AMS.
The commit must be approved before it is available in the AMS.
Usage
amsCommitArtifact(artCheckoutObj, checkedOutArtifactId = NULL,
checkoutId = NULL, commitMessage = "Artifact Commit Message",
uncheckout=TRUE, url, apiToken, port = 2185)
Arguments
| artCheckoutObj |
an object returned by amsCheckoutArtifact.
This object contains the necessary IDs for checking in the new artifact update.
|
| checkedOutArtifactId |
the entityId of the checked-out artifact.
This ID can be found in the artCheckoutObj
and does not need to be specified if the artCheckoutObj is given.
|
| checkoutId |
the entityId of the check out.
This ID can be found in the artCheckoutObj
and does not need to be specified if the artCheckoutObj is given.
|
| commitMessage |
an character string specifying the commit message.
|
| uncheckout |
a logical value. If TRUE (the default), then the artifact is
unchecked out after the commit is made.
|
| 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 the cached value created when amsLogin was called.
|
| port |
an numeric value. The port for connecting to the AMS.
The default is the cached value saved when amsLogin was called.
|
Value
returns a list with components:
| body |
a character vector with the body of the results from the connection to the AMS.
This character vector is in JSON format.
|
| status |
an integer representing the 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
amsCheckoutArtifact, amsUpdateArtifact
Examples
## Not run:
amsLogin("http://localhost", "fakeuser", "fakepassword")
projTable <- amsListProjects()
zlist_art <- amsListArtifacts(projTable[1, "projectName"])
zcheckout <- amsCheckoutArtifact(zlist_art[1, "path"],
projTable[1, "projectName"])
newObj <- t.test(runif(13))
zupdate <- amsUpdateArtifact(newObj, zcheckout, artDesc="Now a t-test object")
zcommit <- amsCommitArtifact(zcheckout,
commitMessage="Changed to a t-test object")
## End(Not run)