Package | Description |
---|---|
com.versionone.apiclient | |
com.versionone.apiclient.exceptions | |
com.versionone.apiclient.interfaces |
Modifier and Type | Method and Description |
---|---|
Asset |
Services.createNew(IAssetType assetType,
Oid context)
Create new Asset
|
Reader |
Services.getAttachment(Oid attachmentOid) |
Reader |
Services.getEmbeddedImage(Oid embeddedImageOid) |
String |
Services.getLocalization(IAttributeDefinition attribute) |
String |
Services.getLocalization(String key) |
String |
Localizer.resolve(String key)
Resolve the key to it's localized value
|
void |
Services.save(Asset[] assets)
Save an array of assets without comment
|
Oid |
Services.saveAttachment(String filePath,
Asset asset,
String attachmentName) |
Oid |
Services.saveEmbeddedImage(String filePath,
Asset asset) |
V1Connector.IsetProxyOrEndPointOrConnector |
V1Connector.IAuthenticationMethods.withAccessToken(String accessToken)
Optional method for setting the access token for authentication.
|
static V1Connector.ISetUserAgentMakeRequest |
V1Connector.withInstanceUrl(String instanceUrl) |
V1Connector.IsetProxyOrEndPointOrConnector |
V1Connector.IAuthenticationMethods.withOAuth2Token(String oauth2Token)
Optional method for setting the OAuth2 access token for authentication.
|
V1Connector.IBuild |
V1Connector.IProxy.withProxy(ProxyProvider proxyProvider)
Optional method for setting the proxy credentials.
|
V1Connector.IAuthenticationMethods |
V1Connector.ISetUserAgentMakeRequest.withUserAgentHeader(String name,
String version)
Required method for setting a custom user agent header for all HTTP requests made to the VersionOne API.
|
V1Connector.IsetProxyOrEndPointOrConnector |
V1Connector.IAuthenticationMethods.withUsernameAndPassword(String username,
String password)
Optional method for setting the username and password for authentication.
|
V1Connector.IsetProxyOrEndPointOrConnector |
V1Connector.IAuthenticationMethods.withWindowsIntegrated()
Optional method for setting the Windows Integrated Authentication credentials for authentication based on the
currently logged in user.
|
Constructor and Description |
---|
V1Connector(String instanceUrl) |
Modifier and Type | Class and Description |
---|---|
class |
APIException
Represents a generic API exception
|
class |
AttachmentLengthException
Exception of attachment length
|
class |
ConnectionException
Exception thrown for connection errors
|
class |
OidException
Exception thrown when the API encounters a problem related to Object Identifiers
|
class |
SecurityException
Exception thrown when the APIClient encounters a security exception (401)
|
Modifier and Type | Method and Description |
---|---|
Object |
IAttributeDefinition.coerce(Object value)
Attempt to convert the value into this type
|
Asset |
IServices.createNew(IAssetType assetType,
Oid context)
Creates a new asset.
|
Reader |
IServices.getAttachment(Oid attachmentOid)
Returns the attachment data for the specified attachment Oid.
|
Reader |
IServices.getEmbeddedImage(Oid embeddedImageOid)
Returns the embedded image data for the specified attachment Oid.
|
String |
IServices.getLocalization(IAttributeDefinition attribute)
Returns a localization value based on an attribute definition.
|
String |
IServices.getLocalization(String key)
Returns a localization value based on key.
|
String |
ILocalizer.resolve(String key)
Resolve the key to it's localized value
|
void |
IServices.save(Asset[] assetList)
Saves multiple assets without a comment.
|
Oid |
IServices.saveAttachment(String filePath,
Asset asset,
String attachmentName)
Saves an attachment to the specified asset.
|
Oid |
IServices.saveEmbeddedImage(String filePath,
Asset asset)
Saves an embedded image to the specified asset.
|
Copyright © 2015 VersionOne, Inc.. All rights reserved.