Multicast Subscriptions

/multicast-subscriptions

POST

Create a new Individual Multicast Subscription resource.

Individual Multicast Subscription

/multicast-subscriptions/{multiSubId}

GET

Read an Individual Multicast Subscription resource.

DELETE

Remove an Individual Multicast Subscription resource.

Unicast Subscriptions

/unicast-subscriptions

POST

Create a new Individual Unicast Subscription resource.

Individual Unicast Subscription

/unicast-subscriptions/{uniSubId}

GET

Read an Individual Unicast Subscription resource.

DELETE

Remove an Individual Unicast Subscription resource.

TSC Stream Availability

/tsc-stream-availability

GET

Retrieve TSC stream availability information.

TSC Streams

/tsc-streams

GET

Retrieve TSC stream information.

Individual TSC Stream

/tsc-streams/{valStreamId}

GET

Read an Individual TSC stream resource.

PUT

Create a new Individual TSC stream resource.

DELETE

Remove an Individual TSC stream resource.

GET

Read an Individual TSC stream resource.

apiRoot

string

See clause 6.5

MulticastSubscription

M

1

MulticastSubscription

M

1

201 Created

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nra/<apiVersion>/multicast-subscriptions/{multiSubId}

apiRoot

string

6.5

multiSubId

string

The multicast subscription identifier.

n/a

n/a

MulticastSubscription

M

1

200 OK

n/a

307 Temporary Redirect

Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

n/a

n/a

n/a

204 No Content

Successful case. The Individual Multicast Subscription resource was deleted.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

apiRoot

string

See clause 6.5

UnicastSubscription

M

1

UnicastSubscription

M

1

201 Created

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nra/<apiVersion>/unicast-subscriptions/{uniSubId}

apiRoot

string

See clause 6.5.

uniSubId

string

The unicast subscription identifier.

n/a

n/a

UnicastSubscription

M

1

200 OK

n/a

307 Temporary Redirect

Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

n/a

n/a

n/a

204 No Content

Successful case. The Individual Unicast Subscription resource was deleted.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

apiRoot

string

See clause 6.5.

stream-specs

array(StreamSpecification)

M

1..N

The MAC address(es) of the source DS-TT port(s) and the destination DS-TT port(s).

n/a

array(TscStreamAvailability)

M

1..N

200 OK

List of TSC stream availability information, each including the stream specification and list of traffic specifications. This response shall include stream specification matching the query parameters provided in the request.

N/A

O

0..1

204 No Content

Indicates no stream specification matching with the query parameters, no TSC stream avaiability information.

N/A

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

N/A

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

apiRoot

string

See clause 6.5.

val-stream-ids

array(string)

O

1..N

Retrieval of all the TSC stream resources managed by the NRM server or the TSC Stream resource(s) identified by the VAL Stream ID(s).

n/a

array(TscStreamData)

M

1..N

200 OK

Retrieval of TSC stream data information.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

apiRoot

string

See clause 6.5.

valStreamId

string

The VAL Stream ID identifies the TSC stream.

n/a

n/a

TscStreamData

M

1

200 OK

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

String

M

1

An alternative URI of the resource located in an alternative network resource management server.

n/a

TscStreamData

M

1

TSC stream creation request data from the VAL server to the NRM server.

TscStreamData

M

1

201 Created

TSC stream created data response from the NRM server to the VAL server.

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply.

Location

String

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nra/<apiVersion>/tsc-streams/{valStreamId}

n/a

204 No Content

Successful case. The Individual TSC Stream resource was deleted.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Location

string

M

1

An alternative URI of the resource located in an alternative network resource management server.

Notify_UP_Delivery_Mode

{notifUri}

POST

Report User Plane notification

n/a

UserPlaneNotification

M

1

n/a

204 No Content

The receipt of the Notification is acknowledged.

n/a

307 Temporary Redirect

Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected.

DeliveryMode

7.4.1.4.3.2

