PpData

/{ueId}/pp-data

PATCH

Modify the UE’s modifiable subscription data

Send updated SoR Information for a UE to the UDM

5GVnGroupConfiguration

/5g-vn-groups/{extGroupId}

PUT

Create a 5G VN Group

DELETE

Delete a 5G VN Group

PATCH

Modify a 5G VN Group

ParameterProvisioningDataEntry

/{ueId}/pp-data-store/{afInstanceId}

PUT

Create or update a Parameter Provisioning Data entry per AF

DELETE

Delete a Parameter Provisioning Data entry per AF

GET

Retrieve a Parameter Provisioning Data entry per AF

apiRoot

string

See clause 6.5.1

ueId

string

Represents a single UE or a group of UEs.

– If representing a single UE, this parameter shall contain the Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) or SUPI.
pattern: See pattern of data type VarUeId in 3GPP TS 29.571 [7]

– If representing a group of UEs, this parameter shall contain the External GroupId.

pattern: "^extgroupid-[^@]+@[^@]+$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

PpData

M

1

Contains the data to be provisioned or the updated SoR Information to be conveyed to a UE.

n/a

204 No Content

Upon success, an empty response body shall be returned. (NOTE 2)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– MODIFICATION_NOT_ALLOWED

– DETACHED_USER

– AF_NOT_ALLOWED

– MTC_PROVIDER_NOT_ALLOWED

NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult.

apiRoot

string

See clause 6.5.1

extGroupId

ExtGroupId

Represents the external Identifier of the 5G VN group
pattern: "^extgroupid-[^@]+@[^@]+$"

n/a

5GVnGroupConfiguration

M

1

Contains the configuration of the 5G VN Group

n/a

201 Created

Upon success, an empty response shall be returned.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– CREATION_NOT_ALLOWED

– AF_NOT_ALLOWED

– MTC_PROVIDER_NOT_ALLOWED

NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

mtc-provider-info

MtcProviderInformation

O

0..1

The mtc-provider-info contains the MTC Provider information that originates 5G-VN-Group deletion, it is used by the UDM to check whether the MTC Provider is allowed to perform this operation for the UE if the MTC provider authorization is required.

af-id

string

O

0..1

The af-Id contains the AF ID that originates 5G-VN-Group deletion, it is used by the UDM to check whether the AF is allowed to perform this operation for the UE if the AF authorization is required.

It is formatted as described in the definition of type MonitoringConfiguration.

n/a

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– GROUP_IDENTIFIER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– AF_NOT_ALLOWED

– MTC_PROVIDER_NOT_ALLOWED

NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

5GVnGroupConfiguration

M

1

Contains the modification instruction

n/a

204 No Content

Upon success, an empty response body shall be returned. (NOTE 2)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– GROUP_IDENTIFIER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– MODIFICATION_NOT_ALLOWED

– AF_NOT_ALLOWED

– MTC_PROVIDER_NOT_ALLOWED

NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult.

N/A

N/A

5GVnGroupConfiguration

200 OK

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– GROUP_IDENTIFIER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– AF_NOT_ALLOWED

apiRoot

string

See clause 6.5.1

ueId

string

Represents the Subscription Identifier SUPI, GPSI, Group Id or anyUE (see 3GPP TS 23.501 [4] clause 5.9.2)

– If representing a single UE, this parameter shall contain the GPSI or SUPI.
pattern: See pattern of type VarUeId 3GPP TS 29.571 [7]

– If representing a group of UEs, this parameter shall contain the External GroupId.

pattern: "^extgroupid-[^@]+@[^@]+$"

– If representing any UE, this parameter shall contain "anyUE".

pattern: "^anyUE$"

afInstanceId

string

The string identifying the originating AF. (NOTE)

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

n/a

PpDataEntry

M

1

Contains a Parameter Provisioning Data entry

PpDataEntry

M

1

201 Created

Indicates a successful creation of the resource.

n/a

204 No Content

Indicates a successful update of the resource. An empty response shall be returned.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– CREATION_NOT_ALLOWED

