From c976c87be0c3dad695fe396b53f919dff914ffe8 Mon Sep 17 00:00:00 2001 From: group_31_bot_3987b21aca711ada7a62244c5bebe985 Date: Wed, 20 Aug 2025 18:47:38 +0200 Subject: [PATCH] Autogenerated openapi version v030101 --- MEC045_QoSMeasurementApi.yaml | 1042 +++++++++++++++++++++++++++++++++ 1 file changed, 1042 insertions(+) create mode 100644 MEC045_QoSMeasurementApi.yaml diff --git a/MEC045_QoSMeasurementApi.yaml b/MEC045_QoSMeasurementApi.yaml new file mode 100644 index 0000000..55f3594 --- /dev/null +++ b/MEC045_QoSMeasurementApi.yaml @@ -0,0 +1,1042 @@ +openapi: 3.1.0 +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema +info: + contact: + url: https://forge.etsi.org/rep/mec/gs045-qos-mea-api + title: ETSI GS MEC 045 QoS Measurement API + version: 3.1.1 + description: ETSI GS MEC 045 QoS Measurement API described using OpenAPI. + license: + name: BSD-3-Clause + url: https://forge.etsi.org/legal-matters +servers: +- url: https://localhost/qms/v1 +paths: + /subscriptions: + get: + summary: Retrieve information about a list of subscriptions. . + description: The GET method is used to retrieve information about a list of subscriptions. + operationId: SubscriptionsGET + tags: + - subscriptions + parameters: + - $ref: '#/components/parameters/Query.Subscriptionid' + - $ref: '#/components/parameters/Query.Subscriptiontype' + responses: + '200': + description: Upon success, a response body containing the list of links to requestor's subscriptions is returned. + content: + application/json: + schema: + type: object + properties: + NotificationSubscriptionList: + $ref: '#/components/schemas/NotificationSubscriptionList' + '400': + $ref: '#/components/responses/400' + '404': + $ref: '#/components/responses/404' + '403': + $ref: '#/components/responses/403' + '414': + $ref: '#/components/responses/414' + post: + summary: Create an individual subscription. + description: The POST method is used to create an individual subscription. + operationId: SubscriptionsPOST + tags: + - subscriptions + requestBody: + description: 'The entity body in the request contains data type of QoS measurement subscription that is to be created, where the data type options are listed below and defined in clauses 6.3.2 and 6.3.3: + + QoSMeasureSubscription. + + QoSEventSubscription.' + content: + application/json: + schema: + type: object + properties: + QoSMeasureSubscription: + $ref: '#/components/schemas/QoSMeasureSubscription' + responses: + '201': + description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field. + + In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below and as defined in clauses 6.3.2 and 6.3.3: + + QoSMeasureSubscription. + + QoSEventSubscription.' + content: + application/json: + schema: + type: object + properties: + QoSMeasureSubscription: + $ref: '#/components/schemas/QoSMeasureSubscription' + '400': + $ref: '#/components/responses/400' + '404': + $ref: '#/components/responses/404' + '403': + $ref: '#/components/responses/403' + callbacks: + notification: + '{$request.body#/callbackUri}': + post: + summary: Callback POST used to send a notification + description: Subscription notification + operationId: notificationPOST173488 + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + type: object + properties: + subscriptionNotification: + oneOf: + - $ref: '#/components/schemas/QoSMeasureSubscription' + - $ref: '#/components/schemas/QoSEventSubscription' + responses: + '204': + description: No content + '404': + description: Not found + parameters: [] + /subscriptions/{subscriptionId}: + get: + summary: Retrieve information about a specific subscription. + description: The GET method is used to retrieve information about an individual subscription. + operationId: SubscriptionsGETSubscriptionid + tags: + - subscriptions + responses: + '200': + description: 'Upon success, a response body containing data type describing the QoS measurement subscription is returned. The allowed data types for subscriptions are defined in clauses 6.3.2 and 6.3.3: + + QoSMeasureSubscription. + + QoSEventSubscription.' + content: + application/json: + schema: + type: object + properties: + QoSMeasureSubscription: + $ref: '#/components/schemas/QoSMeasureSubscription' + '400': + $ref: '#/components/responses/400' + '404': + $ref: '#/components/responses/404' + '403': + $ref: '#/components/responses/403' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string + put: + summary: Modify the information about a specific subscription. + description: The PUT method is used to modify the information of an individual subscription. + operationId: SubscriptionsPUTSubscriptionid + tags: + - subscriptions + requestBody: + description: 'New NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clauses 6.3.2 and 6.3.3: + + QoSMeasureSubscription. + + QoSEventSubscription.' + content: + application/json: + schema: + type: object + properties: + QoSMeasureSubscription: + $ref: '#/components/schemas/QoSMeasureSubscription' + responses: + '200': + description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clauses 6.3.2 and 6.3.3: + + QoSMeasureSubscription. + + QoSEventSubscription.' + content: + application/json: + schema: + type: object + properties: + QoSMeasureSubscription: + $ref: '#/components/schemas/QoSMeasureSubscription' + '400': + $ref: '#/components/responses/400' + '404': + $ref: '#/components/responses/404' + '403': + $ref: '#/components/responses/403' + '412': + $ref: '#/components/responses/412' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string + delete: + summary: Delete a specific subscription. + description: The DELETE method is used to delete an individual subscription. + operationId: SubscriptionsDELETESubscriptionid + tags: + - subscriptions + responses: + '204': + $ref: '#/components/responses/204' + '404': + $ref: '#/components/responses/404' + '403': + $ref: '#/components/responses/403' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string +components: + schemas: + ProblemDetails: + type: object + properties: + type: + type: string + format: uri + description: A URI reference according to IETF RFC 3986 that identifies the problem type + title: + type: string + description: A short, human-readable summary of the problem type + status: + type: integer + format: uint32 + description: The HTTP status code for this occurrence of the problem + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + instance: + type: string + format: uri + description: A URI reference that identifies the specific occurrence of the problem + SerializerType: + x-etsi-ref: 8.1.6.3 + type: string + enum: + - JSON + - XML + - PROTOBUF3 + x-etsi-mec-extensible: true + x-etsi-mec-enumeration-table: + - value: JSON + description: Javascript object notation [9] + - value: XML + description: eXtensible Mark-up Language version 1.1 [10] + - value: PROTOBUF3 + description: Protocol buffers version 3 [i.3] + MetricType: + x-etsi-ref: 6.6.3 + type: string + enum: + - LATENCY + - JITTER + - THROUGHPUT + - LOSS_RATE + - ERROR_RATE + x-etsi-mec-extensible: true + x-etsi-mec-enumeration-table: + - value: LATENCY + description: The latency of the measured traffic. + - value: JITTER + description: The jitter of the measured traffic. + - value: THROUGHPUT + description: The throughput of the measured traffic. + - value: LOSS_RATE + description: The packet loss rate of the measured traffic. + - value: ERROR_RATE + description: The packet error rate of the measured traffic. + QoSEvent: + x-etsi-ref: 6.6.4 + type: string + enum: + - ABOVE_UPPER_THRESHOLD + - BELOW_LOWER_THRESHOLD + x-etsi-mec-extensible: true + x-etsi-mec-enumeration-table: + - value: ABOVE_UPPER_THRESHOLD + description: The event represents the value is above the upper threshold. + - value: BELOW_LOWER_THRESHOLD + description: The event represents the value is below the lower threshold. + Uri: + type: string + format: uri + description: Uniform Resource Identifier (URI) + NotificationSubscriptionList: + x-etsi-ref: 6.3.1 + type: object + properties: + subscription: + type: array + items: + $ref: '#/components/schemas/Subscription' + resourceURL: + description: Self-referring URL. + $ref: '#/components/schemas/LinkType' + required: + - resourceURL + QoSMeasureSubscription: + x-etsi-ref: 6.3.2 + type: object + properties: + subscriptionType: + description: Shall be set to "QoSMeasureSubscription". + type: string + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri + requestTestNotification: + description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [2], clause 6.12a." + type: boolean + websockNotifConfig: + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. + $ref: '#/components/schemas/WebsockNotifConfig' + _links: + $ref: '#/components/schemas/_links' + users: + description: 'Address of user (e.g. ''sip'' URI, ''tel'' URI, ''acr'' URI). + + See note 2.' + type: array + minItems: 0 + items: + type: string + format: uri + flowInfo: + type: array + items: + $ref: '#/components/schemas/FlowInfo' + numberOfReports: + description: 'If not present, the subscription is active until it is actively terminated via HTTP DELETE. + + If present, it determines the number of reports to be sent until the subscription gets automatically terminated.' + type: integer + format: uint32 + reportingInterval: + description: 'The reportingInterval determines the interval between two contiguous reports. + + The unit is second.' + type: integer + format: uint32 + measuringPeriod: + description: "It determines measuring frequency. \nThe measuringPeriod shall be less than or equal to reportingInterval.\nThe unit is second. " + type: integer + format: uint32 + measuringArea: + type: array + items: + $ref: '#/components/schemas/MeasuringArea' + measuringTime: + type: array + items: + $ref: '#/components/schemas/MeasuringTime' + metricType: + description: The expected measuring result type. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/MetricType' + expiryDeadline: + description: The expiration time of the subscription determined by the QoS Measurement Subscribe Service. + $ref: '#/components/schemas/TimeStamp' + required: + - subscriptionType + - measuringPeriod + - metricType + description: "|-\n NOTE 1: \tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [2], clause 6.12a.\nNOTE 2:\tAt least one of users and flowInfo shall be provided by the service consumer.\nNOTE 3:\tAs specified in [3], clause 5.2.2.7." + QoSEventSubscription: + x-etsi-ref: 6.3.3 + type: object + properties: + subscriptionType: + description: Shall be set to "QoSEventSubscription". + type: string + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri + requestTestNotification: + description: "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS\_MEC 009 [2], clause 6.12a." + type: boolean + websockNotifConfig: + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. + $ref: '#/components/schemas/WebsockNotifConfig' + _links: + $ref: '#/components/schemas/_links' + users: + description: 'Address of user (e.g. ''sip'' URI, ''tel'' URI, ''acr'' URI). + + See note 2.' + type: array + minItems: 0 + items: + type: string + format: uri + flowFilter: + type: array + items: + $ref: '#/components/schemas/FlowFilter1' + reportTrigger: + type: array + items: + $ref: '#/components/schemas/ReportTrigger' + reportingCtrl: + description: Provides parameters that ctrl the reporting. + $ref: '#/components/schemas/ReportingCtrl' + measuringPeriod: + description: "It determines measuring frequency. \nThe unit is second. " + type: integer + format: uint32 + monitoringArea: + type: array + items: + $ref: '#/components/schemas/MonitoringArea' + monitoringTime: + type: array + items: + $ref: '#/components/schemas/MonitoringTime' + expiryDeadline: + description: The expiration time of the subscription determined by the QoS Measurement Subscribe Service. + $ref: '#/components/schemas/TimeStamp' + required: + - subscriptionType + - reportTrigger + - measuringPeriod + description: "|-\n NOTE 1: \tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [2], clause 6.12a.\nNOTE 2:\tAt least one of users and flowFilter shall be provided by the service consumer.\nNOTE 3:\tAs specified in [3], clause 5.2.2.7." + TestNotification: + x-etsi-ref: 6.4.1 + type: object + properties: + notificationType: + description: Shall be set to "TestNotification". + type: string + _links: + $ref: '#/components/schemas/_links1' + required: + - notificationType + - _links + QoSMeasureNotification: + x-etsi-ref: 6.4.2 + type: object + properties: + notificationType: + description: Shall be set to "QoSMeasureNotification". + type: string + timeStamp: + description: Time stamp. + $ref: '#/components/schemas/TimeStamp' + subscriptionState: + type: string + enum: + - SEE_DESCRIPTION + description: 'It shall be absent if the related subscription has no numberOfReports attribute, and shall be present otherwise. + + ACTIVE: the subscription is active. + + FINISHED: This is the last report and the subscription is subject to automatic termination.' + qoSMeasureResult: + type: array + items: + $ref: '#/components/schemas/QoSMeasureResult' + _links: + $ref: '#/components/schemas/_links2' + required: + - notificationType + - _links + description: "|-\n NOTE 1:\tThe attributes of latency, jitter, throughput, loss_rate, and error_rate should be present according to corresponding subscription.\nNOTE 2:\tAs specified in [3], clause 5.2.2.7." + QoSEventNotification: + x-etsi-ref: 6.4.3 + type: object + properties: + notificationType: + description: Shall be set to "QoSEventNotification". + type: string + timeStamp: + description: Time stamp. + $ref: '#/components/schemas/TimeStamp' + subscriptionState: + type: string + enum: + - SEE_DESCRIPTION + description: 'It shall be absent if the related subscription has no numberOfReports attribute, and shall be present otherwise. + + ACTIVE: The subscription is active. + + FINISHED: This is the last report and the subscription is subject to automatic termination.' + user: + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). Present if user has been provided in subscription. + type: string + format: uri + flow: + $ref: '#/components/schemas/Flow1' + metricType: + description: The monitoring metric type. + $ref: '#/components/schemas/MetricType' + qosEvent: + description: The reporting event. + $ref: '#/components/schemas/QoSEvent' + measuringArea: + $ref: '#/components/schemas/MeasuringArea2' + _links: + $ref: '#/components/schemas/_links2' + required: + - notificationType + - flow + - metricType + - qosEvent + - _links + description: "|-\n NOTE 1:\tThe attributes of latency, jitter, throughput, loss_rate, and error_rate should be present according to corresponding subscription.\nNOTE 2:\tAs specified in [3], clause 5.2.2.7." + WebsockNotifConfig: + x-etsi-ref: 6.5.2 + type: object + properties: + websocketUri: + description: Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications. + type: string + format: uri + requestWebsocketUri: + description: Set to true by the service consumer to indicate that Websocket delivery is requested. + type: boolean + AreaInfo: + x-etsi-ref: 6.5.3 + type: object + properties: + shape: + type: integer + enum: + - 1 + - 2 + description: 'The shape of the area monitored: + + 1 = CIRCLE. + + 2 = POLYGON.' + points: + description: Shall include one point if the shape is CIRCLE. Shall include 3-15 points if the shape is POLYGON. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Point' + radius: + description: Shall be present if the shape is CIRCLE. + type: integer + required: + - shape + - points + Point: + x-etsi-ref: 6.5.4 + type: object + properties: + latitude: + description: "Location latitude, expressed in the range -90\xB0 to +90\xB0." + type: number + format: float + longitude: + description: "Location longitude, expressed in the range -180\xB0 to +180\xB0." + type: number + format: float + required: + - latitude + - longitude + TimeStamp: + x-etsi-ref: 6.5.5 + type: object + properties: + seconds: + description: 'The seconds part of the time. Time is defined as + + Unix-time since January 1, 1970, 00:00:00 UTC.' + type: integer + format: uint32 + nanoSeconds: + description: 'The nanoseconds part of the time. Time is defined as + + Unix-time since January 1, 1970, 00:00:00 UTC.' + type: integer + format: uint32 + required: + - seconds + - nanoSeconds + ReportingCtrl: + x-etsi-ref: 6.5.6 + type: object + properties: + minimumInterval: + description: Minimum interval between reports in case frequently reporting. Unit is second. + type: integer + maximumFrequency: + description: Maximum frequency (in seconds) of notifications per subscription. + type: integer + maximumCount: + description: Maximum number of notifications. For no maximum, either do not include this element or specify a value of zero. Default value is 0. + type: integer + LinkType: + x-etsi-ref: 6.6.2 + type: object + properties: + href: + description: URI referring to a resource. + type: string + format: uri + required: + - href + Subscription: + description: '' + type: object + properties: + href: + description: The URI referring to the subscription. + type: string + format: uri + subscriptionType: + description: 'Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type defined in clauses 6.3.2 and 6.3.3: + + "QoSMeasureSubscription". + + "QoSEventSubscription".' + type: string + required: + - href + - subscriptionType + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + type: object + properties: + self: + description: Self-referring URI. The URI shall be unique within the QoS measurement Subscribe as it acts as an ID for the subscription. + $ref: '#/components/schemas/LinkType' + required: + - self + FlowFilter: + description: Traffic flow filtering criteria. If the flowFilter field is included, at least one of its subfields shall be included. Any flowFilter subfield that is not included shall be ignored in traffic flow filtering. + type: object + properties: + sourceIp: + description: Source address identity of measured flow (including range). + type: string + sourcePort: + description: Source port identity of measured flow. + type: array + minItems: 0 + items: + type: integer + format: uint32 + dstIp: + description: Destination address identity of measured flow (including range). + type: string + dstPort: + description: Destination port identity of measured flow. + type: array + minItems: 0 + items: + type: integer + format: uint32 + protocol: + description: Protocol number. + type: integer + format: uint32 + dscp: + description: DSCP in the IPv4 header or Traffic Class in the IPv6 header. + type: integer + format: uint32 + flowlabel: + description: Flow Label in the IPv6 header, applicable only if the flow is IPv6. + type: integer + format: uint32 + FlowInfo: + description: 'The information of the measured flows. + + See note 2.' + type: object + properties: + samplingRate: + description: 'The sampling rate determines the proportion of flows that meet the flowFilter to be measured. If not present, all the flows that meet the flowFilter need to be measured. + + The value should be an integer from 1 to 100. If half of the qualified flows need to be measured, the value should be set to 50.' + type: integer + format: uint32 + flowFilter: + $ref: '#/components/schemas/FlowFilter' + required: + - flowFilter + MeasuringArea: + description: Area constraint for the measuring task. Traffic of users entering the area will be measured. + type: object + properties: + areaInfo: + description: It describes the measured area. It shall be present if accessPointId and zoneId are not present. + $ref: '#/components/schemas/AreaInfo' + accessPointId: + description: The identity of the access point the user is currently on, see note 3. + type: string + zoneId: + description: The identity of the zone the user is currently within, see note 3. + type: string + MeasuringTime: + description: 'Time constraint for the measuring task. If present, the monitoring task is working only at this specific time section. + + The time section of [startTime, endTime] may across the midnight.' + type: object + properties: + startTime: + description: The format is a string representing the hour, and the minute in a day, like "14:30". + type: string + endTime: + description: The format is a string representing the hour, and the minute in a day, like "14:30". + type: string + required: + - startTime + - endTime + FlowFilter1: + description: 'Traffic flow filtering criteria. If the flowFilter field is included, at least one of its subfields shall be included. Any flowFilter subfield that is not included shall be ignored in traffic flow filtering. + + See note 2.' + type: object + properties: + sourceIp: + description: Source address identity of measured flow (including range). + type: string + sourcePort: + description: Source port identity of measured flow + type: array + minItems: 0 + items: + type: integer + format: uint32 + dstIp: + description: Destination address identity of measured flow (including range). + type: string + dstPort: + description: Destination port identity of measured flow. + type: array + minItems: 0 + items: + type: integer + format: uint32 + protocol: + description: Protocol number. + type: integer + format: uint32 + dscp: + description: DSCP in the IPv4 header or Traffic Class in the IPv6 header. + type: integer + format: uint32 + flowlabel: + description: Flow Label in the IPv6 header, applicable only if the flow is IPv6. + type: integer + format: uint32 + ReportTrigger: + description: The trigger leading to the notification. + type: object + properties: + metricType: + description: The monitoring metric type. + $ref: '#/components/schemas/MetricType' + upperThreshold: + description: Threshold which if crossed upward shall cause a notification. + type: integer + format: uint32 + lowerThreshold: + description: Threshold which if crossed downward shall cause a notification. + type: integer + format: uint32 + required: + - metricType + MonitoringArea: + description: 'Area constraint for the monitoring task. ' + type: object + properties: + areaInfo: + description: It describes the measured area. It shall be present if accessPointId and zoneId are not present. + $ref: '#/components/schemas/AreaInfo' + accessPointId: + description: The identity of the access point the user is currently on, see note 3. + type: string + zoneId: + description: The identity of the zone the user is currently within, see note 3. + type: string + MonitoringTime: + description: 'Time in a day for the monitoring task. If present, the monitoring task is working only at this specific time section. + + The time section of [startTime, endTime] may across the midnight.' + type: object + properties: + startTime: + description: The format is a string representing the hour, and the minute in a day, like "14:30". + type: string + endTime: + description: The format is a string representing the hour, and the minute in a day, like "14:30". + type: string + required: + - startTime + - endTime + _links1: + description: 'Hyperlink related to the resource. ' + type: object + properties: + subscription: + description: URI identifying the subscription for the test notification. + $ref: '#/components/schemas/LinkType' + required: + - subscription + Flow: + description: Flow information. + type: object + properties: + sourceIp: + description: Source address identity. + type: string + sourcePort: + description: Source port identity. + type: integer + format: uint32 + dstIp: + description: Destination address identity. + type: string + dstPort: + description: Destination port identity. + type: integer + format: uint32 + protocol: + description: Protocol number. + type: integer + format: uint32 + dscp: + description: DSCP in the IPv4 header or Traffic Class in the IPv6 header. + type: integer + format: uint32 + flowlabel: + description: Flow Label in the IPv6 header, applicable only if the flow is IPv6 + type: integer + format: uint32 + required: + - sourceIp + - sourcePort + - dstIp + - dstPort + MeasuringArea1: + description: The area information for measurement reporting. + type: object + properties: + areaInfo: + description: It shall be present if accessPointId and zoneId are not present. + $ref: '#/components/schemas/AreaInfo' + accessPointId: + description: The identity of the access point which the user is currently on, see note 2. + type: string + zoneId: + description: The identity of the zone which the user is currently within, see note 2. + type: string + MeasuringTime1: + description: The time section for measurement reporting. + type: object + properties: + startTime: + description: Start time for measurement. + $ref: '#/components/schemas/TimeStamp' + endTime: + description: End time for measurement. + $ref: '#/components/schemas/TimeStamp' + required: + - startTime + - endTime + QoSMeasureResult: + description: The QoS measuring result. + type: object + properties: + user: + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). Present if user has been provided in subscription. + type: string + format: uri + flow: + $ref: '#/components/schemas/Flow' + measuringArea: + $ref: '#/components/schemas/MeasuringArea1' + measuringTime: + $ref: '#/components/schemas/MeasuringTime1' + latency: + description: See note 1. The Unit is millisecond. + type: integer + format: uint32 + jitter: + description: See note 1. The Unit is millisecond. + type: integer + format: uint32 + throughput: + description: See note 1. The Unit is kbit/s. + type: integer + format: uint64 + loss_rate: + description: See note 1. The integer represents percent. + type: integer + format: uint32 + error_rate: + description: See note 1. The integer represents percent. + type: integer + format: uint32 + required: + - flow + _links2: + description: Object containing hyperlinks related to the resource. + type: object + properties: + subscription: + description: A link to the related subscription. + $ref: '#/components/schemas/LinkType' + required: + - subscription + Flow1: + description: Flow information. + type: object + properties: + sourceIp: + description: Source address identity. + type: string + sourcePort: + description: Source port identity. + type: integer + format: uint32 + dstIp: + description: Destination address identity. + type: string + dstPort: + description: Destination port identity. + type: integer + format: uint32 + protocol: + description: Protocol number. + type: integer + format: uint32 + dscp: + description: DSCP in the IPv4 header or Traffic Class in the IPv6 header. + type: integer + format: uint32 + flowlabel: + description: Flow Label in the IPv6 header, applicable only if the flow is IPv6. + type: integer + format: uint32 + required: + - sourceIp + - sourcePort + - dstIp + - dstPort + MeasuringArea2: + description: The area information for event reporting. + type: object + properties: + areaInfo: + description: It shall be present if accessPointId and zoneId are not present. + $ref: '#/components/schemas/AreaInfo' + accessPointId: + description: The identity of the access point which the user is currently on, see note 2. + type: string + zoneId: + description: The identity of the zone which the user is currently within, see note 2. + type: string + responses: + '200': + description: OK + '204': + description: No Content + '400': + description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized: used when the client did not submit credentials.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden: operation is not allowed given the current status of the resource.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found: used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable: used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '412': + description: 'Precondition failed: used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '414': + description: 'URI Too Long: It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '415': + description: 'Unsupported Media Type: used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '422': + description: 'Unprocessable Entity: used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests: used when a rate limiter has triggered.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + parameters: + Query.Subscriptionid: + description: Multiple subscriptionId may be used as an input parameter to query a list of subscriptions. + name: subscriptionid + in: query + required: false + x-exportParamName: Query.Subscriptionid + schema: + type: array + items: + type: string + Query.Subscriptiontype: + description: subscriptionType may be used as an input parameter to query the availability of a list of subscriptions. + name: subscriptiontype + in: query + required: false + x-exportParamName: Query.Subscriptiontype + schema: + type: string + -- GitLab