Indicates the delivery mode.

MulticastSubscription

7.4.1.4.2.2

Represents a multicast subscription.

NrmEvent

7.4.1.4.3.3

Indicates the NRM event.

NrmEventNotification

7.4.1.4.2.5

Represents a notification on an individual User Plane event.

ServiceAnnoucementMode

7.4.1.4.3.1

Indicates the service announcement mode.

StreamSpecification

7.4.1.4.2.9

Represents a stream specification that includes MAC addresses of the source and destination DS-TT ports.

TrafficSpecification

7.4.1.4.2.10

Represents the traffic class supported by the DS-TTs and available end-to-end maximum latency value.

TrafficSpecInformation

7.4.1.4.2.7

Represents the traffic class supported by the DS-TTs and available end-to-end latency value and Priority Code Point (PCP) value.

TscStreamAvailability

7.4.1.4.2.8

Represents the TSC stream availability information including the stream specification and list of traffic specifications.

TscStreamData

7.4.1.4.2.6

Represents the TSC stream data information.

UnicastSubscription

7.4.1.4.2.3

Represents a unicast subscription.

UserPlaneNotification

7.4.1.4.2.4

Represents a notification on User Plane events.

DateTime

3GPP TS 29.571 [21]

Used to represent the subscription duration.

DurationSec

3GPP TS 29.122 [3]

Used to represent the duration in seconds.

Ipv4Addr

3GPP TS 29.571 [21]

Used to identify the IPv4 address.

Ipv6Addr

3GPP TS 29.571 [21]

Used to identify the IPv6 address.

LocalMbmsInfo

3GPP TS 29.486 [27]

Used to represent the local MBMS information.

LocalMBMS

MacAddr48

3GPP TS 29.571 [21]

Used to identify a MAC address.

MbmsLocArea

3GPP TS 29.122 [3]

Used to indicate the requested area of the MBMS bearer.

Port

3GPP TS 29.122 [3]

Used to identify the port.

SupportedFeatures

3GPP TS 29.571 [21]

Used to negotiate the supported optional features of the API.

Uint32

3GPP TS 29.571 [21]

Represents an unsigned integer.

Uinteger

3GPP TS 29.571 [21]

Represents an unsigned integer.

Uri

3GPP TS 29.571 [21]

Used to indicate the notification URI.

ValTargetUe

7.3.1.4.2.3

Used to identify either a VAL User ID or a VAL UE ID.

WebsockNotifConfig

3GPP TS 29.122 [3]

Used to indicate the configuration parameters to set up notification delivery over Websocket protocol.

valGroupId

string

M

1

The identity of the group that the MBMS bearer is requested for.

anncMode

ServiceAnnoucementMode

M

1

Indicates whether the service announcement is sent by NRM server or by the VAL server.

multiQosReq

string

M

1

The QoS requirement for the multicast.

locArea

MbmsLocArea

O

0..1

Indicate the area where the MBMS bearer is requested for.

duration

DateTime

O

0..1

Identifies the absolute time at which the subscription resource is considered to expire. When omitted in the request, it indicates the resource is requested to be valid forever by the VAL server. When omitted in the response, it indicates the resource is set to valid forever by the VAL server.

tmgi

Uint32

O

0..1

TMGI.

Shall be provided by the NRM server if announcement mode is set to VAL.

localMbmsInfo

LocalMbmsInfo

O

0..1

Contains the local MBMS information. The information only can be provided by the NF service consumer in the trust domain.

LocalMBMS

localMbmsActInd

boolean

O

0..1

Set to true by the NF service consumer to indicate that the local MBMS is activated.

Set to false or omitted otherwise.

LocalMBMS

notifUri

Uri

M

1

Identifies the notification URI where the NRM notification shall be sent to.

reqTestNotif

boolean

O

0..1

Set to true by the NF service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise.

Notification_test_event

wsNotifCfg

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.3.5.4.