– AF_NOT_ALLOWED

– MTC_PROVIDER_NOT_ALLOWED

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

n/a

n/a

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– AF_NOT_ALLOWED

– MTC_PROVIDER_NOT_ALLOWED

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND

NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

PpDataEntry

M

1

200 OK

Upon success, the request body contain the target PPDataEntry.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– AF_NOT_ALLOWED

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND

PpData

6.5.6.2.2

Parameter Provision Data

CommunicationCharacteristics

6.5.6.2.3

Communication Characteristics

PpSubsRegTimer

6.5.6.2.4

PpActiveTime

6.5.6.2.5

5GVnGroupConfiguration

6.5.6.2.6

5GVnGroupData

6.5.6.2.7

ExpectedUeBehaviour

6.5.6.2.8

Expected UE Behaviour Parameters

LocationArea

6.5.6.2.10

Location Area

NetworkAreaInfo

6.5.6.2.11

Network Area Information

EcRestriction

6.5.6.2.12

PlmnEcInfo

6.5.6.2.13

PpDlPacketCountExt

6.5.6.2.14

PpMaximumResponseTime

6.5.6.2.15

PpMaximumLatency

6.5.6.2.16

LcsPrivacy

6.5.6.2.17

UmtTime

6.5.6.2.18

PpDataEntry

6.5.6.2.19

Provisioning Parameter Data Entry

CommunicationCharacteristicsAF

6.5.6.2.20

Communication Characteristics per AF

EcsAddrConfigInfo

6.5.6.2.21

ECS Address Configuration Information

5MbsAuthorizationInfo

6.5.6.2.22

5MBS Session Authorization Information

ReferenceId

6.5.6.3.2

PpDlPacketCount

6.5.6.3.2

DurationSec

3GPP TS 29.571 [7]

Time value in seconds

DurationSecRm

3GPP TS 29.571 [7]

Time value in seconds; nullable

SupportedFeatures

3GPP TS 29.571 [7]

NfInstanceId

3GPP TS 29.571 [7]

ProblemDetails

3GPP TS 29.571 [7]

Gpsi

3GPP TS 29.571 [7]

PatchResult

3GPP TS 29.571 [7]

DateTime

3GPP TS 29.571 [7]

Ecgi

3GPP TS 29.571 [7]

an EUTRA cell identifier

Ncgi

3GPP TS 29.571 [7]

an NR cell identifier

GlobalRanNodeId

3GPP TS 29.571 [7]

an identity of the NG-RAN node

Tai

3GPP TS 29.571 [7]

a tracking area identity

GeographicArea

3GPP TS 29.572 [34]

Identifies the geographical information of the user(s).

CivicAddress

3GPP TS 29.572 [34]

Identifies the civic address information of the user(s).

PduSessionType

3GPP TS 29.571 [7]

AppDescriptor

6.1.6.2.40

AcsInfoRm

3GPP TS 29.571 [7]

StnSrRm

3GPP TS 29.571 [7]

Session Transfer Number for SRVCC

Supi

3GPP TS 29.571 [7]

Lpi

6.1.6.2.43

MtcProviderInformation

3GPP TS 29.571 [7]

MTC Provider Information

StationaryIndicationRm

3GPP TS 29.571 [7]

ScheduledCommunicationTimeRm

3GPP TS 29.571 [7]

ScheduledCommunicationTypeRm

3GPP TS 29.571 [7]

TrafficProfileRm

3GPP TS 29.571 [7]

BatteryIndicationRm

3GPP TS 29.571 [7]

EcsServerAddr

3GPP TS 29.571 [7]

Fqdn

3GPP TS 29.571 [7]

Fully Qualified Domain Name

SpatialValidityCond

3GPP TS 29.571 [7]

MbsSessionId

3GPP TS 29.571 [7]

5MBS Session Identifier

supportedFeatures

SupportedFeatures

O

0..1

communicationCharacteristics

CommunicationCharacteristics

O

0..1

communication characteristics

expectedUeBehaviour

ExpectedUeBehaviour

