tungsten-api

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

name path methods description
TungstenApi
  • /api/v2/createAdminUser
  • /api/v2/deleteAdminUser
  • /api/v2/listAdminUsers
  • /api/v2/ping
  • /api/v2/rmiSecurity
  • /api/v2/tungstenVersion
  • /api/v2/user/{userName}
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
Defines API entry points common to all Tungsten components

Data Types

JSON

type description
Credentials
CredentialsPayload User/password information
Ping
PingPayload
RmiSecurityInfo
RmiSecurityPayload Whether encryption and authentication are defined for RMI/JMX
StringPL
StringPayload String payload for configuration values, simple descriptions or command results. The string is embedded in a superclass so that the json structure will look like: 
{
    "payloadType": "StringPayload",
    "payloadVersion": "1",
    "payload": 
    {
       "string"="stringvalue"
    }
}

This allows for further extension of the payload (eg. adding a field) without breaking backwards compatibility
TungstenPayload
URIsPayload List of URIs to list underlying possible API calls
Version
VersionPayload Holds tungsten version information in tungstenVersion with convenient access to the individual values:product and version min/maj/rev