Notification_websocket

suppFeat

SupportedFeatures

C

0..1

Used to negotiate the applicability of optional features defined in table 7.4.1.6-1.

This parameter may be supplied by the VAL server in the POST request that requests the creation of a Multicast Subscription resource and shall be supplied in the corresponding POST response if it was present in the request.

upIpv4Addr

Ipv4Addr

O

0..1

Ipv4address of the user plane. (NOTE)

upIpv6Addr

Ipv6Addr

O

0..1

Ipv6address of the user plane. (NOTE)

upPortNum

Port

O

0..1

UDP port number of the user plane.

radioFreqs

array(Uint32)

O

1..N

The radio frequencies which may be provided by the NRM server.

NOTE: At least one of upIpv4Addr or upIpv6Addr shall be provided by the NRM server.

valTgtUe

ValTargetUe

M

1

The identity of the VAL user or VAL UE that the unicast bearer is requested for.

uniQosReq

string

O

0..1

The QoS requirement for the unicast.

duration

DateTime

O

0..1

Identifies the absolute time at which the subscription resource is considered to expire. When omitted in the request, it indicates the resource is requested to be valid forever by the VAL server. When omitted in the response, it indicates the resource is set to valid forever by the VAL server.

notifUri

Uri

M

1

Identifies the notification URI where the NRM notification shall be sent to.

reqTestNotif

Boolean

O

0..1

Set to true by the NF service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise.

Notification_test_event

wsNotifCfg

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.3.5.4.

Notification_websocket

suppFeat

SupportedFeatures

O

1

This parameter may be supplied by VAL server in the POST request that request the creation of a Unicast Subscription resource and may be supplied in the reply of corresponding request.

notifId

Uri

M

1

The subscription resource Uri to which this notification is related.

eventNotifs

array(NrmEventNotification)

M

1..N

Notifications about Individual Events

event

NrmEvent

M

1

Event that is notified.

ts

DateTime

M

1

Time at which the event is observed.

deliveryMode

DeliveryMode

C

0..1

Indicates delivery of the user data to the UE(s) via unicast mode or multicast mode.

Shall be present if event is UP_DELIVERY_MODE.

streamIds

array(string)

O

1..N

Indicates the media streams (unicast or multicast) to be used.

May be present if event is UP_DELIVERY_MODE and NRM already has the streams available.

streamSpec

StreamSpecification

M

1

Stream specification includes MAC addresses of the source and destination DS-TT ports.

trafficSpecInfo

TrafficSpecInformation

M

1

Traffic Specification Information includes Priority Code Point (PCP), MaxFrameInterval, MaxFrameSize, MaxIntervalFrames, MaxLatency, etc. (e.g. as described in IEEE 802.1Qcc [29] in clause 46.2).

pcpValue

Uint32

M

1

The Priority Code Point (PCP) value identify the traffic class, with value between 0 to 7.

maxFramInt

DurationSec

M

1

Maximum Frame Interval.

maxFramSize

Uint32

M

1

Maximum frame size will transmit, excluding the overhead.

maxIntFrames

Uint32

M

1

Maximum interval frames.

maxLatency

Uint32

M

1

Indicates the end-to-end latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays) in milliseconds.

streamSpec

StreamSpecification

M

1

Stream specification includes MAC addresses of the source and destination DS-TT ports.

trafficSpecs

array(TrafficSpecification)

M

1..N

The traffic classes supported by the DS-TTs and available end-to-end maximum latency values.

srcMacAddr

MacAddr48

M

1

The MAC address of the source DS-TT port.

dstMacAddr

MacAddr48

M

1

The MAC address of the destination DS-TT port.

trafficClass

Uint32

M

1

The traffic class supported by the DS-TTs with value between 0 to 7.

e2eMaxLatency

Uinteger

M

1

Indicates the end to end maximum latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays), in the units of milliseconds.

NRM