O

0..1

Expected UE Behaviour Parameters

ecRestriction

EcRestriction

O

0..1

Enhanced Coverage Restriction Parameters

acsInfo

AcsInfoRm

O

0..1

Identifies the ACS Information (see TS 23.316 [37] clause 9.6.3); nullable.

stnSr

StnSrRm

O

0..1

Session Transfer Number for SRVCC

lcsPrivacy

LcsPrivacy

O

0..1

LCS Privacy Parameters (see clause 5.4.3 of 3GPP TS 23.273 [38])

sorInfo

SorInfo

O

0..1

Steering of Roaming information to be conveyed to a UE

See NOTE°1 and NOTE°2.

5mbsAuthorizationInfo

5MbsAuthorizationInfo

O

0..1

When present, this IE shall include the 5MBS Session Authorization Information as specified in 3GPP TS 23.247 [59]

NOTE°1: If the UDM is not able to immediately (after conducting integrity protection with the AUSF) convey the received Steering of Roaming information to the concerned UE for any reason (e.g. no AMF registered for the UE), it shall discard it.

NOTE°2: The behaviour of the UDM at reception of Steering of Roaming information within PpData is specified in Annex C.3 of 3GPP°TS°23.122°[20].

ppSubsRegTimer

PpSubsRegTimer

O

0..1

AF provisionedSubscribed periodic registration timer; nullable (NOTE 2)

ppActiveTime

PpActiveTime

O

0..1

AF provisioned active time; nullable (NOTE 2)

ppDlPacketCount

PpDlPacketCount

O

0..1

AF provisioned DL Buffering Suggested Packet Count; nullable

ppDlPacketCountExt

PpDlPacketCountExt

C

0..1

AF provisioned DL Buffering Suggested Packet Count Extension; nullable.

Shall be absent if ppDlPacketCount is absent, and shall be null if ppDlPacketCount is null.

ppMaximumResponseTime

PpMaximumResponseTime

O

0..1

AF provisioned Maximum Response Time; nullable

ppMaximumLatency

PpMaximumLatency

O

0..1

AF provisioned Maximum Latency; nullable

NOTE 1: If ppDlPacketCountExt is absent and ppDlPacketCount (whether the value is null or not) is present in a modification request, it shall result in deletion of ppDlPacketCountExt.

NOTE 2: These IEs are deprecated. An NF service consumer (i.e. AF) supporting this release shall use ppMaximumResponseTime IE to influence the Subscribed Active Time of the UE; use ppMaximumLatency IE to influence the Subscribed Periodic Registration Timer of the UE.

subsRegTimer

DurationSec

M

1

value in seconds

afInstanceId

string

M

1

The string identifying the originating AF (NOTE)

referenceId

ReferenceId

M

1

Transaction Reference ID

validityTime

DateTime

O

0..1

Identifies the point of time up to which the subsRegTimer parameter expires and it shall be deleted. If absent, it indicates that there is no expiration time for these expected UE parameters.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Parameter Provisioning authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

activeTime

DurationSec

M

1

value in seconds

afInstanceId

string

M

1

The string identifying the originating AF (NOTE).

referenceId

ReferenceId

M

1

Transaction Reference ID

validityTime

DateTime

O

0..1

Identifies the point of time up to which the activeTime parameter expires and it shall be deleted. If absent, it indicates that there is no expiration time for these expected UE parameters.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Parameter Provisioning authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

5gVnGroupData

5GVnGroupData

C

0..1

Data of the 5G VN Group; may be absent in modification requests; shall be present otherwise

members

array(Gpsi)

C

1..N

List of group members; may be absent in modification requests; shall be present in creation requests

referenceId

ReferenceId

C

1

Transaction Reference ID; shall be absent in modification requests; shall be present otherwise.

afInstanceId

string

C

1

The string identifying the originating AF (NOTE)

internalGroupIdentifier

GroupId

C

0..1

Shall be present in successful PUT requests and GET responses on Nudr; otherwise shall be absent.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for 5G VN Group Configuration authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

