Skip to content

Omnissa View API Reference Documentation - 2209

Welcome to the Omnissa View API Reference documentation v2209. This API reference provides comprehensive information about all data structures available through the View API:

To quickly find any entry, start typing its name in the Search Bar.

In addition, the documentation will outline any client library classes that makes the API easier to build against.

Connecting to the API

The URL of the API is https://server-address /view-vlsi/sdk

Client library

The client library provides a Connection class to easily connect to the API. This class will be needed to use much of the client library code.

// Uses try-with-resources to ensure connection is cleaned up after completion.
try (Connection connection = new Connection("https://_server-address_ /view-vlsi/sdk")) {
connection.login(username, password, domain);

// Do work
}

If a certificate override is needed this can be accomplished using the HttpConfiguration settings.

HttpConfiguration httpConfig = HttpConfiguration.Factory.newInstance();
httpConfig.setThumbprintVerifier(new ThumbprintVerifier() {

public Result verify(String thumbprint) {
if (acceptedThumbprint == null) {
return Result.UNKNOWN;
} else if (acceptedThumbprint.equals(thumbprint)) {
return Result.MATCH;
} else {
return Result.MISMATCH;
}
}

public void onSuccess(X509Certificate[] chain,
String thumbprint,
Result verifyResult,
boolean trustedChain,
boolean verifiedAssertions)
throws SSLException {
}
});

// Uses try-with-resources to ensure connection is cleaned up after completion.
try (Connection connection = new Connection("https://server-address/view-vlsi/sdk", httpConfig)) {
connection.login(username, password, domain);

// Do work
}

The View API Reference is set of documents, grouped by platform version. Use the navigation menu to the left to select the version, then the Service, Query, Data Object, Fault Types links to display information. To find the description of a specific object type, click the appropriate category name from the menu.

To quickly find an entry, start typing its name in the Search Bar field.

Notes

  • The maximum supported size of any array input to the API is 1000 data objects.