amsCheckoutArtifact
Checkout an Artifact from the AMS
Description
Checks out an artifact from the AMS so that it can be updated
and checked back in.
- The function amsUncheckoutArtifact discards an artifact checkout.
- The function amsRevertArtifact discards changes to checked out artifact.
Usage
amsCheckoutArtifact(path, projectName, entityId = NULL,
ignoreCheckedOut = FALSE, url, apiToken, port = 2185)
amsUncheckoutArtifact(object, url, apiToken, port = 2185)
amsRevertArtifact(object, url, apiToken, port = 2185)
Arguments
| path |
a character value. Gives the path name for the artifact to check out.
|
| projectName |
a character value. Gives the project name containing path.
|
| entityId |
a character value. Gives the entityId of the artifact to check out.
Using this argument provides an alternative way to specify the artifact to check out.
If path and project are supplied, set this argument to NULL.
|
| ignoreCheckedOut |
a logical value. If TRUE, an artifact that is already checked out is ignored.
The default is FALSE.
|
| object |
an object returned from amsCheckoutArtifact
|
| 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.
|
Value
returns a list 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
amsListArtifacts, amsCommitArtifact, 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"])
zrevert <- amsRevertArtifact(zcheckout)
## End(Not run)