dnn

Dnn

M

1

DNN of the 5G VN group, shall contain the Network Identifier only.

sNssai

Snssai

M

1

S-NSSAI of the 5G VN group’s communication session

pduSessionTypes

array(PduSessionType)

O

1..N

List of PDU Session Types allowed for 5G VN group’s communication session

appDescriptors

array(AppDescriptor)

O

1..N

List of Application Descriptors allowed for 5G VN group’s communication session

secondaryAuth

boolean

O

0..1

Indicates whether secondary authentication and authorization is needed.

true: secondary authentication and authorization is needed.

false: secondary authentication and authorization is not needed.

If absent, it indicates that secondary authentication is not required by the NEF, but it still may be required by local policies at the SMF.

dnAaaIpAddressAllocation

boolean

O

0..1

Indicates whether the SMF is required to request the UE IP address from the DN-AAA server for PDU Session Establishment.

true: required

false: not required

If absent, it indicates that the request by SMF of the UE IP address from the DN-AAA server is not required, but it still may be required by local policies at the SMF.

dnAaaAddress

IpAddress

O

0..1

The IP address of the DN-AAA server, used for secondary authentication and authorization.

additionalDnAaaAddresses

array(IpAddress)

O

1..N

Additional IP addresses of the DN-AAA server used for secondary authentication and authorization.

dnAaaFqdn

Fqdn

O

0..1

The FQDN of the DN-AAA server used for secondary authentication and authorization.

afInstanceId

string

M

1

The string identifying the originating AF (NOTE 5)

referenceId

ReferenceId

M

1

Identifies transaction reference ID genetrated by NEF.

stationaryIndication

StationaryIndicationRm

O

0..1

Identifies whether the UE is stationary or mobile(see TS 23.502 [3] clause 4.15.6.3); nullable.

communicationDurationTime

DurationSecRm

O

0..1

Indicates for how long the UE will normally stay in CM-Connected for data transmission(see TS 23.502 [3] clause 4.15.6.3); nullable.

periodicTime

DurationSecRm

O

0..1

Identifies interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3); nullable.

scheduledCommunicationTime

ScheduledCommunicationTimeRm

O

0..1

Identifies time and day of the week when the UE is available for communication(see TS 23.502 [3] clause 4.15.6.3); nullable.

scheduledCommunicationType

ScheduledCommunicationTypeRm

O

0..1

Indicates that the Scheduled Communication Type (see TS 23.502 [3] clause 4.15.6.3); nullable.

(NOTE 4)

expectedUmts

array(LocationArea)

O

1..N

Identifies the UE’s expected geographical movement. The attribute is only applicable in 5G(see TS 23.502 [3] clause 4.15.6.3); nullable.

(NOTE 3)

trafficProfile

TrafficProfileRm

O

0..1

Identifies the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission; nullable

batteryIndication

BatteryIndicationRm

O

0..1

Indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3); nullable.

validityTime

DateTime

O

0..1

If present, identifies when the expected UE behaviour parameters expire and shall be deleted locally if it expire(see TS 23.502 [3] clause 4.15.6.3).

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

(NOTE 2)

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for UE Parameter Configuration authorization.

NOTE 1: At least one of optional parameters (expect for validityTime) above shall be present.

NOTE 2: If this attribute is omitted, no expiry for the expected UE behaviour parameters applies.

NOTE 3: The first instance of the attribute represents the start of the location, and the last one represents the stop of the location.

NOTE 4: The parameter "scheduledCommunicationType" shall be used together with the parameter "scheduledCommunicationTime".

NOTE 5: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

geographicAreas

array(GeographicArea)

O

0..N

Identifies a list of geographic area of the user where the UE is located.

civicAddresses

array(CivicAddress)

O

0..N

Identifies a list of civic addresses of the user where the UE is located.

nwAreaInfo

NetworkAreaInfo

O

0..1

This IE represents the network area information of the user where the UE is located.

umtTime

UmtTime

O

0..1

This IE identifies the time when the UE is expected to arrive at the location.
May be present when LocationArea is part of the UE’s expected geographical movement.

