Export of saved report views

Edit online

You use the GET operation on the api/reports/report_ID element to export a saved report view which can be then imported to another instance of License Metric Tool.

Resource URL

https://hostname:port/api/reports/report_ID

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns the saved report view with the specified ID.
HTTP method GET
Resource URI https://hostname:port/api/reports/report_ID
URI query parameters For a list of applicable query parameters, see: Query parameters.
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 Saved reports element
Response Content-Type
  • Application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 401- There is no match for the provided user name and password
  • 401 - You are not assigned a Computer Group. You will not be able to access the system until you are assigned a valid Computer Group. Contact your administrator for assistance
  • 404 - Sequel::RecordNotFound

For more details about each error code, check the tema.log log file that is in the install_dir/wlp/usr/servers/server1/logs/ directory.

Query parameters

You can use query parameters to narrow down the results of your search. The following table presents query parameters that you can use for the api/reports element.
Table 2. Query parameters for retrieving saved report views
Parameter Description Required Value
id An identifier of the saved report. To find the report identifier, open the saved report and check the last number in the report URL. In the following example, the report ID is 3.
hostname:port/sam/app_usage_property_values#cafcac39cd0b242b82729377b0b2b872d3af8d8a/3
 No Numeric

Example HTTP conversation

Request
GET https://hostname:port/api/reports/report_ID
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)
	{
	"id":1,
	"user_id":1,
	"pagestate_id":"eb5743b7cd23316f0bc8a4dd3f63b90d73549042",
	"name":"pvu_test",
	"path":"/sam/pvuonlysubcapreports",
	"private":true,
	"state":{
		"columns":["product","quantity","hwm_history"],
		"criteria":{"and":[["quantity",">","200"]]},
		"grid_options":["autosize_columns"],
		"order":{"asc":true,"col":null},
		"time_range":{
			"max":"2014-07-21T10:18:04Z",
			"min":"2014-04-21T22:00:00Z",
			"type":"absolute_to_now",
			"units":"days",
			"value":"90"
			},
		"column_order":{
			"hwm_history":1,
			"product":0,
			"quantity":2
			},
		"column_widths":{
			"hwm_history":180,
			"product":524,
			"quantity":719
		}}}