* @member deviceAuthenticationInfo Information needed for secondary authentication of the IoT device to the data network
* @member deviceMetadata Additional information about the IoT device
* @member gpsi GPSI of the IoT device if 5G-enabled
* @member pei PEI of the IoT device if 5G-enabled
* @member supi SUPI of the IoT device if 5G-enabled
* @member msisdn MSISDN of the IoT device if LTE-enabled
* @member imei IMEI of the IoT device if LTE-enabled
* @member imsi IMSI of the IoT device if LTE-enabled
* @member iccid ICCID of the IoT device
* @member deviceId Human-readable identifier of the IoT device
* @member requestedMecTrafficRule MEC traffic rules the IoT device is requested to be associated to
* @member requestedIotPlatformId IoT platform to which the IoT device is requested to be associated to
* @member deviceSpecificMessageFormats Format of the messages to be published by the MEC IoTS on the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device
* @member downlinkInfo Downlink communication configuration of the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device
* @member clientCertificate Client-side SSL/TLS certificate to be used by the MEC IoTS to interact with the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device
* @member enabled Indication whether the IoT device has a valid associated traffic rule (TRUE) or not (FALSE)
* @see ETSI GS MEC 033 V3.1.1 (2022-12) Table 6.2.2-1: Definition of type DeviceInfo
* @member eventMsgFormat Event message format configuration
* @member uplinkMsgFormat Uplink message format configuration
*/
typerecordDeviceSpecificMessageFormats{
EventMsgeventMsgFormatoptional,
UplinkMsguplinkMsgFormatoptional
}// End of type DeviceSpecificMessageFormats
/**
* @desc Downlink communication configuration of the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device
* @member downlinkTopic Topic associated to the IoT device
* @member devicePort UDP port to be used by the MEC IoTS for the outgoing downlink packets towards the IoT device
*/
typerecordDownlinkInfo{
Json.StringdownlinkTopicoptional,
Json.NumberdevicePortoptional
}// End of type DownlinkInfo
/**
* @desc Information associated to a IoT platform
* @member iotPlatformId Identifier of the IoT platform
* @member userTransportInfoInformation about the user transport(s) provided by the IoT platform
* @member customServicesTransportInfo Transport enabling access to vendor-specific services provided by the IoT platform. The data
* @member enabled Indication whether the IoT platform is capable of providing user transports and vendor-specific services (TRUE) or not (FALSE)
* @see ETSI GS MEC 033 V3.1.1 (2022-12) Table 6.2.3-1: Definition of type IotPlatformInfo
*/
typerecordIotPlatformInfo{
Json.StringiotPlatformId,
MBTransportInfoListuserTransportInfooptional,// optional on;ly for the 400 Bad Request TP
* @member eventTopics Topics used to publish events related to the established session between the IoT device(s) and the end IoT application(s) on the user transport
* @member uplinkTopics Topics used to publish data generated by the IoT device(s) on the user transport, in order to be consumed by the end IoT application(s)
* @member downlinkTopics Topics used to publish data generated by the IoT applications(s) on the user transport, in order to be consumed by the end IoT device(s)
* @see ETSI GS MEC 033 V3.1.1 (2022-12) Table 6.3.2-1: Definition of type MBTransportInfo
* @desc Defines the format of the messages to be published on the user transport in order to provide application-specific information about events related to the established session between the IoT device and the end IoT application(s)
* @member eventTopic Topic where the message containing application-specific information should be published
* @member selectedSerializer Type of serializer to be used for the topic as per ETSI GS MEC 011 [i.2]
* @member includeDeviceAddr Indication whether to include the IP address of the IoT device (TRUE) or not (FALSE)
* @member includeDeviceMetadata Indication whether to include the metadata about the IoT device (TRUE) or not (FALSE)
* @member includeSupi Indication whether to include the SUPI of the IoT device (TRUE) or not (FALSE)
* @member includeImsi Indication whether to include the IMSI of the IoT device (TRUE) or not (FALSE)
* @member inclueIccid Indication whether to include the ICCID of the IoT device (TRUE) or not (FALSE)
* @member includeDeviceId Indication whether to include the humanreadable identified of the IoT device (TRUE) or not (FALSE)
* @member
* @see ETSI GS MEC 033 V3.1.1 (2022-12) Table 6.3.3-1: Definition of type EventMsg
* @desc Defines the format of the messages containing uplink data generated by the IoT device to be published on the user transport
* @member uplinkTopic Topic where the message containing the data generated by the IoT device(s) should be published, in order to be consumed by the end IoT application(s).
* @member selectedSerializer Type of serializer to be used for the topic as per ETSI GS MEC 011 [i.2]
* @member includeDeviceAddr Indication whether to include the IP address of the IoT device (TRUE) or not (FALSE)
* @member includeDeviceMetadata Indication whether to include the metadata about the IoT device (TRUE) or not (FALSE)
* @member includeSupi Indication whether to include the SUPI of the IoT device (TRUE) or not (FALSE)
* @member includeImsi Indication whether to include the IMSI of the IoT device (TRUE) or not (FALSE)
* @member inclueIccid Indication whether to include the ICCID of the IoT device (TRUE) or not (FALSE)
* @member includeDeviceId Indication whether to include the humanreadable identified of the IoT device (TRUE) or not (FALSE)
* @member
* @see ETSI GS MEC 033 V3.1.1 (2022-12) Table 6.3.4-1: Definition of type UplinkMsg
"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 : 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.",
"description":"Too Many Requests : used when a rate limiter has triggered.",
"content":{
"application/problem+json":{
"schema":{
"$ref":"#/components/schemas/ProblemDetails"
}
}
}
}
},
"parameters":{
"Path.AccessPointId":{
"name":"accessPointId",
"in":"path",
"description":"Identifier of access Point",
"required":true,
"schema":{
"type":"string"
},
"x-exportParamName":"AccessPointId"
},
"Path.SubscrId":{
"name":"subscriptionId",
"in":"path",
"description":"Subscription Identifier, specifically the \"self\" returned in the subscription request",
"required":true,
"schema":{
"type":"string",
"format":"uri"
},
"x-exportParamName":"SubscriptionId"
},
"Path.ZoneId":{
"name":"zoneId",
"in":"path",
"description":"Indentifier of zone",
"required":true,
"schema":{
"type":"string"
},
"x-exportParamName":"ZoneId"
},
"Query.AccessPointId":{
"name":"accessPointId",
"in":"query",
"description":"Identifier of access point",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"x-exportParamName":"AccessPointId"
},
"Query.Address":{
"name":"address",
"in":"query",
"description":"address of users (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"x-exportParamName":"Address"
},
"Query.AddressMandatory":{
"name":"address",
"in":"query",
"description":"address of users (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"required":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"x-exportParamName":"AddressMandatory"
},
"Query.InterestRealm":{
"name":"interestRealm",
"in":"query",
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"required":false,
"schema":{
"type":"string"
},
"x-exportParamName":"InterestRealm"
},
"Query.Latitude":{
"name":"latitude",
"in":"query",
"description":"Latitude geo position",
"required":false,
"schema":{
"type":"number",
"format":"float"
},
"x-exportParamName":"Latitude"
},
"Query.Longitude":{
"name":"longitude",
"in":"query",
"description":"Longitude geo position",
"required":false,
"schema":{
"type":"number",
"format":"float"
},
"x-exportParamName":"Longitude"
},
"Query.Requester":{
"name":"requester",
"in":"query",
"description":"Entity that is requesting the information",
"required":false,
"schema":{
"type":"string"
},
"x-exportParamName":"Requester"
},
"Query.ZoneId":{
"name":"zoneId",
"in":"query",
"description":"Identifier of zone",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"x-exportParamName":"ZoneId"
}
},
"schemas":{
"AccessPointInfo":{
"description":"A type containing access point information.",
"properties":{
"accessPointId":{
"description":"Identifier of access point.",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
},
"connectionType":{
"$ref":"#/components/schemas/ConnectionType"
},
"interestRealm":{
"description":"Interest realm of access point.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"locationInfo":{
"$ref":"#/components/schemas/LocationInfo"
},
"numberOfUsers":{
"description":"Number of users currently on the access point.",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"integer"
},
"operationStatus":{
"$ref":"#/components/schemas/OperationStatus"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"timezone":{
"description":"Time zone of access point.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"dateTimeStamp"
}
},
"required":[
"accessPointId",
"connectionType",
"operationStatus",
"numberOfUsers",
"resourceURL"
],
"type":"object"
},
"AccessPointList":{
"description":"A type containing list of access points.",
"properties":{
"accessPoint":{
"description":"Collection of the access point information list.",
"items":{
"$ref":"#/components/schemas/AccessPointInfo"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"AccessPointInfo"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
}
},
"required":[
"zoneId",
"resourceURL"
],
"type":"object"
},
"CallbackReference":{
"properties":{
"callbackData":{
"description":"Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"notificationFormat":{
"$ref":"#/components/schemas/NotificationFormat"
},
"notifyURL":{
"description":"Notify Callback URL",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"anyURI"
}
},
"required":[
"notifyURL"
],
"type":"object"
},
"CircleNotificationSubscription":{
"description":"A type containing data for notifications, when the area is defined as a circle.",
"properties":{
"address":{
"description":"Address of terminals to monitor (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"items":{
"type":"string"
},
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"anyURI"
},
"callbackReference":{
"$ref":"#/components/schemas/CallbackReference"
},
"checkImmediate":{
"description":"Check location immediately after establishing notification.",
"type":"boolean",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"boolean"
},
"clientCorrelator":{
"description":"A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"count":{
"description":"Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"int"
},
"duration":{
"description":"Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications.",
"description":"Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"int"
},
"latitude":{
"description":"Latitude of center point.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"float"
},
"link":{
"description":"Link to other resources that are in relationship with the resource.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"longitude":{
"description":"Longitude of center point.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"float"
},
"radius":{
"description":"Radius circle around center point in meters.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"float"
},
"requester":{
"description":"Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"trackingAccuracy":{
"description":"Number of meters of acceptable error in tracking distance.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"float"
}
},
"required":[
"callbackReference",
"address",
"latitude",
"longitude",
"radius",
"trackingAccuracy",
"enteringLeavingCriteria",
"checkImmediate",
"frequency"
],
"type":"object"
},
"ConnectionType":{
"description":"The connection type for the access point",
"enum":[
"Femto",
"LTE-femto",
"Smallcell",
"LTE-smallcell",
"Wifi",
"Pico",
"Micro",
"Macro",
"Wimax",
"Unknown"
],
"type":"string"
},
"DistanceCriteria":{
"enum":[
"AllWithinDistance",
"AnyWithinDistance",
"AllBeyondDistance",
"AnyBeyondDistance"
],
"type":"string"
},
"DistanceNotificationSubscription":{
"description":"A type containing data for distance subscription, with reference to other devices.",
"properties":{
"callbackReference":{
"$ref":"#/components/schemas/CallbackReference"
},
"checkImmediate":{
"description":"Check location immediately after establishing notification.",
"type":"boolean",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"boolean"
},
"clientCorrelator":{
"description":"A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"count":{
"description":"Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"int"
},
"criteria":{
"$ref":"#/components/schemas/DistanceCriteria"
},
"distance":{
"description":"Distance between devices that shall be monitored.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"float"
},
"duration":{
"description":"Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"int"
},
"frequency":{
"description":"Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"int"
},
"link":{
"description":"Link to other resources that are in relationship with the resource.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"monitoredAddress":{
"description":"Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)",
"items":{
"type":"string"
},
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"anyURI"
},
"referenceAddress":{
"description":"Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)",
"items":{
"type":"string"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"anyURI"
},
"requester":{
"description":"Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"trackingAccuracy":{
"description":"Number of meters of acceptable error in tracking distance.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"float"
}
},
"required":[
"callbackReference",
"monitoredAddress",
"distance",
"trackingAccuracy",
"criteria",
"checkImmediate",
"frequency"
],
"type":"object"
},
"EnteringLeavingCriteria":{
"enum":[
"Entering",
"Leaving"
],
"type":"string"
},
"Link":{
"description":"Link to other resources",
"properties":{
"href":{
"description":"URI",
"format":"anyURI",
"type":"string"
},
"rel":{
"description":"Describes the relationship between the URI and the resource.",
"type":"string"
}
},
"required":[
"rel",
"href"
],
"type":"object"
},
"LocationInfo":{
"properties":{
"accuracy":{
"description":"Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 4, 5 or 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"accuracyAltitude":{
"description":"Altitude accuracy / uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 3 or 4",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"accuracySemiMinor":{
"description":"Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 4, 5 or 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"altitude":{
"description":"Location altitude relative to the WGS84 ellipsoid surface.",
"format":"float",
"type":"number",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Float"
},
"confidence":{
"description":"Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in [14]. Present only if \"shape\" equals 1, 4 or 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"includedAngle":{
"description":"Present only if \"shape\" equals 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"innerRadius":{
"description":"Present only if \"shape\" equals 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"latitude":{
"description":"Location latitude, expressed in the range -90° to +90°. Cardinality greater than one only if \"shape\" equals 7.",
"items":{
"format":"float",
"type":"number"
},
"minItems":1,
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"Float"
},
"longitude":{
"description":"Location longitude, expressed in the range -180° to +180°. Cardinality greater than one only if \"shape\" equals 7.",
"items":{
"format":"float",
"type":"number"
},
"minItems":1,
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"Float"
},
"offsetAngle":{
"description":"Present only if \"shape\" equals 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"orientationMajorAxis":{
"description":"Angle of orientation of the major axis, expressed in the range 0° to 180°, as defined in [14]. Present only if \"shape\" equals 4 or 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"shape":{
"description":"Shape information, as detailed in [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum_inlined"
},
"timestamp":{
"$ref":"#/components/schemas/TimeStamp"
},
"uncertaintyRadius":{
"description":"Present only if \"shape\" equals 6",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"velocity":{
"description":"Structure with attributes relating to the target entity’s velocity, as defined in [14].",
"properties":{
"bearing":{
"description":"Bearing, expressed in the range 0° to 360°, as defined in [14].",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"horizontalSpeed":{
"description":"Horizontal speed, expressed in km/h and defined in [14].",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"uncertainty":{
"description":"Horizontal uncertainty, as defined in [14]. Present only if \"velocityType\" equals 3 or 4",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
},
"velocityType":{
"description":"Velocity information, as detailed in [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum_inlined"
},
"verticalSpeed":{
"description":"Vertical speed, expressed in km/h and defined in [14]. Present only if \"velocityType\" equals 2 or 4",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Int"
},
"verticalUncertainty":{
"description":"Vertical uncertainty, as defined in [14]. Present only if \"velocityType\" equals 4",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"UnsignedInt"
}
},
"required":[
"velocityType",
"bearing",
"horizontalSpeed"
],
"type":"object",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Structure (inlined)"
}
},
"required":[
"latitude",
"longitude",
"shape"
],
"type":"object",
"x-etsi-ref":"6.5.3"
},
"NotificationFormat":{
"enum":[
"XML",
"JSON"
],
"type":"string"
},
"NotificationSubscriptionList":{
"properties":{
"circleNotificationSubscription":{
"description":"Collection of CircleNotificationSubscription elements, see note 2.",
"x-etsi-notes":"NOTE 1:\tAs specified in [5], clause 5.2.2.8.\nNOTE 2: \tAs specified in [6], clause 5.2.2.7.",
"x-etsi-ref":"6.3.3"
},
"OperationStatus":{
"enum":[
"Serviceable",
"Unserviceable",
"Unknown"
],
"type":"string"
},
"PeriodicNotificationSubscription":{
"description":"A type containing data for periodic subscription.",
"properties":{
"address":{
"description":"Address of terminals to monitor (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"items":{
"type":"string"
},
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"anyURI"
},
"callbackReference":{
"$ref":"#/components/schemas/CallbackReference"
},
"clientCorrelator":{
"description":"A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"duration":{
"description":"Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"int"
},
"frequency":{
"description":"Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription.",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"int"
},
"link":{
"description":"Link to other resources that are in relationship with the resource.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"requestedAccuracy":{
"description":"Accuracy of the provided distance in meters.",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"int"
},
"requester":{
"description":"Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
}
},
"required":[
"callbackReference",
"address",
"requestedAccuracy",
"frequency"
],
"type":"object"
},
"ProblemDetails":{
"properties":{
"detail":{
"description":"A human-readable explanation specific to this occurrence of the problem",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"instance":{
"description":"A URI reference that identifies the specific occurrence of the problem",
"format":"uri",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"URI"
},
"status":{
"description":"The HTTP status code for this occurrence of the problem",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"title":{
"description":"A short, human-readable summary of the problem type",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"type":{
"description":"A URI reference according to IETF RFC 3986 that identifies the problem type",
"format":"uri",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"URI"
}
},
"type":"object"
},
"RetrievalStatus":{
"enum":[
"Retrieved",
"NotRetrieved",
"Error"
],
"type":"string"
},
"ServiceError":{
"description":"used to indicate a notification termination or cancellation.",
"properties":{
"messageId":{
"description":"Message identifier, either with prefix SVC or with prefix POL",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
},
"text":{
"description":"Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
},
"variables":{
"description":"Variables to substitute into text string",
"items":{
"type":"string"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"string"
}
},
"required":[
"messageId",
"text"
],
"type":"object"
},
"SubscriptionCancellationNotification":{
"description":"A type containing the subscription cancellation notification.",
"properties":{
"address":{
"description":"Address of terminal if the error applies to an individual terminal.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"callbackData":{
"description":"CallbackData if passed by the application in the receiptRequest element during the associated subscription operation",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"link":{
"description":"Link to other resources that are in relationship with the resource.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"reason":{
"$ref":"#/components/schemas/ServiceError"
}
},
"required":[
"terminalLocation"
],
"type":"object"
},
"SubscriptionNotification":{
"description":"A type containing the notification subscription.",
"properties":{
"callbackData":{
"description":"CallbackData if passed by the application in the receiptRequest element during the associated subscription operation",
"description":"Set to true if it is a final notification about location change.",
"type":"boolean",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"boolean"
},
"link":{
"description":"Link to other resources that are in relationship with the resource.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"terminalLocation":{
"description":"Collection of the terminal locations.",
"items":{
"$ref":"#/components/schemas/TerminalLocation"
},
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"TerminalLocation"
}
},
"required":[
"terminalLocation"
],
"type":"object"
},
"TerminalDistance":{
"description":"A type containing information about the distance from a terminal to a location or between two terminals, in addition the accuracy and a timestamp of the information are provided.",
"properties":{
"accuracy":{
"description":"Accuracy of the provided distance in meters",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"integer"
},
"distance":{
"description":"Distance from terminal to a location or between two terminals specified in meters",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"integer"
},
"timestamp":{
"$ref":"#/components/schemas/TimeStamp"
}
},
"required":[
"distance"
],
"type":"object"
},
"TerminalLocation":{
"description":"A type containing device address, retrieval status and location information.",
"properties":{
"address":{
"description":"Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"currentLocation":{
"$ref":"#/components/schemas/LocationInfo"
},
"errorInformation":{
"$ref":"#/components/schemas/ServiceError"
},
"locationRetrievalStatus":{
"$ref":"#/components/schemas/RetrievalStatus"
}
},
"required":[
"address",
"locationRetrievalStatus"
],
"type":"object"
},
"TerminalLocationList":{
"description":"Collection of the terminal locations.",
"items":{
"$ref":"#/components/schemas/TerminalLocation"
},
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"TerminalLocation"
},
"TimeStamp":{
"properties":{
"nanoSeconds":{
"description":"The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"seconds":{
"description":"The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
}
},
"required":[
"seconds",
"nanoSeconds"
],
"type":"object",
"x-etsi-ref":"6.5.2"
},
"UserEventType":{
"enum":[
"Entering",
"Leaving",
"Transferring"
],
"type":"string"
},
"UserInfo":{
"properties":{
"accessPointId":{
"description":"The identity of the access point the user is currently on, see note 1.",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"address":{
"description":"Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.",
"format":"uri",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"AnyURI"
},
"ancillaryInfo":{
"description":"Reserved for future use.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"contextLocationInfo":{
"description":"Contextual information of a user location (e.g. aisle, floor, room number, etc.).",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"locationInfo":{
"$ref":"#/components/schemas/LocationInfo"
},
"resourceURL":{
"description":"Self-referring URL, see note 1.",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"timestamp":{
"$ref":"#/components/schemas/TimeStamp"
},
"zoneId":{
"description":"The identity of the zone the user is currently within, see note 1.",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
}
},
"required":[
"address",
"accessPointId",
"zoneId",
"resourceURL",
"timestamp"
],
"type":"object",
"x-etsi-notes":"NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2: \tAs specified in [5], clause 5.2.2.5.",
"x-etsi-ref":"6.2.2"
},
"UserList":{
"description":"A type containing list of users.",
"properties":{
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"user":{
"description":"Collection of the zone information list.",
"items":{
"$ref":"#/components/schemas/UserInfo"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"UserInfo"
}
},
"required":[
"resourceURL"
],
"type":"object"
},
"UserTrackingSubscription":{
"description":"A type containing user tracking subscription.",
"properties":{
"address":{
"description":"Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"callbackReference":{
"$ref":"#/components/schemas/CallbackReference"
},
"clientCorrelator":{
"description":"A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"userEventCriteria":{
"description":"List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"items":{
"$ref":"#/components/schemas/UserEventType"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"UserEventType"
}
},
"required":[
"callbackReference",
"address"
],
"type":"object"
},
"ZonalPresenceNotification":{
"description":"A type containing zonal presence notification",
"properties":{
"address":{
"description":"Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"callbackData":{
"description":"CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"currentAccessPointId":{
"description":"Identifier of access point.",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
},
"interestRealm":{
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"link":{
"description":"Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"previousAccessPointId":{
"description":"Identifier of access point.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"timestamp":{
"$ref":"#/components/schemas/TimeStamp"
},
"userEventType":{
"$ref":"#/components/schemas/UserEventType"
},
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
}
},
"required":[
"zoneId",
"address",
"userEventType",
"currentAccessPointId",
"timestamp"
],
"type":"object"
},
"ZonalTrafficSubscription":{
"description":"A type containing zonal traffic subscription",
"properties":{
"callbackReference":{
"$ref":"#/components/schemas/CallbackReference"
},
"clientCorrelator":{
"description":"A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"duration":{
"description":"Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"unsignedInt"
},
"interestRealm":{
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"items":{
"type":"string"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"string"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"anyURI"
},
"userEventCriteria":{
"description":"List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"items":{
"$ref":"#/components/schemas/UserEventType"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"UserEventType"
},
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
}
},
"required":[
"callbackReference",
"zoneId"
],
"type":"object"
},
"ZoneInfo":{
"description":"A type containing zone information.",
"properties":{
"numberOfAccessPoints":{
"description":"The number of access points within the zone",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"unsignedInt"
},
"numberOfUnserviceableAccessPoints":{
"description":"Number of inoperable access points within the zone.",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"unsignedInt"
},
"numberOfUsers":{
"description":"The number of users currently on the access point.",
"type":"integer",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"unsignedInt"
},
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
}
},
"required":[
"zoneId",
"numberOfAccessPoints",
"numberOfUnserviceableAccessPoints",
"numberOfUsers",
"resourceURL"
],
"type":"object"
},
"ZoneList":{
"description":"A type containing a list of zones.",
"properties":{
"resourceURL":{
"description":"Self referring URL",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"anyURI"
},
"zone":{
"description":"Collection of the zone information list.",
"items":{
"$ref":"#/components/schemas/ZoneInfo"
},
"type":"array"
}
},
"required":[
"resourceURL"
],
"type":"object"
},
"ZoneStatusNotification":{
"description":"A type containing zone status notification.",
"properties":{
"accessPointId":{
"description":"Identifier of an access point.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"callbackData":{
"description":"CallBackData if passed by the application during the associated ZoneStatusSubscription operation. See [REST_NetAPI_Common].",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"link":{
"description":"Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Link"
},
"numberOfUsersInAP":{
"description":"This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"unsignedInt"
},
"numberOfUsersInZone":{
"description":"This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription.",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"unsignedInt"
},
"operationStatus":{
"$ref":"#/components/schemas/OperationStatus"
},
"timestamp":{
"$ref":"#/components/schemas/TimeStamp"
},
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"x-etsi-mec-cardinality":1,
"x-etsi-mec-origin-type":"string"
}
},
"required":[
"zoneId",
"timestamp"
],
"type":"object"
},
"ZoneStatusSubscription":{
"description":"A type containing zone status subscription.",
"properties":{
"callbackReference":{
"$ref":"#/components/schemas/CallbackReference"
},
"clientCorrelator":{
"description":"A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"string"
},
"numberOfUsersAPThreshold":{
"description":"Threshold number of users in an access point which if crossed shall cause a notification",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"unsignedInt"
},
"numberOfUsersZoneThreshold":{
"description":"Threshold number of users in a zone which if crossed shall cause a notification",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"unsignedInt"
},
"operationStatus":{
"description":"List of operation status values to generate notifications for (these apply to all access points within a zone).",
* @desc This type represents some requirements about reporting the event of user locationreportingLocationReq This IE shall be set to true if a location estimate is required for each event report
* @member accessPointList One or more access points forming a monitoring area that could be any shape
* @member zoneId Identifier of zone (e.g. zone001) to monitor
* @member occurrenceInfo One time only report indication
* @desc Shape information, as detailed in [14], associated with the reported location coordinate
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Table 6.5.3-1: Definition of type LocationInfo
* @desc This type represents the parameters that control the report times and frequency
* @member minimumInterval Minimum interval between reports in case frequently reporting. Unit is second.
* @member maximumFrequency Maximum frequency (in seconds) of notifications per subscription
* @member maximumCount Maximum number of notifications. For no maximum, either do not include this element or specify a value of zero. Default value is 0
* @see ETSI GS MEC 013 V3.1.1 (2023-01) Table 6.5.3-1: Definition of type LocationInfo
*/
typerecordVelocity{
VelocityTypevelocityType,
Json.UIntegerbearing,
Json.UIntegerhorizontalSpeed,
Json.UIntegeruncertaintyoptional,
Json.IntegerverticalSpeedoptional,
Json.UIntegerverticalUncertaintyoptional
}// End of type Velocity
/**
* @desc Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element
* @see ETSI GS MEC 013 V3.1.1 (2023-01) Clause 6.2.1 Zonal presence data types
*/
typerecordofZoneInfoZoneInfos;
typerecordZoneList{
ZoneInfoszoneoptional,
ResourceURLresourceURL
}
/**
* @desc Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element
* @see ETSI GS MEC 013 V2.1.1 (2019-09) 6.6.1 accessPointId
*/
typeJson.StringAccessPointId;
typeUInt32DateTimeStamp;// FIXME To be reviewed
typeJson.UIntegerDateTimeStamp;// FIXME To be reviewed
/**
* @desc A type containing access point information.
* @desc CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [\
REST_NetAPI_Common].
*/
typeJson.StringCallbackData;
/**
* @desc Notification serialization format
*/
typeenumeratedNotificationFormat{
JSON(1),
XML(2)
}
/**
* @desc CallbackData description
* @member callbackData Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes
* @member notificationFormat
* @member notifyURL Notify Callback URL
*/
typerecordCallbackReference{
NotifyURLnotifyURL,
CallbackDatacallbackDataoptional,
NotificationFormatnotificationFormatoptional
}
*/
typeJson.AnyURICallbackReference;
/**
* @desc Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.
...
...
@@ -241,19 +303,20 @@ REST_NetAPI_Common].
typeJson.StringClientCorrelator;
/**
* @desc The connection type for the access point
* @desc This enumeration represents the connection type of an access point.
* @member LTE Access point provides a LTE-Femto connection
* @member Wifi Access point provides a Wifi® connection
* @member Wimax Access point provides a Wimax® connection
* @member FiveG_NR Access point provides a 5G NR connection
* @member UNKNOWN Access point connection type is unknown
* @desc The number of users currently on the access point.
*/
typeUInt32NumberOfUsers;
typeJson.UIntegerNumberOfUsers;
/**
* @desc Threshold number of users in an access point which if crossed shall cause a notification.
*/
typeUInt32NumberOfUsersAPThreshold;
typeJson.UIntegerNumberOfUsersAPThreshold;
/**
* @desc This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.
*/
typeUInt32NumberOfUsersInAP;
typeJson.UIntegerNumberOfUsersInAP;
/**
* @desc Threshold number of users in a zone which if crossed shall cause a notification.
*/
typeUInt32NumberOfUsersInZone;
typeJson.UIntegerNumberOfUsersInZone;
/**
* @desc Threshold number of users in a zone which if crossed shall cause a notification.
*/
typeUInt32NumberOfUsersZoneThreshold;
typeJson.UIntegerNumberOfUsersZoneThreshold;
/**
* @desc The operation status of the access point
...
...
@@ -373,25 +468,99 @@ REST_NetAPI_Common].
*/
typerecordofUserEventTypeUserEventCriteria;
/**
* @desc Definition of type CivicAddress
* @member country The two-letter ISO 3166 country code in capital ASCII letters
* @member A1 National subdivisions
* @member A2 County, parish
* @member A3 City, township
* @member A4 City division, borough, city district
* @member A5 Neighbourhood
* @member A6 Group of streets below the neighbourhood level IETF RFC 4776 [6]
* @member PRD Leading street direction IETF RFC 4776 [6]
* @member POD Trailing street suffix IETF RFC 4776 [6]
* @member STS Street suffix or type IETF RFC 4776 [6]
* @member HNO House number IETF RFC 4776 [6]
* @member HNS House number suffix IETF RFC 4776 [6]
* @member usageRules When present, this IE shall carry the value of "usagerules" Element of the PIDL-LO XML document
* @member method When present, this IE shall contain the method token, carried by the "method" Element of the PIDLLO XML document. IETF RFC 4119 [25] providedBy string O 0..1 When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document
* @member providedBy When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document
* @member address_ Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).
* @member accessPointId Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171).
* @member zoneId Identifier of zone
* @member timestamp
* @member zoneId The identity of the zone the user is currently within,
* @member timestamp Date and time that location was collected
* @member resourceURL Self referring URL.
* @member locationInfo A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.
* @member civicInfo Contextual information of a user location
* @member contextLocationInfo Contextual information of a user location (e.g. aisle, floor, room number, etc.).
* @desc A type containing user tracking subscription.
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference
* @member address_ Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor
* @member userEventCriteria List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event
* @member resourceURL Self referring URL
* @desc Represents the relative location in a reference system that is a Cartesian coordinate system and described by a map
* @member mapInfo Indicates a map corresponding to a location area
* @member X Indicates the value (in the unit of meters) on x-axis of the relative location in the Cartesian system
* @member Y Indicates the value (in the unit of meters) on y-axis of the relative location in the Cartesian system
* @member Z Indicates the value (in the unit of meters) on z-axis of the relative location in the Cartesian system for a 3D-Point
* @see ETSI GS MEC 013 V3.1.1 (2023-01) Clause 6.2.3
*/
typerecordUserTrackingSubscription{
ClientCorrelatorclientCorrelatoroptional,
CallbackReferencecallbackReference,
Addressaddress_,
UserEventCriteriauserEventCriteriaoptional,
ResourceURLresourceURLoptional
}with{
variant(address_)"name as 'address'";
typerecordRelativeLocationInfo{
MapInfomapInfo,
Json.NumberX,
Json.NumberY,
Json.NumberZoptional
}
/**
* @desc A type containing periodic tracking subscription.
* @member
* @desc Indicates the location of the map origin in the local Cartesian coordinate system
* @member latitude Location latitude, expressed in the range -90° to +90°
* @member longitude Location longitude, expressed in the range -180° to +180°
* @member Location altitude relative to the WGS84 ellipsoid surface
* @see ETSI GS MEC 013 V3.1.1 (2023-01) Clause 6.2.4
*/
typerecordPeriodicTrackingSubscription{
ClientCorrelatorclientCorrelatoroptional,
CallbackReferencecallbackReference,
Addressaddress_,
Json.Numberfrequency,
Json.NumberrequestedAccuracy,
ResourceURLresourceURLoptional
}with{
variant(address_)"name as 'address'";
}
/**
* @desc A type containing zonal presence notification
* @member callbackData CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See
* @member zoneId Identifier of zone
* @member address_ Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor
* @member interestRealm Interest realm of access point (e.g. geographical area, a type of industry etc.)
* @member userEventType
* @member currentAccessPointId Identifier of access point
* @member previousAccessPointId Identifier of access point
* @member timestamp_
* @member link Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.
* @desc A type containing zonal traffic subscription
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference
* @member zoneId Identifier of zone
* @member interestRealm Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).
* @member userEventCriteria List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.
* @member duration Period (in seconds) of time notifications are provided for
* @member resourceURL Self referring URL
* @desc This type represents a map that may incorporates an origin
* @member mapId Indicates the ID of the map
* @member Indicates the location of the map origin in the local Cartesian coordinate system
* @member ancillaryMapInfo Ancillary map information may be used to convert coordinates between different coordinate systems
* @see ETSI GS MEC 013 V3.1.1 (2023-01) Clause 6.2.4
*/
typerecordZonalTrafficSubscription{
ClientCorrelatorclientCorrelatoroptional,
CallbackReferencecallbackReference,
ZoneIdzoneId,
InterestRealminterestRealmoptional,
UserEventCriteriauserEventCriteriaoptional,
Durationdurationoptional,
ResourceURLresourceURLoptional
typerecordMapInfo{
Json.StringmapId,
MapInfoOriginoriginoptional,
AncillaryMapInfoancillaryMapInfooptional
}
typeJson.StringAncillaryMapInfo;
/**
* @desc Identifier of zone
*/
typeJson.StringZoneId;
/**
* @desc A type containing zone status notification.
* @member callbackData CallBackData if passed by the application during the associated ZoneStatusSubscription operation
* @member zoneId Identifier of zone
* @member accessPointId Identifier of an access point
* @member numberOfUsersInZone This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription
* @member numberOfUsersInAP This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription
* @member operationStatus
* @member timestamp_
* @member link Link to other resources that are in relationship with this notification
*/
typerecordZoneStatusNotification{
CallbackDatacallbackDataoptional,
ZoneIdzoneId,
AccessPointIdaccessPointIdoptional,
NumberOfUsersInZonenumberOfUsersInZoneoptional,
NumberOfUsersInAPnumberOfUsersInAPoptional,
OperationStatusoperationStatusoptional,
TimeStamptimestamp_,
Linklinkoptional
}with{
variant(timestamp_)"name as 'timestamp'";
}
/**
* @desc A type containing zone status subscription.
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member resourceURL Self referring URL
* @member callbackReference
* @member zoneId Identifier of zone
* @member numberOfUsersZoneThreshold Threshold number of users in a zone which if crossed shall cause a notification
* @member numberOfUsersAPThreshold Threshold number of users in an access point which if crossed shall cause a notification
* @member operationStatus List of operation status values to generate notifications for (these apply to all access points within a zone).
* @desc A type containing data for notifications, when the area is defined as a circle
* @member address Address of terminals to monitor (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
* @member callbackReference
* @member checkImmediate Check location immediately after establishing notification
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member count Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0
* @member duration Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications
* @member enteringLeavingCriteria
* @member frequency Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications)
* @member latitude Latitude of center point
* @member link Link to other resources that are in relationship with the resource
* @member longitude Longitude of center point
* @member radius Radius circle around center point in meters
* @member requester Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
* @member resourceURL Self referring URL
* @member trackingAccuracy Number of meters of acceptable error in tracking distance
*/
typerecordCircleNotificationSubscription{
Addressesaddress_,
CallbackReferencecallbackReference,
Json.BoolcheckImmediate,
ClientCorrelatorclientCorrelatoroptional,
UInt32countoptional,
UInt32durationoptional,
EnteringLeavingCriteriaenteringLeavingCriteria,
UInt32frequency,
Json.Numberlatitude,
Linklinkoptional,
Json.Numberlongitude,
Json.Numberradius,
Json.AnyURIrequesteroptional,
ResourceURLresourceURLoptional,
Json.NumbertrackingAccuracy
}with{
variant(address_)"name as 'address'";
}
typeenumeratedEnteringLeavingCriteria{
Entering,
Leaving
...
...
@@ -576,6 +624,7 @@ REST_NetAPI_Common].
* @member distance Distance from terminal to a location or between two terminals specified in meters
* @member accuracy Accuracy of the provided distance in meters
* @member timestamp Date and time that location from which distance is calculated was collected
* @desc A type containing data for distance subscription, with reference to other devices
* @member callbackReference
* @member checkImmediate Check location immediately after establishing notification
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member count Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0
* @member criteria
* @member distance Distance between devices that shall be monitored
* @member duration Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications
* @member frequency Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications)
* @member link Link to other resources that are in relationship with the resource
* @member monitoredAddress Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
* @member referenceAddress Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
* @member requester Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
* @member resourceURL Self referring URL
* @member trackingAccuracy Number of meters of acceptable error in tracking distance
*/
typerecordDistanceNotificationSubscription{
CallbackReferencecallbackReference,
Json.BoolcheckImmediate,
ClientCorrelatorclientCorrelatoroptional,
UInt32countoptional,
DistanceCriteriacriteria,
Json.Numberdistance,
UInt32durationoptional,
UInt32frequency,
Linklinkoptional,
AddressesmonitoredAddress,
AddressesreferenceAddressoptional,
Json.AnyURIrequesteroptional,
ResourceURLresourceURLoptional,
Json.NumbertrackingAccuracy
}
/**
* @desc A type containing data for periodic subscription
* @member address_ Address of terminals to monitor (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
* @member callbackReference
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member duration Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications
* @member frequency Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications)
* @member link Link to other resources that are in relationship with the resource
* @member monitoredAddress Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
* @member requestedAccuracy Accuracy of the provided distance in meters
* @member requester Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
* @member resourceURL Self referring URL
* @desc A type containing device address, retrieval status and location information
* @member address_ Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
* @member locationRetrievalStatus Status of retrieval for this terminal address
* @member currentLocation Location of terminal
* @member errorInformation Used to indicate a notification termination or cancellation
* @desc This type represents a subscription to the notifications from location server about events related with user location
* @member subscriptionType Shall be set to "UserLocationEventSubscription"
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference URI exposed by the client on which to receive notifications via HTTP
* @member requestTestNotification 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 [4]
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications
* @member _links Hyperlink related to the resource
* @member address Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) to monitor
* @member userEventPara Requirements for user event reporting.
* @member locationEventCriteria List of user event values to generate notifications for (these apply to address specified).
* @member expiryDeadline The expiration time of the subscription determined by the UE Location Subscribe Service
* @desc This type represents a subscription to the notifications from location server about events triggered by timer expiration
* @member subscriptionType Shall be set to "UserLocationEventSubscription"
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference URI exposed by the client on which to receive notifications via HTTP
* @member requestTestNotification 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 [4]
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications
* @member _links Hyperlink related to the resource
* @member address_ Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) to monitor
* @member periodicEventInfo Information for periodic event reporting
* @member expiryDeadline The expiration time of the subscription determined by the UE Location Subscribe Service
* @desc Number of required periodic event reports.
* Minimum: 1. Maximum: 8639999.
* @see ETSI TS 129 572 V16.7.0 Clause 6.1.6.3.2 Simple data types
*/
typeintegerReportingAmount;
/**
* @desc Event reporting periodic interval in seconds.
* Minimum: 1. Maximum: 8639999.
* @remark ReportingInterval * ReportingAmount shall not exceed 8639999
* @see ETSI TS 129 572 V16.7.0 Clause 6.1.6.3.2 Simple data types
*/
typeintegerReportingInterval;
/**
* @desc This type represents a subscription to the notifications from location server about user location events happened in the zone
* @desc This type represents a subscription to the notifications from location server about events related with user location
* @member subscriptionType Shall be set to "UserLocationEventSubscription"
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference URI exposed by the client on which to receive notifications via HTTP
* @member requestTestNotification 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 [4]
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications
* @member _links Hyperlink related to the resource
* @member zoneId Identifier of zone (e.g. zone001) to monitor
* @member reportingCtrl Provides parameters that ctrl the reporting
* @member expiryDeadline The expiration time of the subscription determined by the UE Location Subscribe Service
* @desc This type represents a subscription to the notifications from location server about the number of users reaching the threshold or the status of access points changing
* @member subscriptionType Shall be set to "UserLocationEventSubscription"
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference URI exposed by the client on which to receive notifications via HTTP
* @member requestTestNotification 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 [4]
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications
* @member _links Hyperlink related to the resource
* @member zoneId Identifier of zone (e.g. zone001) to monitor
* @member upperNumberOfUsersZoneThreshold Threshold number of users in a zone which if crossed upward shall cause a notification
* @member lowerNumberOfUsersZoneThreshold Threshold number of users in a zone which if crossed downward shall cause a notification
* @member upperNumberOfUsersAPThreshold Threshold number of users in an access point which if crossed upward shall cause a notification
* @member lowerNumberOfUsersAPThresholdThreshold number of users in an access point which ifcrossed downward shall cause a notification
* @member operationStatus List of operation status values to generate notifications for (these apply to all access points within a zone)
* @member reportingCtrl Provides parameters that ctrl the reporting
* @member expiryDeadline The expiration time of the subscription determined by the UE Location Subscribe Service
* @desc This type represents a subscription to the notifications from location server about user location events happened in the area.
* @member subscriptionType Shall be set to "UserLocationEventSubscription"
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference URI exposed by the client on which to receive notifications via HTTP
* @member requestTestNotification 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 [4]
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications
* @member _links Hyperlink related to the resource
* @member areaDefine The parameters describing the area to subscribe
* @member trackingAccuracy Number of meters of acceptable error
* @member reportingCtrl Provides parameters that ctrl the reporting
* @member locationEventCriteria List of user event values to generate notifications for (these apply to address specified)
* @member reportingLocationReq This IE shall be set to true if a location estimate is required for each event report
* @member expiryDeadline The expiration time of the subscription determined by the UE Location Subscribe Service
* @desc This type represents a subscription to the notifications from location server about changes in the geographical relationships between monitored users or between monitored users and reference users
* @member subscriptionType Shall be set to "UserLocationEventSubscription"
* @member clientCorrelator A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server
* @member callbackReference URI exposed by the client on which to receive notifications via HTTP
* @member requestTestNotification 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 [4]
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications
* @member _links Hyperlink related to the resource
* @member referenceAddress If specified, indicates address of each user that will be used as reference users from which the distances towards monitored users indicated in the Addresses will be monitored
* @member monitoredAddress Contains addresses of users to monitor (e.g. 'sip' URI, 'tel' URI, 'acr' URI). Reference to a group could be provided here if supported by implementation
* @member distance Distance between users that shall be monitored. The unit is meter
* @member trackingAccuracy Number of meters of acceptable error in tracking distance
* @member criteria Indicates whether the notification should occur when the geographical relationship between monitored and referenced users' changes
* @member checkImmediate Check location immediately after establishing notification
* @member reportingCtrl Provides parameters that ctrl the reporting
* @member locationEventCriteria List of user event values to generate notifications for (these apply to address specified)
* @member expiryDeadline The expiration time of the subscription determined by the UE Location Subscribe Service
* @desc This type represents a test notification from a location server to determine if the Websocket method is to be utilized for the location server to issue notifications for a subscription, as defined in clause 6.12a of ETSI GS MEC 009 [4]
* @member notificationType Shall be set to "TestNotification"
* @member _links Hyperlink related to the resource
* @desc This type represents a notification from location server with regards to status changing event or user number threshold event happened in a zone
* @member notificationType Shall be set to "ZoneStatusNotification"
* @member timeStamp TimeStamp
* @member userNumEvent
* @member operationStatus The specific event triggering this notification
* @member zoneId The identity of the zone
* @member accessPointId The identity of the access point
* @member _links Object containing hyperlinks related to the resource
* @member ipAddress SGW transport layer address of this S1 bearer
* @member tunnelId SGW GTP-U TEID of this S1 bearer
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.2.4-1 Attributes of the S1BearerInfo
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.2.4-1 Attributes of the S1BearerInfo
*/
typerecordSGwInfo{
Json.StringipAddress,
Json.StringtunnelId
}
/**
* @desc S1 bearer information on eNB side
* @member ipAddress eNB transport layer address of this S1 bearer
* @member tunnelId eNB GTP-U TEID of this S1 bearer
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.2.4-1 Attributes of the S1BearerInfo
*/
typerecordS1EnbInfo{// FIXME Check if it is usefull somewhere
Json.StringipAddress,
Json.StringtunnelId
}
/**
* @desc This type represents the information on the Layer 2 measurements information from one or more eNBs that are associated with the requested MEC application instance.
* @member timestamp Time stamp
* @member cellInfo The per cell measurement information
* @member cellUEInfo The per cell per UE layer 2 measurements information
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.2.4a-1: Attributes of the L2Meas
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.2.4a-1: Attributes of the L2Meas
* @member ul_gbr_pdr_cell It indicates the packet discard rate in percentage of the uplink GBR traffic in a cell, as defined in ETSI TS 136 314
* @member dl_nongbr_pdr_cell It indicates the packet discard rate in percentage of the downlink non-GBR traffic in a cell, as defined in ETSI TS 136 314
* @member ul_nongbr_pdr_cell It indicates the packet discard rate in percentage of the uplink non-GBR traffic in a cell, as defined in ETSI TS 136 314
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.2.4a-1: Attributes of the L2Meas
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.2.4a-1: Attributes of the L2Meas
* @desc subscription to 5G UE measurement report notifications from Radio Network Information Service for UEs served by NR Cells
* @member subscriptionType Shall be set to "NrMeasRepUeSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @desc Subscription to cell change notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "CellChangeSubscription"
* @member callbackReference URI selected by the service consumerto receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaAssocTri List of filtering criteria for the subscription
* @member filterCriteriaAssocHo List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.11-1: Attributes of the NrMeasRepUeSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.2-1: Attributes of the CellChangeSubscription
*/
typerecordNrMeasRepUeSubscription{
typerecordCellChangeSubscription{
Json.StringsubscriptionType,
CallbackReferencecallbackReference,
Linklinksoptional,
FilterCriteriaNrMrsfilterCriteriaNrMrs,
Json.BoolrequestTestNotificationoptional,
WebsockNotifConfigwebsockNotifConfigoptional,
Linkslinksoptional,
FilterCriteriaAssocHofilterCriteriaAssocHo,
TimeStampexpiryDeadlineoptional
}with{
variant(links)"name as '_links'";
}
/**
* @desc List of links related to currently existing subscriptions for the service consumer
* @member links List of hyperlinks related to the resource
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.10-1: Attributes of the SubscriptionLinkList
* @desc List of hyperlinks related to the resource
* @member self_ URI referring to a resource
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.2-1: Attributes of the CellChangeSubscription
*/
typerecordSubscriptionLinkList{
SubscriptionLinkList_Linklinks
typerecordLinks{
LinkTypeself_
}with{
variant(links)"name as '_links'";
variant(self_)"name as 'self'";
}
/**
* @desc List of hyperlinks related to the resource
* @member self_
* @member subscription A link to a subscription
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.10-1: Attributes of the SubscriptionLinkList
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member associateId 0 to N identifiers to associate the information for a specific UE or flow
* @member ecgi E-UTRAN CelI Global Identifier
* @member hoStatus Indicate the status of the UE handover procedure
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.2-1: Attributes of the CellChangeSubscription
*/
typerecordSubscriptionLinkList_Link{
LinkTypeself_,
Subscriptionsubscriptionoptional
}with{
variant(self_)"name as 'self'";
typerecordFilterCriteriaAssocHo{
AppInstanceIdappInstanceIdoptional,
AssociateIdassociateIdoptional,
Ecgi_listecgioptional,
HoStatus_listhoStatusoptional
}
/**
* @desc A link to a subscription
* @member The URI referring to the subscription
* @member Type of the subscription
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.10-1: Attributes of the SubscriptionLinkList
* @desc Description of the subscribed to event
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.2-1: Attributes of the CellChangeSubscription
*/
typerecordSubscription_{
LinkTypehref,
Json.StringsubscriptionType
typeenumeratedHoStatus{
IN_PREPARATION(1),
IN_EXECUTION(2),
COMPLETED(3),
REJECTED(4),
CANCELLED(5)
}with{
variant"JSON: as number"
}
typerecordofSubscription_Subscription;
typerecordofHoStatusHoStatus_list;
/**
* @desc Subscription to UE measurement report notifications from Radio Network Information Service for UEs served by E-UTRA Cells
* @member subscriptionType Shall be set to "MeasRepUeSubscription"
* @desc Subscription to RAB establishment notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "RabEstSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaAssocTri List of filtering criteria for the subscription
* @member filterCriteriaQci List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.6-1: Attributes of the MeasRepUeSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.3-1: Attributes of the RabEstSubscription
* @desc Subscription to S1-U bearer information notification from Radio Network Information Service
* @member subscriptionType Shall be set to "S1BearerSubscription"
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member ecgi E-UTRAN CelI Global Identifier
* @member qci QoS Class Identifier as defined in ETSI TS 123 401
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.3-1: Attributes of the RabEstSubscription
*/
typerecordRabEstSubscription_FilterCriteriaQci{
AppInstanceIdappInstanceIdoptional,
Ecgi_listecgioptional,
Qciqci
}
/**
* @desc Subscription to RAB modification notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "RabModSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member eventType Description of the subscribed event
* @member s1BearerSubscriptionCriteria List of filtering criteria for the subscription
* @member filterCriteriaQci List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.9-1: Attributes of the S1BearerSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.4-1: Attributes of the RabModSubscription
* @desc Subscription to RAB establishment notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "RabEstSubscription"
* @desc Subscription to RAB release notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "RabRelSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaQci List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.3-1: Attributes of the RabEstSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.5-1: Attributes of the RabRelSubscription
* @desc Subscription to RAB modification notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "RabModSubscription"
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member erabId The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413
* @member ecgi E-UTRAN CelI Global Identifier
* @member qci QoS Class Identifier as defined in ETSI TS 123 401
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.4-1: Attributes of the RabModSubscription
*/
typerecordRabModSubscription_FilterCriteriaQci{
AppInstanceIdappInstanceIdoptional,
Json.UIntegererabId,
Ecgi_listecgioptional,
Qciqci
}
/**
* @desc Subscription to UE measurement report notifications from Radio Network Information Service for UEs served by E-UTRA Cells
* @member subscriptionType Shall be set to "MeasRepUeSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaQci List of filtering criteria for the subscription
* @member filterCriteriaAssocTri List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.4-1: Attributes of the RabModSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.6-1: Attributes of the MeasRepUeSubscription
* @desc Subscription to RAB release notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "RabRelSubscription"
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member associateId 0 to N identifiers to associate the information for a specific UE or flow
* @member ecgi E-UTRAN CelI Global Identifier
* @member trigger_ Corresponds to a specific E-UTRAN UE Measurement Report trigger
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.6-1: Attributes of the MeasRepUeSubscription
*/
typerecordFilterCriteriaAssocTri{
AppInstanceIdappInstanceIdoptional,
AssociateIdassociateIdoptional,
Ecgi_listecgioptional,
Triggertrigger_optional
}with{
variant(trigger_)"name as 'trigger'";
}
/**
* @desc This type represents a subscription to UE timing advance notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "MeasRepUeSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaQci List of filtering criteria for the subscription
* @member filterCriteriaAssoc List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.5-1: Attributes of the RabRelSubscription
* @desc Subscription to UE carrier aggregation reconfiguration notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "CaReConfSubscription"
* @member callbackReference URI selected by the service consumerto receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaAssoc List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.8-1: Attributes of the CaReconfSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.8-1: Attributes of the CaReconfSubscription
* @desc Subscription to cell change notifications from Radio Network Information Service
* @member subscriptionType Shall be set to "CellChangeSubscription"
* @member callbackReference URI selected by the service consumerto receive notifications on the subscribed RNIS information
* @desc Subscription to S1-U bearer information notification from Radio Network Information Service
* @member subscriptionType Shall be set to "S1BearerSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaAssocHo List of filtering criteria for the subscription
* @member eventType Description of the subscribed event
* @member s1BearerSubscriptionCriteria List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.2-1: Attributes of the CellChangeSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.9-1: Attributes of the S1BearerSubscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.9-1: Attributes of the S1BearerSubscription
*/
typerecordMeasTaSubscription{
Json.StringsubscriptionType,
CallbackReferencecallbackReference,
Linklinks,
FilterCriteriaAssocHofilterCriteriaAssocHo,
TimeStampexpiryDeadlineoptional
typeenumeratedEventType_{
RESERVED(0),
S1_BEARER_ESTABLISH(1),
S1_BEARER_MODIFY(2),
S1_BEARER_RELEASE(3)
}with{
variant(links)"name as '_links'";
variant"JSON: as number"
}
typerecordofEventType_EventType;
/**
* @desc URL selected by the Mobile Edge application to receive notifications on the subscribed RNIS information
* @desc List of filtering criteria for the subscription
* @member associateId 0 to N identifiers to associate the events for a specific UE or a flow
* @member ecgi E-UTRAN CelI Global Identifier
* @member erabId The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.9-1: Attributes of the S1BearerSubscription
*/
typeJson.AnyURICallbackReference;
typerecordS1BearerSubscriptionCriteria{
AssociateIdassociateIdoptional,
Ecgiecgioptional,
ErabIderabIdoptional
}
/**
* @desc List of hyperlinks related to the resource
* @member self_ URI referring to a resource
* @member self_
* @member subscription A link to a subscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.10-1: Attributes of the SubscriptionLinkList
*/
typerecordLink{
LinkTypeself_
typerecordSubscriptionLinkList_Link{
LinkTypeself_,
Subscriptionsubscriptionoptional
}with{
variant(self_)"name as 'self'";
}
/**
* @desc URI referring to a resource
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.5.2-1: Attributes of the LinkType
* @desc A link to a subscription
* @member The URI referring to the subscription
* @member Type of the subscription
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.10-1: Attributes of the SubscriptionLinkList
*/
typerecordLinkType{
Json.AnyURIhref
typerecordSubscription_{
LinkTypehref,
Json.StringsubscriptionType
}
typerecordofSubscription_Subscription;
/**
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member associateId 0 to N identifiers to associate the information for a specific UE or flow
* @member ecgi E-UTRAN CelI Global Identifier
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.8-1: Attributes of the CaReconfSubscription
* @desc List of links related to currently existing subscriptions for the service consumer
* @member links List of hyperlinks related to the resource
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.10-1: Attributes of the SubscriptionLinkList
*/
typerecordFilterCriteriaAssoc{
AppInstanceIdappInstanceId,
AssociateIdassociateIdoptional,
Ecgi_listecgioptional
typerecordSubscriptionLinkList{
SubscriptionLinkList_Linklinks
}with{
variant(links)"name as '_links'";
}
/**
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member ecgi E-UTRAN CelI Global Identifier
* @member qci QoS Class Identifier as defined in ETSI TS 123 401
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.3-1: Attributes of the RabEstSubscription
* @desc subscription to 5G UE measurement report notifications from Radio Network Information Service for UEs served by NR Cells
* @member subscriptionType Shall be set to "NrMeasRepUeSubscription"
* @member callbackReference URI selected by the service consumer to receive notifications on the subscribed RNIS information
* @member requestTestNotification Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI
* @member websockNotifConfig Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications
* @member links Hyperlink related to the resource
* @member filterCriteriaAssocTri List of filtering criteria for the subscription
* @member expiryDeadline Time stamp
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.11-1: Attributes of the NrMeasRepUeSubscription
*/
typerecordRabEstSubscription_FilterCriteriaQci{
AppInstanceIdappInstanceIdoptional,
Ecgi_listecgioptional,
Qciqci
typerecordNrMeasRepUeSubscription{
Json.StringsubscriptionType,
CallbackReferencecallbackReference,
Json.BoolrequestTestNotificationoptional,
WebsockNotifConfigwebsockNotifConfigoptional,
Linkslinksoptional,
FilterCriteriaNrMrsfilterCriteriaNrMrs,
TimeStampexpiryDeadlineoptional
}with{
variant(links)"name as '_links'";
}
/**
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member erabId The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413
* @member ecgi E-UTRAN CelI Global Identifier
* @member qci QoS Class Identifier as defined in ETSI TS 123 401
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.4-1: Attributes of the RabModSubscription
* @member associateId 0 to N identifiers to associate the information for a specific UE or flow
* @member nrcgi NR Cell Global Identier
* @member triggerNr Corresponds to a specific 5G UE Measurement Report trigger
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.3.11-1: Attributes of the NrMeasRepUeSubscription
*/
typerecordRabModSubscription_FilterCriteriaQci{
typerecordFilterCriteriaNrMrs{
AppInstanceIdappInstanceIdoptional,
UInt32erabId,
Ecgi_listecgioptional,
Qciqci
AssociateIdassociateIdoptional,
NRcgi_listnrcgioptional,
TriggerNrtriggerNroptional
}
/**
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member associateId 0 to N identifiers to associate the information for a specific UE or flow
* @member ecgi E-UTRAN CelI Global Identifier
* @member hoStatus
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.2-1: Attributes of the CellChangeSubscription
* @desc This type represents configuration for the delivery of subscription notifications over Websockets
* @member websocketUri Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications
* @member requestWebsocketUri Set to true by the service consumer to indicate that Websocket delivery is requested
* @desc List of filtering criteria for the subscription
* @member appInstanceId Unique identifier for the MEC application instance
* @member associateId 0 to N identifiers to associate the information for a specific UE or flow
* @member ecgi E-UTRAN CelI Global Identifier
* @member trigger_ Corresponds to a specific E-UTRAN UE Measurement Report trigger
* @see ETSI GS MEC 012 V2.1.1 (2019-12) Table 6.3.6-1: Attributes of the MeasRepUeSubscription
* @desc Unique identifier for the mobile edge application instance",
*/
typerecordFilterCriteriaAssocTri{
AppInstanceIdappInstanceIdoptional,
AssociateIdassociateIdoptional,
Ecgi_listecgioptional,
Triggertrigger_optional
typeJson.StringAppInstanceId;
/**
* @desc Unique identifier allocated by the Mobile Edge application for the Information request
*/
typeJson.StringRequestId;
/**
* @desc This type represents a subscription to 5G UE measurement report notifications from Radio Network Information Service for UEs served by NR Cells
* @member notificationType Shall be set to "CellChangeNotification"
* @member timeStamp Time stamp
* @member associateId 0 to N identifiers to associate the event for a specific UE or flow
* @member srcEcgi E-UTRAN Cell Global Identifier of the source cell
* @member trgEcgi E-UTRAN Cell Global Identifier of the target cell
* @member hoStatus Indicate the status of the UE handover procedure
* @member tempUeId The temporary identifier allocated for the specific UE
* @member links Links to resources related to this notification
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.4.2-1: Attributes of the CellChangeNotification
*/
typerecordCellChangeNotification{
Json.StringnotificationType,
TimeStamptimeStampoptional,
AssociateIdassociateId,
EcgisrcEcgi,
Ecgi_listtrgEcgi,
HoStatushoStatus,
TempUeId_tempUeId,
Linkslinksoptional
}with{
variant(links)"name as '_links'";
}
/**
* @desc This type represents a subscription to 5G UE measurement report notifications from Radio Network Information Service for UEs served by NR Cells
* @member notificationType Shall be set to "RabEstNotification"."
* @member timeStamp Time stamp
* @member ecgi E-UTRAN Cell Global Identifier
* @member associateId 0 to N identifiers to associate the event for a specific UE or flow
* @member erabId The attribute that uniquely identifies a Radio Access bearer for specific UE
* @member erabQosParameters QoS parameters for the E-RAB
* @member tempUeId The temporary identifier allocated for the specific UE
* @member links Links to resources related to this notification
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.4.3-1: Attributes of the RabEstNotification
*/
typerecordRabEstNotification{
Json.StringnotificationType,
TimeStamptimeStampoptional,
Ecgiecgi,
AssociateIdassociateId,
ErabIderabId,
ErabQosParameterserabQosParameters,
TempUeId_tempUeId,
Linkslinksoptional
}with{
variant(links)"name as '_links'";
}
/**
* @desc This type represents a notification from RNIS with regards to RAB modification procedure
* @member notificationType Shall be set to "RabModNotification"."
* @member timeStamp Time stamp
* @member ecgi E-UTRAN Cell Global Identifier
* @member associateId 0 to N identifiers to associate the event for a specific UE or flow
* @member erabId The attribute that uniquely identifies a Radio Access bearer for specific UE
* @member erabQosParameters QoS parameters for the E-RAB
* @member links Links to resources related to this notification
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.4.4-1: Attributes of the RabModNotification
*/
typerecordRabModNotification{
Json.StringnotificationType,
TimeStamptimeStampoptional,
Ecgiecgi,
AssociateIdassociateId,
ErabIderabId,
ErabQosParameterserabQosParameters,
Linkslinksoptional
}with{
variant(links)"name as '_links'";
}
/**
* @desc This type represents a notification from RNIS with regards to RAB release procedure
* @member notificationType Shall be set to "RabModNRabRelNotificationotification"."
* @member timeStamp Time stamp
* @member ecgi E-UTRAN Cell Global Identifier
* @member associateId 0 to N identifiers to associate the event for a specific UE or flow
* @member erabReleaseInfo The release information for the E-RAB
* @member links Links to resources related to this notification
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.4.5-1: Attributes of the RabRelNotification
*/
typerecordRabRelNotification{
Json.StringnotificationType,
TimeStamptimeStampoptional,
Ecgiecgi,
AssociateIdassociateId,
ErabReleaseInfoerabReleaseInfo,
Linkslinksoptional
}with{
variant(links)"name as '_links'";
}
/**
* @desc The release information for the E-RAB
* @member erabId The attribute that uniquely identifies a Radio Access bearer for specific UE
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.4.5-1: Attributes of the RabRelNotification
*/
typerecordErabReleaseInfo{
ErabIderabId
}
/**
* @desc Subscription to UE measurement report notifications from Radio Network Information Service for UEs served by E-UTRA Cells
* @member notificationType Shall be set to "MeasRepUeNotification"
* @member timeStamp Time stamp
* @member ecgi E-UTRAN Cell Global Identifier
* @member associateId 0 to N identifiers to associate the event for a specific UE or flow
* @member rsrp Reference Signal Received Power
* @member rsrpEx Extended Reference Signal Received Power
* @member rsrq Reference Signal Received Quality
* @member rsrqEx Extended Reference Signal Received Quality
* @member sinr Reference Signal "Signal to Interference plus Noise Ratio"
* @member trigger Corresponds to a specific E-UTRAN UE Measurement Report trigger
* @member eutranNeighbourCell This parameter can be repeated to contain information of all the neighbouring cells
* @member carrierAggregationMeasInfo This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation
* @member heightUe Indicates height of the UE in meters relative to the sea
* @member newRadioMeasInfo 5G New Radio secondary serving cells measurement information
* @member newRadioMeasNeiInfo Measurement quantities concerning the 5G NR neighbours
* @member links Hyperlink related to the resource
* @see ETSI GS MEC 012 V2.2.1 (2022-02) Table 6.4.6-1: Attributes of the MeasRepUeNotification
"summary":"Retrieve information about a list of bandwidthAllocation resources",
"description":"Retrieves information about a list of bandwidthAllocation resources. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5.",
"description":"Upon success, a response body containing an array of the bandwidthAllocations is returned.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BwInfo"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
},
"post":{
"tags":[
"bwm"
],
"summary":"Create a bandwidthAllocation resource",
"description":"Used to create a bandwidthAllocation resource. Typically used in 'Register to Bandwidth Management Service' procedure as described in clause 6.2.1.",
"operationId":"bandwidthAllocationPOST",
"parameters":[],
"requestBody":{
"description":"Entity body in the request contains BwInfo to be created.",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BwInfo"
}
}
}
},
"responses":{
"201":{
"description":"Upon success, the HTTP response shall include a 'Location' HTTP header that contains the resource URI of the created resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BwInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
}
},
"/bw_allocations/{allocationId}":{
"get":{
"tags":[
"bwm"
],
"summary":"Retrieve information about a specific bandwidthAllocation",
"description":"Retrieves information about a bandwidthAllocation resource. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5.",
"description":"Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BwInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
},
"put":{
"tags":[
"bwm"
],
"summary":"Update the information about a specific bandwidthAllocation",
"description":"Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics.",
"operationId":"bandwidthAllocationPUT",
"requestBody":{
"description":"BwInfo with updated information is included as entity body of the request.",
"description":"Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BwInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"412":{
"$ref":"#/components/responses/412"
}
}
},
"patch":{
"tags":[
"bwm"
],
"summary":"Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure",
"description":"Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PATCH HTTP method updates a resource on top of the existing resource state by just including the changes ('deltas') in the request body.",
"operationId":"bandwidthAllocationPATCH",
"requestBody":{
"description":"Description of the changes to instruct the server how to modify the resource representation.",
"description":"Upon success, a response 204 No Content without any response body is returned."
},
"400":{
"description":"Bad Request : used to indicate that incorrect parameters were passed to the request.",
"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"
}
}
}
},
"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"
}
}
}
}
},
"parameters":{
"Path.allocationId":{
"name":"allocationId",
"in":"path",
"description":"Represents a bandwidth allocation instance",
"required":true,
"schema":{
"type":"string"
}
},
"Query.app_instance_id":{
"name":"app_instance_id",
"in":"query",
"description":"A MEC application instance may use multiple app_instance_ids as an input parameter to query the bandwidth allocation of a list of MEC application instances. See note.",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
"Query.app_name":{
"name":"app_name",
"in":"query",
"description":"A MEC application instance may use multiple app_names as an input parameter to query the bandwidth allocation of a list of MEC application instances. See note.",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
"Query.session_id":{
"name":"session_id",
"in":"query",
"description":"A MEC application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. See note.",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
}
},
"schemas":{
"BwInfo":{
"properties":{
"allocationDirection":{
"description":"The direction of the requested BW allocation: 00 = Downlink (towards the UE) 01 = Uplink (towards the application/session) 10 = Symmetrical",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"appInsId":{
"description":"Application instance identifier",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"fixedAllocation":{
"description":"Size of requested fixed BW allocation in [bps]",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"fixedBWPriority":{
"description":"Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document",
"enum":[
"SEE_DESCRIPTION"
],
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Enum"
},
"requestType":{
"description":"Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_BW_ALLOCATION 1 = SESSION_SPECIFIC_BW_ALLOCATION",
"type":"integer",
"enum":[
0,
1
],
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum_inlined"
},
"sessionFilter":{
"description":"Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected",
"items":{
"type":"object",
"properties":{
"dstAddress":{
"description":"Destination address identity of session (including range)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"dstPort":{
"description":"Destination port identity of session",
"items":{
"type":"string"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"String"
},
"protocol":{
"description":"Protocol number",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"sourceIp":{
"description":"Source address identity of session (including range)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"sourcePort":{
"description":"Source port identity of session",
"items":{
"type":"string"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"String"
}
}
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Structure (inlined)"
},
"timeStamp":{
"description":"Time stamp to indicate when the corresponding information elements are sent",
"properties":{
"nanoSeconds":{
"description":"The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"seconds":{
"format":"uint32",
"type":"integer",
"description":"The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
}
},
"required":[
"seconds",
"nanoSeconds"
],
"type":"object",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Structure (inlined)"
}
},
"required":[
"appInsId",
"requestType",
"fixedAllocation",
"allocationDirection"
],
"type":"object",
"x-etsi-ref":"7.2.2"
},
"BwInfoDeltas":{
"properties":{
"allocationDirection":{
"description":"The direction of the requested BW allocation: 00 = Downlink (towards the UE) 01 = Uplink (towards the application/session) 10 = Symmetrical",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"appInsId":{
"description":"Application instance identifier",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"fixedAllocation":{
"description":"Size of requested fixed BW allocation in [bps]",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"fixedBWPriority":{
"description":"Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document",
"enum":[
"SEE DESCRIPTION"
],
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Enum_inlined"
},
"requestType":{
"description":"Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_BW_ALLOCATION 1 = SESSION_SPECIFIC_BW_ALLOCATION",
"type":"string",
"enum":[
0,
1
],
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum_inlined"
},
"sessionFilter":{
"description":"Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected",
"items":{
"type":"object",
"properties":{
"dstAddress":{
"description":"Destination address identity of session (including range)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"dstPort":{
"description":"Destination port identity of session",
"items":{
"type":"string"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"String"
},
"protocol":{
"description":"Protocol number",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"sourceIp":{
"description":"Source address identity of session (including range)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"sourcePort":{
"description":"Source port identity of session ",
"items":{
"type":"string"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"String"
}
}
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Structure (inlined)"
}
},
"required":[
"appInsId",
"requestType"
],
"type":"object",
"x-etsi-ref":"7.2.3"
},
"ProblemDetails":{
"properties":{
"detail":{
"description":"A human-readable explanation specific to this occurrence of the problem",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"instance":{
"description":"A URI reference that identifies the specific occurrence of the problem",
"format":"uri",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"URI"
},
"status":{
"description":"The HTTP status code for this occurrence of the problem",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"title":{
"description":"A short, human-readable summary of the problem type",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"type":{
"description":"A URI reference according to IETF RFC 3986 that identifies the problem type",
"description":"The present document focuses on the Multi-access Traffic Steering multi-access edge service. It describes the related application policy information including authorization and access control, information flows, required information and service aggregation patterns. The present document specifies the necessary API with the data model and data format.",
"summary":"Retrieve the MTS capability informations",
"description":"Used to query information about the MTS information. Typically used in the 'Get MTS service Info from the MTS Service' procedure as described in clause 6.2.6.",
"operationId":"mtsCapabilityInfoGET",
"parameters":[],
"responses":{
"200":{
"description":"Upon success, a response body containing the MTS capability information is returned.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MtsCapabilityInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
}
},
"/mts_sessions":{
"get":{
"tags":[
"mts"
],
"summary":"Retrieve information about a list of MTS sessions",
"description":"Retrieves information about a list of MTS sessions. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.",
"description":"Upon success, a response body containing an array of the MTS sessions is returned.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MtsSessionInfo"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
},
"post":{
"tags":[
"mts"
],
"summary":"Create a MTS session",
"description":"Used to create a MTS session. This method is typically used in 'Register application to the MTS Service' procedure as described in clause 6.2.7.",
"operationId":"mtsSessionPOST",
"parameters":[],
"requestBody":{
"description":"Entity body in the request contains MtsSessionInfo to be created.",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MtsSessionInfo"
}
}
}
},
"responses":{
"201":{
"description":"Upon success, the HTTP response shall include a 'Location' HTTP header that contains the resource URI of the created resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MtsSessionInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
}
},
"/mts_sessions/{sessionId}":{
"get":{
"tags":[
"mts"
],
"summary":"Retrieve information about specific MTS session",
"description":"Retrieves information about an individual MTS session. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.",
"operationId":"mtsSessionGET",
"parameters":[
{
"$ref":"#/components/parameters/Path.sessionId"
}
],
"responses":{
"200":{
"description":"Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MtsSessionInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
},
"put":{
"tags":[
"mts"
],
"summary":"Update the information about specific MTS session",
"description":"Updates the information about an individual MTS session. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics. ",
"operationId":"mtsSessionPUT",
"parameters":[
{
"$ref":"#/components/parameters/Path.sessionId"
}
],
"requestBody":{
"description":"MtsSessionInfo with updated information is included as entity body of the request.",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MtsSessionInfo"
}
}
}
},
"responses":{
"200":{
"description":"Used to indicate nonspecific success. The response body contains a representation of the resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MtsSessionInfo"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"412":{
"$ref":"#/components/responses/412"
}
}
},
"delete":{
"tags":[
"mts"
],
"summary":"Remove specific MTS session",
"description":"DELETE method is typically used in 'Unregister from the MTS Service' procedure as described in clause 6.2.8.",
"operationId":"mtsSessionDELETE",
"parameters":[
{
"$ref":"#/components/parameters/Path.sessionId"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
}
}
}
}
},
"components":{
"responses":{
"204":{
"description":"Upon success, a response 204 No Content without any response body is returned."
},
"400":{
"description":"Bad Request : used to indicate that incorrect parameters were passed to the request.",
"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"
}
}
}
},
"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"
}
}
}
}
},
"parameters":{
"Path.sessionId":{
"name":"sessionId",
"in":"path",
"description":"Represents a MTS session instance",
"required":true,
"schema":{
"type":"string"
}
},
"Query.app_instance_id":{
"name":"app_instance_id",
"in":"query",
"description":"A MEC application instance may use multiple app_instance_ids as an input parameter to query the MTS session of a list of MEC application instances. See note.",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
"Query.app_name":{
"name":"app_name",
"in":"query",
"description":"A MEC application instance may use multiple app_names as an input parameter to query the MTS session of a list of MEC application instances. See note.",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
"Query.session_id":{
"name":"session_id",
"in":"query",
"description":"A MEC application instance may use session_id as an input parameter to query the information of a list of MTS sessions. See note.",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
}
},
"schemas":{
"MtsCapabilityInfo":{
"properties":{
"mtsAccessInfo":{
"description":"The information on access network connection as defined below",
"items":{
"type":"object",
"properties":{
"accessId":{
"format":"uint32",
"type":"integer",
"description":"Unique identifier for the access network connection",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"accessType":{
"format":"uint32",
"type":"integer",
"description":"Numeric value (0-255) corresponding to specific type of access network as following: 0 = Unknown 1 = Any IEEE802.11-based WLAN technology 2 = Any 3GPP-based Cellular technology 3 = Any Fixed Access 11 = IEEE802.11 a/b/g WLAN 12 = IEEE 802.11 a/b/g/n WLAN 13 = IEEE 802.11 a/b/g/n/ac WLAN 14 = IEEE 802.11 a/b/g/n/ac/ax WLAN (Wi-Fi 6) 15 = IEEE 802.11 b/g/n WLAN 31 = 3GPP GERAN/UTRA (2G/3G) 32 = 3GPP E-UTRA (4G/LTE) 33 = 3GPP NR (5G)",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"metered":{
"format":"uint32",
"type":"integer",
"description":"Numeric value (0-255) corresponding to the following: 0: the connection is not metered (see note) 1: the connection is metered 2: unknown ",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
}
}
},
"required":[
"accessId",
"accessType",
"metered"
],
"minItems":1,
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"Structure (inlined)"
},
"mtsMode":{
"description":"Numeric value corresponding to a specific MTS operation supported by the TMS 0 = low cost, i.e. using the unmetered access network connection whenever it is available 1 = low latency, i.e. using the access network connection with lower latency 2 = high throughput, i.e. using the access network connection with higher throughput, or/and multiple access network connection simultaneously if supported 3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for highreliability and low-latency applications 4 = QoS, i.e. performing MTS based on the specific QoS requirements from the app",
"items":{
"type":"integer",
"format":"uint32"
},
"minItems":1,
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"Uint32"
},
"timeStamp":{
"description":"Time stamp to indicate when the corresponding information elements are sent",
"properties":{
"nanoSeconds":{
"format":"uint32",
"type":"integer",
"description":"Time in nanoseconds in Unix-time since January 1, 1970, 00:00:00 UTC",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"seconds":{
"description":"Time in seconds in Unix-time since January 1, 1970, 00:00:00 UTC",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
}
},
"required":[
"seconds",
"nanoSeconds"
],
"type":"object",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Structure (inlined)"
}
},
"required":[
"mtsAccessInfo",
"mtsMode"
],
"type":"object",
"x-etsi-notes":"NOTE:\tA metered connection is a network connection that has a maximum data usage in a specific period, e.g. per hour/day/week/month. The user may get billed extra charges if they go over the allotted amount.",
"x-etsi-ref":"7.2.4"
},
"MtsSessionInfo":{
"properties":{
"appInsId":{
"description":"Application instance identifier",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
},
"flowFilter":{
"description":"Traffic flow filtering criteria, applicable only if when requestType is set as FLOW_SPECIFIC_MTS_SESSION. Any filtering criteria shall define a single session only. In case multiple sessions match flowFilter the request shall be rejected. 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",
"items":{
"type":"object",
"properties":{
"dscp":{
"format":"uint32",
"type":"integer",
"description":"DSCP in the IPv4 header or Traffic Class in the IPv6 header",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"dstIp":{
"description":"Destination address identity of session (including range)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"dstPort":{
"description":"Destination port identity of session",
"items":{
"type":"integer",
"format":"uint32"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Uint32"
},
"flowlabel":{
"format":"uint32",
"type":"integer",
"description":"Flow Label in the IPv6 header, applicable only if the flow is IPv6",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"protocol":{
"format":"uint32",
"type":"integer",
"description":"Protocol number",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"sourceIp":{
"description":"Source address identity of session (including range)",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"sourcePort":{
"description":"Source port identity of session",
"items":{
"type":"integer",
"format":"uint32"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"Uint32"
}
}
},
"minItems":1,
"type":"array",
"x-etsi-mec-cardinality":"1..N",
"x-etsi-mec-origin-type":"Structure (inlined)"
},
"mtsMode":{
"format":"uint32",
"type":"integer",
"description":"Numeric value (0 - 255) corresponding to a specific MTS mode of the MTS session: 0 = low cost, i.e. using the unmetered access network connection whenever it is available 1 = low latency, i.e. using the access network connection with lower latency 2 = high throughput, i.e. using the access network connection with higher throughput, or multiple access network connection simultaneously 3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for high-reliability and low-latency applications 4 = QoS, i.e. performing MTS based on the QoS requirement (qosD)",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"qosD":{
"description":"QoS requirement description of the MTS session, applicable only if mtsMode = 4 (QoS). If the qosD field is included, at least one of its subfields shall be included. Any qosD subfield that is not included shall be ignored in Multi-access Traffic Steering (MTS)",
"properties":{
"maxJitter":{
"description":"tolerable jitter in [10 nanoseconds]",
"type":"integer",
"format":"uint32",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"maxLatency":{
"description":"tolerable (one-way) delay in [10 nanoseconds]",
"type":"integer",
"format":"uint32",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"maxLoss":{
"description":"tolerable packet loss rate in [1/10^x]",
"type":"integer",
"format":"uint32",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"minTpt":{
"description":"minimal throughput in [kbps]",
"type":"integer",
"format":"uint32",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"priority":{
"description":"numeric value (0 - 255) corresponding to the traffic priority 0: low; 1: medium; 2: high; 3: critical",
"type":"integer",
"format":"uint32",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
}
},
"type":"object",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Structure"
},
"requestType":{
"description":"Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 = APPLICATION_SPECIFIC_MTS_SESSION 1 = FLOW_SPECIFIC_MTS_SESSION",
"enum":[
0,
1
],
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum_inlined"
},
"timeStamp":{
"description":"Time stamp to indicate when the corresponding information elements are sent ",
"properties":{
"nanoSeconds":{
"format":"uint32",
"type":"integer",
"description":"The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
},
"seconds":{
"format":"uint32",
"type":"integer",
"description":"The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Uint32"
}
},
"required":[
"seconds",
"nanoSeconds"
],
"type":"object",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Structure (inlined)"
},
"trafficDirection":{
"description":"The direction of the requested MTS session: 00 = Downlink (towards the UE) 01 = Uplink (towards the application/session) 10 = Symmetrical (see note) ",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
}
},
"required":[
"appInsId",
"requestType",
"flowFilter",
"qosD",
"mtsMode",
"trafficDirection"
],
"type":"object",
"x-etsi-notes":"NOTE:\tFor the downlink direction of a symmetrical flow, \"sourceIp\" and \"sourcePort\" in the \"flowFilter\" structure are used for source address and port, respectively; \"dstIp\" and \"dstPort\" are used for destination address and port, respectively. For the uplink direction of a symmetrical flow, \"sourceIp\" and \"sourcePort\" are used for destination address and port, respectively; \"dstIp\" and \"dstPort\" are used for source address and port, respectively.",
"x-etsi-ref":"7.2.5"
},
"ProblemDetails":{
"properties":{
"detail":{
"description":"A human-readable explanation specific to this occurrence of the problem",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"instance":{
"description":"A URI reference that identifies the specific occurrence of the problem",
"format":"uri",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"URI"
},
"status":{
"description":"The HTTP status code for this occurrence of the problem",
"format":"uint32",
"type":"integer",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"Uint32"
},
"title":{
"description":"A short, human-readable summary of the problem type",
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
"type":{
"description":"A URI reference according to IETF RFC 3986 that identifies the problem type",
