1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/MetricReport.v1_5_1.json",
3    "$ref": "#/definitions/MetricReport",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "MetricReport": {
35            "additionalProperties": false,
36            "description": "The `MetricReport` schema represents a set of collected metrics.",
37            "longDescription": "This resource shall represent a metric report in a Redfish implementation.  When a metric report is deleted, the historic metric data used to generate the report shall be deleted as well unless other metric reports are consuming the data.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {
53                "@odata.context": {
54                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
55                },
56                "@odata.etag": {
57                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
58                },
59                "@odata.id": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
61                },
62                "@odata.type": {
63                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
64                },
65                "Actions": {
66                    "$ref": "#/definitions/Actions",
67                    "description": "The available actions for this resource.",
68                    "longDescription": "This property shall contain the available actions for this resource."
69                },
70                "Context": {
71                    "description": "A context can be supplied at subscription time.  This property is the context value supplied by the subscriber.",
72                    "longDescription": "This property shall contain a client supplied context for the event destination to which this event is being sent.  This property shall only be present when sent as a payload in an event.",
73                    "readonly": true,
74                    "type": "string",
75                    "versionAdded": "v1_4_0"
76                },
77                "Description": {
78                    "anyOf": [
79                        {
80                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
81                        },
82                        {
83                            "type": "null"
84                        }
85                    ],
86                    "readonly": true
87                },
88                "Id": {
89                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
90                    "readonly": true
91                },
92                "MetricReportDefinition": {
93                    "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinition.json#/definitions/MetricReportDefinition",
94                    "description": "The link to the definition of this metric report.",
95                    "longDescription": "This property shall contain a link to a resource of type `MetricReportDefinition`.",
96                    "readonly": true
97                },
98                "MetricValues": {
99                    "description": "An array of metric values for the metered items of this metric report.",
100                    "items": {
101                        "$ref": "#/definitions/MetricValue"
102                    },
103                    "longDescription": "The values shall be metric values for this metric report.",
104                    "type": "array"
105                },
106                "Name": {
107                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
108                    "readonly": true
109                },
110                "Oem": {
111                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
112                    "description": "The OEM extension property.",
113                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
114                },
115                "ReportSequence": {
116                    "deprecated": "This property has been deprecated due to specification changes with regards to Server-Sent Events.",
117                    "description": "The current sequence identifier for this metric report.",
118                    "longDescription": "This property shall contain the current sequence identifier for this metric report.  The sequence identifier is a unique identifier assigned by the service for serializing metric reports as they are produced.",
119                    "readonly": true,
120                    "type": "string",
121                    "versionDeprecated": "v1_3_0"
122                },
123                "Timestamp": {
124                    "description": "The time associated with the metric report in its entirety.  The time of the metric report can be relevant when the time of individual metrics are minimally different.",
125                    "format": "date-time",
126                    "longDescription": "This property shall contain the time when the metric report was generated.",
127                    "readonly": true,
128                    "type": [
129                        "string",
130                        "null"
131                    ],
132                    "versionAdded": "v1_1_0"
133                }
134            },
135            "required": [
136                "@odata.id",
137                "@odata.type",
138                "Id",
139                "Name"
140            ],
141            "type": "object"
142        },
143        "MetricValue": {
144            "additionalProperties": false,
145            "description": "Properties that capture a metric value and other associated information.",
146            "longDescription": "This type shall contain properties that capture a metric value and other associated information.",
147            "patternProperties": {
148                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
149                    "description": "This property shall specify a valid odata or Redfish property.",
150                    "type": [
151                        "array",
152                        "boolean",
153                        "integer",
154                        "number",
155                        "null",
156                        "object",
157                        "string"
158                    ]
159                }
160            },
161            "properties": {
162                "MetricDefinition": {
163                    "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition",
164                    "deprecated": "This property has been deprecated in favor of the `MetricId` property.",
165                    "description": "The link to the metric definition for this metric.",
166                    "longDescription": "This property shall contain a link to a resource of type `MetricDefinition` that describes what this metric value captures.",
167                    "readonly": true,
168                    "versionDeprecated": "v1_5_0"
169                },
170                "MetricId": {
171                    "description": "The metric definitions identifier that contains additional information for the source metric.",
172                    "longDescription": "This property shall contain the value of the `Id` property of the `MetricDefinition` resource that contains additional information for the source metric.",
173                    "readonly": true,
174                    "type": [
175                        "string",
176                        "null"
177                    ]
178                },
179                "MetricProperty": {
180                    "description": "The URI for the property from which this metric is derived.",
181                    "format": "uri-reference",
182                    "longDescription": "This property shall contain a URI following RFC6901-specified JSON pointer notation to the property from which this metric is derived.  The value of `MetricValue` may contain additional calculations performed on the property based upon the configuration of the `MetricReportDefinition`.",
183                    "readonly": true,
184                    "type": [
185                        "string",
186                        "null"
187                    ]
188                },
189                "MetricValue": {
190                    "description": "The metric value, as a string.",
191                    "longDescription": "This property shall contain the metric value, as a string.",
192                    "readonly": true,
193                    "type": [
194                        "string",
195                        "null"
196                    ]
197                },
198                "Oem": {
199                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
200                    "description": "The OEM extension property.",
201                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
202                    "versionAdded": "v1_2_0"
203                },
204                "Timestamp": {
205                    "description": "The date and time when the metric is obtained.  A management application can establish a time series of metric data by retrieving the instances of metric value and sorting them according to their timestamp.",
206                    "format": "date-time",
207                    "longDescription": "The value shall time when the metric value was obtained.  Note that this value may be different from the time when this instance is created.",
208                    "readonly": true,
209                    "type": [
210                        "string",
211                        "null"
212                    ]
213                }
214            },
215            "type": "object"
216        },
217        "OemActions": {
218            "additionalProperties": true,
219            "description": "The available OEM-specific actions for this resource.",
220            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
221            "patternProperties": {
222                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
223                    "description": "This property shall specify a valid odata or Redfish property.",
224                    "type": [
225                        "array",
226                        "boolean",
227                        "integer",
228                        "number",
229                        "null",
230                        "object",
231                        "string"
232                    ]
233                }
234            },
235            "properties": {},
236            "type": "object"
237        }
238    },
239    "language": "en",
240    "owningEntity": "DMTF",
241    "release": "2022.2",
242    "title": "#MetricReport.v1_5_1.MetricReport"
243}