ecgis

array(Ecgi)

O

0..N

This IE contains a list of E‑UTRA cell identities.

ncgis

array(Ncgi)

O

0..N

This IE contains a list of NR cell identities.

gRanNodeIds

array(GlobalRanNodeId)

O

0..N

This IE contains a list of the NG‑RAN nodes.

The "n3IwfId" attribute within the "GlobalRanNodeId" data type shall not be supplied.

tais

array(Tai)

O

0..N

This IE contains a list of tracking area identities.

NOTE: The NetworkAreaInfo data type allows any combination of defined properties.

afInstanceId

string

M

1

The string identifying the originating AF (NOTE)

referenceId

ReferenceId

M

1

Transaction Reference ID

plmnEcInfos

array(PlmnEcInfo)

O

1..N

It may indicate a complete list of serving PLMNs where Enhanced Coverage shall be allowed and the detailed enhanced coverage restriction configuration under per the PLMN.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for UE Parameter Configuration authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in scsAsId attribute in ECRControl structured data type (see clause 5.12.2.1.2 of 3GPP TS 29.122 [45]) can be used as the value for this IE. If the scsAsId value is not received in T8, the afInstanceId attribute shall contain an empty string value ("").

plmnId

PlmnId

M

1

Indicates PLMN where Enhanced Coverage shall be restricted.

ecRestrictionDataWb

EcRestrictionDataWb

O

0..1

If present, it shall contain Enhanced Coverage Restriction Data for WB-N1 mode.

If absent, it shall indicate that Enhanced Coverage is not restricted for WB-N1 mode.

ecRestrictionDataNb

boolean

O

0..1

If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not.

true: Enhanced Coverage for NB-N1 mode is restricted.

false or absent: Enhanced Coverage for NB-N1 mode is allowed.

NOTE: At least one of the properties "ecRestrictionDataWb" and "ecRestrictionDataNb" shall be included.

afInstanceId

string

M

1

The string identifying the originating AF (NOTE)

referenceId

ReferenceId

M

1

Transaction Reference ID

dnn

Dnn

O

0..1

When present, it indicates the DNN for which the ppDlPacketCount is applicable.

singleNssai

Snssai

O

0..1

When present, it indicates the slice for which the ppDlPacketCount is applicable.

validityTime

DateTime

O

0..1

Identifies the point of time up to which the value of parameter ppDlPacketCount expires and it shall be deleted. If absent, it indicates that there is no expiration time for these expected UE parameters.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Parameter Provisioning authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

maximumResponseTime

DurationSec

M

1

This IE shall contain value of Maximum Response Time in seconds.

Maximum Response Time identifies the time for which the UE stays reachable to allow the AF to reliably deliver the required downlink data, see clause 4.15.6.3a of 3GPP TS 23.502 [3].

afInstanceId

string

M

1

The string identifying the originating AF (NOTE)

referenceId

ReferenceId

M

1

Transaction Reference ID

validityTime

DateTime

O

0..1

Identifies the point of time up to which the value of maximumResponseTime expires and it shall be deleted. If absent, it indicates that there is no expiration time.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Parameter Provisioning authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

maximumLatency

DurationSec

M

1

This IE shall contain value of Maximum Latency in seconds.

Maximum Latency identifies maximum delay acceptable for downlink data transfers, see clause 4.15.6.3a of 3GPP TS 23.502 [3].

afInstanceId

string

M

1

The string identifying the originating AF (NOTE).

referenceId

ReferenceId

M

1

Transaction Reference ID

validityTime

DateTime

O

0..1

Identifies the point of time up to which the value of maximumLatency expires and it shall be deleted. If absent, it indicates that there is no expiration time.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Parameter Provisioning authorization.

NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE.

afInstanceId

string

C

0..1

When present, indicates NF Instance Id of the originating AF/NF.

(NOTE)

referenceId

ReferenceId

C

0..1

This IE shall be present if LCS privacy parameters are provisioned by an AF.