NRM server performs the service announcement.

VAL

VAL server performs the service announcement.

UNICAST

Unicast delivery

MULTICAST

Multicast delivery

UP_DELIVERY_MODE

User Plane delivery mode.

1

Notification_test_event

The testing of notification connection is supported according to clause 6.6.

2

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 6.6. This feature requires that the Notification_test_event feature is also supported.

3

LocalMBMS

Indicate the support of local MBMS transmission.

Unicast Monitoring Subscriptions

/subscriptions

POST

Create individual unicast monitoring subscription resource or obtain unicast QoS monitoring data for VAL UEs, VAL Group, or VAL Streams.

Individual Unicast Monitoring Subscription

/subscriptions/{subscriptionId}

DELETE

Remove an existing individual unicast monitoring subscription resource according to the subscriptionId.

GET

Read an existing individual unicast monitoring subscription resource according to the subscriptionId.

PUT

Update an individual unicast monitoring subscription identified by the subscriptionId.

PATCH

Modify an individual unicast monitoring subscription identified by the subscriptionId.

apiRoot

string

See clause 7.4.2.1.

MonitoringSubscription

M

1

MonitoringSubscription

M

1

201 Created

The requested individual monitoring subscription resource is successfully created and a representation of the created resource is returned in the response body.

MonitoringReport

M

1

200 OK

The requested unicast QoS monitoring data is returned.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nrm/<apiVersion>/subscriptions{subscriptionId}

apiRoot

string

See clause 7.4.2.1.

subscriptionId

string

Represents the identifier of an individual unicast monitoring subscription resource.

n/a

n/a

n/a

204 No Content

The Individual Unicast Monitoring Subscription resource matching the subscriptionId is deleted.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NRM server.

Location

string

M

1

An alternative URI of the resource located in an alternative NRM server.

n/a

MonitoringSubscription

M

1

200 OK

The requested individual unicast monitoring subscription is returned.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.122 [3] shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NRM server.

Location

string

M

1

An alternative URI of the resource located in an alternative NRM server.

n/a

MonitoringSubscription

M

1

Updated details of the unicast QoS monitoring subscription.

The target identifiers, i.e., the "valUeIds", "valGroupId”, and "valStreamIds" attributes shall not be changed in the MonitoringSubscription data structure.

MonitoringSubscription

M

1

200 OK

The subscription is updated successfully, and the updated subscription information returned in the response.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative location management server.

Location

string

M

1

An alternative URI of the resource located in an alternative location management server.

n/a

MonitoringSubscriptionPatch

M

1

Contains the modifications to be applied to the individual unicast QoS monitoring subscription resource.

MonitoringSubscription

M

1

200 OK

Individual unicast QoS monitoring subscription resource is modified successfully and representation of the modified individual unicast QoS monitoring subscription resource is returned.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SEAL server.

Location

string

M

1

An alternative URI of the resource located in an alternative SEAL server.

Individual Unicast Monitoring Notification

{notifUri}

POST

Notify on updates of the individual monitoring resource accodring to the requested reporting settings.

n/a

MonitoringReport

M

1

Represents the reported monitoring data.

n/a

204 No Content

The notification is successfully received.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected.

FailureReport

7.4.2.4.2.9

Represents the failure report indicating the VAL UE(s) or VAL Stream ID(s) for which the NRM server failed to obtain the requested data.

FailureReason

7.4.2.4.3.3

Represents the failure reason.

MeasurementData

7.4.2.4.2.3

Presents the aggregated measurement data.

MeasurementDataType

7.4.2.4.3.1

Indicates the requested measurement data type.

MeasurementPeriod

7.4.2.4.2.4

Indicates the measurement time period.

MeasurementRequirements

7.4.2.4.2.6

Indicates the measurement requirements.

MonitoringReport

7.4.2.4.2.2

Indicates the monitoring report for VAL UEs list, VAL Group, or VAL Stream.

