REST API for retrieving the License Metric Tool version

Edit online

You use the GET operation on the api/sam/about element to request information about the version of License Metric Tool.

Resource URL

To retrieve information about the current version of License Metric Tool, use the following URL: 
https://server_url:server_port/api/sam/about?token=token

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns the version of License Metric Tool
HTTP method GET
Resource URI https://server_host_name:port_number/api/sam/about
Request headers
Accept-Language (optional)
  • Use: Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
  • Values: en-US (only English is supported)
Token
  • Use: Used to authenticate REST API requests. The header is required when you set the value of the api_token_in_url_enabled parameter to false. Otherwise, you can specify the token in the request header or in the URL. For more information, see: Authenticating REST API requests.
  • Values: an alphanumeric string that is generated in License Metric Tool
Request payload n/a
Request Content-Type
  • application/json
Response headers
Content-Type
  • Use: Specifies the content type of the response.
  • Values: application/json
Content-Language
  • Use: Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
  • Values: en-US, …
Response payload About element
Response Content-Type
  • application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 500 – “Bad Request” if a query parameter contains errors or is missing

Message body includes an error message with details.

Example HTTP conversation

Request
GET https://server_host_name:port_number/api/sam/about
Request header
Accept: application/json 
Accept-Language: en-US
Token: <token>
Response header
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
Response body (JSON)
{
"product": "IBM License Metric Tool",
"version": "9.2.20140331-2015"
}