When present, indicates Transaction Reference ID

(NOTE)

lpi

Lpi

O

0..1

If present, indicates the Location Privacy Indication

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for LCS privacy parameter configuration authorization.

NOTE: If LCS privacy parameters are provisioned by UE, parameters afInstanceId and referenceId shall be not included, and if LCS privacy parameters are provisioned by AF, parameters afInstanceId and referenceId shall be included. The string identifying the originating AF, which is carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]).

timeOfDay

TimeOfDay

M

1

see 3GPP TS 29.571 [7]

dayOfWeek

DayOfWeek

M

1

see 3GPP TS 29.571 [7]

communicationCharacteristics

CommunicationCharacteristicsAF

O

0..1

Communication characteristics for the AF

referenceId

ReferenceId

M

1

Transaction Reference ID

validityTime

DateTime

O

0..1

When present, this IE shall identify the point of time up to which the provisioned parameters will be expire and shall be deleted. If absent, it indicates that there is no expiration time for the provisioned parameters.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

mtcProviderInformation

MtcProviderInformation

O

0..1

When present, this IE shall indicate the MTC provider information for Parameter Provisioning authorization.

supportedFeatures

SupportedFeatures

O

0..1

Supported Features

ecsAddrConfigInfo

EcsAddrConfigInfo

O

0..1

ECS Address ConfigurationInformation Parameters; see 3GPP TS 23.502 [3]

additionalEcsAddrConfigInfos

array(EcsAddrConfigInfo)

O

1..N

Additional ECS Address Configuration Information Parameters. See 3GPP TS 23.548 [60]

ecRestriction

EcRestriction

O

0..1

Enhanced Coverage Restriction Parameters

ppDlPacketCount

PpDlPacketCount

O

0..1

AF provisioned DL Buffering Suggested Packet Count; nullable

maximumResponseTime

DurationSec

O

0..1

When present, this IE shall contain value of Maximum Response Time in seconds.

Maximum Response Time identifies the time for which the UE stays reachable to allow the AF to reliably deliver the required downlink data, see clause 4.15.6.3a of 3GPP TS 23.502 [3].

maximumLatency

DurationSec

O

0..1

When present, this IE shall contain value of Maximum Latency in seconds.

Maximum Latency identifies maximum delay acceptable for downlink data transfers, see clause 4.15.6.3a of 3GPP TS 23.502 [3].

ecsServerAddr

EcsServerAddr

O

0..1

This IE shall include address information of the Edge Configuration Server(s).

spatialValidityCond

SpatialValidityCond

O

0..1

When present, this IE shall include the Spatial Validity Condition as defined in clause 4.15.6.3d of 3GPP TS 23.502 [3]

NOTE: When the UDR receives ECS Address Configuration Information from the UDM for a group of UEs (or anyUE), it may need to modify the shared ECS Address Configuration Information shared by members of the group (or by any UE).

5mbsSessionIds

array(MbsSessionId)

M

1..N

5MBS Session Identifiers (TMGI or SSM)

ReferenceId

integer

The numeric value should not be higher than 2^64-1 (i.e. it should be possible to convey it in an unsigned 64 integer Information Element, used in other protocols), if interworking with the Event Exposure framework in EPC is required.

PpDlPacketCount

integer

nullable

MODIFICATION_NOT_ALLOWED

403 Forbidden

The subscriber does not have the necessary subscription for external parameter provisioning.

USER_NOT_FOUND

404 Not Found

The User does not exist.

CREATION_NOT_ALLOWED

403 Forbidden

Creation of a 5G VN Group is not allowed.

DETACHED_USER

403 Forbidden

The user is detached in the Network.

GROUP_IDENTIFIER_NOT_FOUND

404 Not Found

The group does not exist

AF_NOT_ALLOWED

403 Forbidden

This AF is not allowed to perform external provisioning or 5G VN Group creation.

MTC_PROVIDER_NOT_ALLOWED

403 Forbidden

MTC Provider not authorized to perform external provisioning or 5G VN Group creation.

1

PatchReport

If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4].