MonitoringSubscription

7.4.2.4.2.7

The monitoring subscription request.

MonitoringSubscriptionPatch

7.4.2.4.2.11

Represents the monitoring subscription modification request.

UpdateSupport

ReportingRequirements

7.4.2.4.2.5

Indicates the requested requirements of reporting.

ReportingThreshold

7.4.2.4.2.10

Indicates a requested reporting threshold.

TerminationMode

7.4.2.4.3.2

Indicates the termination mode.

ThresholdHandlingMode

7.4.2.4.3.4

Indicates the multi-parameter threshold handling mode.

AverWindow

3GPP TS 29.571 [21]

Used to represent an aggregation window.

BitRate

3GPP TS 29.571 [21]

Used to represent a bit rate measurement value.

DateTime

3GPP TS 29.571 [21]

Used to represent a date and time.

DurationSec

3GPP TS 29.571 [21]

Used to represent a measurement timestamp and measurement start time.

MatchingDirection

3GPP TS 29.520 [33]

Used to indicate a threshold matching direction.

NotificationMethod

3GPP TS 29.508 [32]

Used to indicate the reporting mode.

PacketLossRate

3GPP TS 29.571 [21]

Used to represent a packet loss rate measurement value.

SupportedFeatures

3GPP TS 29.571 [21]

Used to negotiate the supported optional features of the API.

Uinteger

3GPP TS 29.571 [21]

Used to represent integer attributes within MeasurementData and ReportingRequirements data structures.

Uri

3GPP TS 29.571 [21]

Used to indicate the notification URI.

ValTargetUe

clause 7.3.1.4.2.3

Used to identify either a VAL User ID or a VAL UE ID.

WebsockNotifConfig

3GPP TS 29.122 [3]

Used to indicate the configuration parameters to set up notification delivery over Websocket protocol.

valUeIds

array(ValTargetUe)

C

1..N

List of VAL UEs whose measurement data is provided (NOTE).

valGroupId

string

C

0..1

The group ID used for the VAL group for which measurement data is provided (NOTE).

valStreamIds

array(string)

C

1..N

List of VAL stream IDs whose measurement data (NOTE).

measData

MeasurementData

M

1

The aggregated measurement data.

timestamp

DateTime

M

1

The timestamp of the measurement.

failureRep

array(FailureReport)

C

1..N

The failure report from the NRM server indicating the VAL UE(s) or VAL Stream ID(s) whose measurement data is not obtained successfully and is not provided in the monitoring report.

This attribute shall be provided by the NRM server when the requested measurement data is not obtained successfully for all the requested VAL UE(s) or VAL Stream ID(s).

NOTE: Only one of these attributes shall be provided.

dlDelay

Uinteger

O

0..1

The downlink packet delay in milliseconds (NOTE).

ulDelay

Uinteger

O

0..1

The uplink packet delay in milliseconds (NOTE).

rtDelay

Uinteger

O

0..1

The round trip packet delay in milliseconds (NOTE).

avgPlr

PacketLossRate

O

0..1

The average packet loss rate (NOTE).

avgDataRate

BitRate

O

0..1

The average data rate (NOTE).

maxDataRate

BitRate

O

0..1

The maximum data rate (NOTE).

avrDlTrafficVol

Uinteger

O

0..1

The average traffic volume for downlink in bytes (NOTE).

avrUlTrafficVol

Uinteger

O

0..1

The average traffic volume for uplink in bytes (NOTE).

NOTE: At least one of the measurement indexes shall be provided.

measStartTime

DateTime

M

1

Indicate the starting time for the measurement.

measDuration

DurationSec

M

1

Indicate the duration for the measurement starting from the measStartTime.

reportingMode

NotificationMethod

M

1

The indication of the requested reporting option: one-time, periodic or event-triggered (i.e. "ON_EVENT_DETECTION")

This attribute may be set to the value "ONE_TIME" only if the "immRep" attribute is provided and set to "true"..

