GET – Action info of SubmitTestMetricReport
Use the GET method to retrieve properties in action info resource of SubmitTestMetricReport.
Request URL
GET https://<BMC_IPADDR>redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo
Request body
None
Response body
Field | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
Id | String | “SubmitTestMetricReport”. | ||||||
Name | String | “SubmitTestMetricReport”. | ||||||
Description | String | This action is used to generate a metric report. | ||||||
Parameters | Array | Items: object Item count: 2 | ||||||
Parameters[1] | Object | Expanded | ||||||
Name | String | “MetricReportName” | ||||||
DataType | String | “String” | ||||||
Required | String | true | ||||||
Parameters[2] | Object | Expanded | ||||||
Name | String | "GeneratedMetricReportValues" | ||||||
DataType | String | “ObjectArray” | ||||||
ObjectDataType | String | Expanded | ||||||
Required | Boolean | true |
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Example
The following example JSON response is returned:
{
"@odata.type": "#ActionInfo.v1_1_0.ActionInfo",
"Id": "SubmitTestMetricReport",
"@odata.id": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo",
"Parameters": [
{
"Required": true,
"Name": "MetricReportName",
"DataType": "String"
},
{
"ObjectDataType": "#TelemetryService.v1_1_0.MetricValue",
"Required": false,
"Name": "GeneratedMetricReportValues",
"DataType": "ObjectArray"
}
],
"Name": "SubmitTestMetricReport",
"Description": "This action is used to generate a metric report."
}
Give documentation feedback