Specifying a REST schema version
Background: During release development, the TrueSight Server Automation REST schema typically undergoes a few changes (additions or modifications to attributes/elements). These changes might be incompatible with TrueSight Server Automation REST clients that need a specific REST schema version.
If you need to use a specific version of the REST schema, you can set it in two ways:
- On the Application Server, use the blasadmin utility to set the default schema to use for REST requests and responses. Example:
set AppServer DefaultRestVersion 8.1.02
For more information, see Specifying-configuration-options. - Use the version argument in each REST call to the Application Server. This argument specifies which schema version to use when processing the call. This method lets each application use its own version of REST to communicate with TrueSight Server Automation. Using this method is important if a you have more than one application using REST to communicate with TrueSight Server Automation. The version argument is optional:
- If you do not include the version argument in your call, TrueSight Server Automation uses the version specified by the blasadmin option, DefaultRestVersion.
- If you do include the version argument in your call, the value in the call overrides the value set by the blasadmin option, DefaultRestVersion.
Specify the schema version you want to use to process requests and responses. Using the MajorVersion.MinorVersion.ServicePackVersion syntax, you can specify a major version, a minor version, or a service pack. For example:
- Specify a major version: version=8
- Specify a minor version: version=8.1
- Specify a service pack: version=8.1.02
Sample schema version request
https://myAppServer:9843/type/PropertySetClasses/SystemObject/Server/
version=8.1.02&username=BlAdmin&password=foo&role=BLAdmins
https://myAppServer:9843/group/Servers/myServers/?username=CMAdmin&password=foo&role=CMAdmins&BQUERY=
SELECT%20*%20FROM%20%22SystemObject%2FServer%22
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*