reportingPeriod

DurationSec

C

0..1

Identifies the reporting time interval for the periodic reporting. (NOTE 1).

reportingThrs

array(ReportingThreshold)

C

1..N

Identifies reporting threshold corresponding to the measurement index(es). (NOTE 2).

immRep

boolean

O

0..1

It indicates immediate reporting. When included and set to true, it indicates that immediate reporting of the subscribed event(s) is requested.

repTerminMode

TerminationMode

O

0..1

The indication of the requested reporting termination mode: time-triggered, event-triggered (number of reports reached), event-triggered (threshold reached) or user-triggered.

If absent, user-triggered reporting is used as the default termination mode.

expirationTimer

DurationSec

C

0..1

Identifies the reporting time interval for the time triggered termination mode.

(NOTE 3).

maxNumRep

Uinteger

C

0..1

Indicates the maximum number of reports (number of reports reached).

(NOTE 4).

termThr

MeasurementData

C

0..1

Indicates the reporting termination threshold(s) corresponding to the measurement index(ex).

(NOTE 5, NOTE 6, NOTE 7).

termThrMode

ThresholdHandlingMode

C

0..1

Indicates the multi-parameter threshold handling for the event-triggered threshold reached reporting termination.

(NOTE 8).

NOTE 1: The "reportingPeriod" attribute shall be present only when the "reportingMode" attribute is set to "PERIODIC".

NOTE 2: The "reportingThr" attribute shall be present only when the "reportingMode" attribute is set to "ON_EVENT_DETECTION".

NOTE 3: The "expirationTimer" attribute shall be present only if the "repTerminMode" attribute is present and set to "TIME_TRIGGERED".

NOTE 4: The "maxNumRep" attribute shall be present only if the "repTerminMode" attribute is present and set to "EVENT_TRIGGERED_NUM_REPORTS_REACHED".

NOTE 5: The "termThr" attributes shall be present only when the "repTerminMode" attribute is present and set to "EVENT_TRIGGERED_MEAS_THR_REACHED".

NOTE 6: The event-triggered reporting termination condition for the "dlDelay", "ulDelay", "rtDelay" and "avgPlr" attributes within the MeasurementData data structure is met when the measured value is greater than or equal to the given threshold.

NOTE 7: The event-triggered reporting termination condition for the "avgDataRate", "maxDataRate", "avrDlTrafficVol" and "avrUlTrafficVol" attributes within the MeasurementData data structure is met when the measured value is less than or equal to the given threshold.

NOTE 8: The "termThrMode" attribute shall be present only when the "repTerminMode" attribute is present and set to "EVENT_TRIGGERED_MEAS_THR_REACHED" and the "termThr" contains more than one threshold.

measDataTypes

array(MeasurementDataType)

M

1..N

Indicates the required types of measurement data.

At least one measurement data type shall be present in the array structure.

measAggrGranWnd

AverWindow

O

0..1

It indicates the aggregation granularity window for the measured data (NOTE 1).

The aggregation granularity window shall not exceed the duration of the measurement time period defined in the "measPeriod" attribute.

measPeriod

MeasurementPeriod

O

0..1

It indicates the required measurement time period (NOTE 2).

NOTE 1: If absent, 1 minute shall be used as default setting.

NOTE 2: If absent, current time and 5 minutes duration shall be used as default setting.

valUeIds

array(ValTargetUe)

C

1..N

List of VAL UEs which measurement data reporting is requested (NOTE 1).

valGroupId

string

C

0..1

The group ID used for the VAL group for which measurement data reporting is requested (NOTE 1).

valStreamIds

array(string)

C

1..N

List of VAL streams for which measurement data reporting is requested (NOTE 1)

measReqs

MeasurementRequirements

O

0..1

It indicates the measurement requirements (NOTE 2).

reportReqs

ReportingRequirements

O

0..1

It indicates the requested requirements of reporting (NOTE 3).

notifiUri

Uri

C

0..1

It indicates the URI where the notification should be delivered to. The notifiUri attribute shall be presented for subscription without immediate report.

monRep

MonitoringReport

C

0..1

Contains the unicast QoS monitoring data reporting.

The NRM server shall provide this attribute when immediate reporting is requested and the requested data is available.

reqTestNotif

boolean

O

0..1

Set to true by the NF service consumer to request the VAL server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise.

Notification_test_event

wsNotifCfg

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.3.5.4.

Notification_websocket

suppFeat

SupportedFeatures

C

0..1

This parameter shall be supplied by VAL server in the POST request that request the creation of an individual measurement resource and shall be supplied in the reply of corresponding request.

NOTE 1: Only one of these attributes shall be provided.

NOTE 2: If absent, the default values shall be used.

NOTE 3: If absent, the default event triggered reporting is used.

valUeIds

array(ValTargetUe)

C

1..N

List of VAL UE(s) whose measurement data is not obtained successfully and is not provided (NOTE).

The VAL UE(s) may be member(s) of the VAL group identified by the "valGroupId" attribute in the MonitoringReport data structure.

valStreamIds

array(string)

C

1..N

List of VAL stream ID(s) whose measurement data is not obtained successfully and is not provided (NOTE).

failureReason

FailureReason

M

1

Identifies the failure reason.

measDataType

MeasurementDataType

C

0..1

The indication of the measurement data type that is not obtained successfully and is not provided in the monitoring report.

This attribute shall be provided if the failure reason does not apply to all the requested measurement data types.

NOTE: Only one of these attributes shall be provided.

measThrValues

MeasurementData

M

1

Indicates the value(s) for the measurement threshold index(es).

thrDirection

MatchingDirection

M

1

Indicates the threshold matching direction for the measurement threshold index(es) provided in the "measThrValues" attribute.

measReqs

MeasurementRequirements

O

0..1

Indicates the measurement requirements.

reportReqs

ReportingRequirements

O

0..1

Indicates the reporting requirements.

notifUri

Uri

O

0..1

Indicates the URI where the notification should be delivered to.

DL_DELAY

The indication for requesting the downlink packet delay data type.

UL_DELAY

The indication for requesting the uplink packet delay data type.

RT_DELAY

The indication for requesting the round trip packet delay data type.

AVG_PLR

The indication for requesting the average packet loss rate data type.

AVG_DATA_RATE

The indication for requesting the average data rate data type.

MAX_DATA_RATE

The indication for requesting the maximum data rate data type.

AVG_DL_TRAFFIC_VOLUME

The indication for requesting the average traffic volume for downlink data type.

AVG_UL_TRAFFIC_VOLUME

The indication for requesting the average traffic volume for uplink data type.

TIME_TRIGGERED

The time-triggered termination mode.

EVENT_TRIGGERED_NUM_REPORTS_REACHED

The event-triggered termination number of reports reached mode.

EVENT_TRIGGERED_MEAS_THR_REACHED

The event-triggered termination measurement index threshold reached mode.

USER_TRIGGERED

The user-triggered termination mode.

USER_NOT_FOUND

The user is not found.

STREAM_NOT_FOUND

The stream is not found.

DATA_NOT_AVAILABLE

The requested data is not available.

OTHER_REASON

Other reason (unspecified).

ALL_REACHED

The decision criterion is met when all the provided thresholds are reached.

ANY_REACHED

The decision criterion is met when any of the provided threshold(s) is reached.

1

Notification_test_event

The testing of notification connection is supported according to clause 6.6.

2

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 6.6. This feature requires that the Notification_test_event feature is also supported.

3

UpdateSupport

Indicates the support of the Update_Unicast_QoS_Monitoring_Subscription service operation. This feature enables the support of both HTTP PUT and HTTP PATCH methods for the SS_NetworkResourceMonitoring API.