Application AM contexts

/app-am-contexts

POST

Npcf_AMPolicyAuthorization_Create. Creates a new Individual application AM context resource and may create the child AM Policy Events Subscription sub-resource.

Individual application AM context

/app-am-contexts/
{appAmContextId}

PATCH

Npcf_AMPolicyAuthorization_Update. Updates an existing Individual application AM context resource. It can also create or update an AM Policy Events Subscription sub-resource.

GET

Reads an existing Individual application AM context resource.

DELETE

Npcf_AMPolicyAuthorization_Delete. Deletes an existing Individual application AM context resource and the child AM Policy Events Subscription sub-resource.

AM Policy Events Subscription

/app-am-contexts/
{appAmContextId}
/events-subscription

PUT

Npcf_AMPolicyAuthorization_Subscribe. Creates a new AM Policy Events Subscription sub-resource or modifies an existing AM Policy Events Subscription sub-resource.

DELETE

Npcf_AMPolicyAuthorization_Unsubscribe.

Deletes an AM Policy Events Subscription sub-resource.

apiRoot

string

See clause 5.1

n/a

AppAmContextData

M

1

Contains the information for the creation of a new Individual application AM context resource.

AppAmContextRespData

M

1

201 Created

Successful case.

The creation of an Individual application AM context resource is confirmed and a representation of that resource is returned, together with event subscription and event notification information, if available, as specified in clause 4.2.2.2.

ProblemDetails

O

0..1

500 Internal Server Error

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npcf-am-policyauthorization/<apiVersion>/
app-am-contexts/{appAmContextId}

apiRoot

string

See clause 5.1

appAmContextId

string

Identifies an application AM context formatted according to IETF RFC 3986 [19].

n/a

n/a

AppAmContextData

M

1

200 OK

Successful case.

A representation of an Individual application AM context resource is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual application AM context retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual application AM context resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

AppAmContextUpdateData

M

1

Contains the modification(s) to apply to the Individual application AM context resource.

AppAmContextRespData

M

1

200 OK

Successful case.

A representation of an Individual application AM context resource, together with event subscription and event notification information, if available, as specified in clause 4.2.3.2.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during an Individual application AM context modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during an Individual application AM context modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

Successful case.

The Individual application AM context resource is deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual application AM context termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual application AM context termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

apiRoot

string

See clause 5.1

appAmContextId

string

Identifies an application AM context formatted according to IETF RFC 3986 [19].

n/a

AmEventsSubscData

M

1

Contains the information for the creation and/or modification of the AM Policy Events Subscription sub-resource.

AmEventsSubscRespData

M

1

201 Created

Successful case.

The AM Policy Events Subscription sub-resource was created. The representation of the AM Policy Events Subscription sub-resource is included within the properties of the AmEventsSubscData data type. The one or more matched events, if available, are included within the properties of the AmEventsNotification data type.

AmEventsSubscRespData

M

1

200 OK

Successful case.

The AM Policy Events Subscription sub-resource was modified and a representation of the sub-resource is returned. The representation of the AM Policy Events Subscription sub-resource is included within the properties of the AmEventsSubscData data type. The one or more matched events, if available, are included within the properties of the AmEventsNotification data type.

n/a

204 No Content

Successful case.

The AM Policy Events Subscription sub-resource was modified.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during AM Policy Events Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during AM Policy Events Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npcf-am-policyauthorization/<apiVersion>/
app-am-contexts/{appAmContextId}/events-subscription

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

n/a

n/a

204 No Content

Successful case.

The AM Policy Events Subscription resource is deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during AM Policy Events Subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during AM Policy Events Subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

AM Event Notification

{eventNotifUri}

POST

Notification of access and mobility policy changes event(s).

Termination Request

{termNotifUri}

POST

Request for termination of an Individual application AM context.

eventNotifUri

String formatted as URI with the Callback Uri.

The Callback Uri is assigned within the AM Policy Events Subscription sub-resource and described within the AmEventsSubscData data type (see table 5.6.2.4-1) or AmEventsSubscDataRm data type (see table 5.6.2.7-1).

AmEventsNotification

M

1

Provides information about the observed access and mobility policy change events.

n/a

204 No content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during AM event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during AM event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

termNotifUri

String formatted as URI with the Callback Uri.

The Callback Uri is assigned within the Individual application AM Context resource and described within the AppAmContextData data type (see table 5.6.2.2-1) or AppAmContextUpdateData data type (see table 5.6.2.3-1).

AmTerminationInfo

M

1

Provides information about the cause of the termination request.

n/a

204 No content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during AM event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during AM event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

AmEvent

5.6.3.3

It represents the event the PCF can notify to the NF service consumer.

AmEventNotification

5.6.2.9

Represents the notification of an event.

AmEventData

5.6.2.8

It contains the event identifier and the related event reporting information.

AmEventsNotification

5.6.2.5

It describes the notification about the events occurred within an Individual application AM context resource.

AmEventsSubscData

5.6.2.4

It represents the AM Policy Events Subscription resource and identifies the events the application subscribes to.

AmEventsSubscDataRm

5.6.2.7

This data type is defined in the same way as the "AmEventsSubscData" data type, but with the OpenAPI "nullable: true" property.

AmEventsSubscRespData

5.6.4.2

It represents a response to an AM Policy Events Subscription request and contains the created/updated AM Policy Events Subscription resource. It may also include the Notification of the events met at the time of subscription.

It is represented as a non-exclusive list of two data types: AmEventsSubscData and AmEventsNotification.

AmTerminationCause

5.6.3.5

It represents the cause values that the PCF should report when requesting to an NF service consumer the deletion of an "AF application AM context" resource.

AmTerminationInfo

5.6.2.6

It includes information related to the termination of the Individual Application AM Context resource.

AppAmContextData

5.6.2.2

It represents an Individual application AM context resource.

AppAmContextRespData

5.6.4.1

It represents a response to a modification or creation request of an Individual application AM context resource.

It is represented as a non-exclusive list of two data types AppAmContextData and AmEventsNotification.

AppAmContextUpdateData

5.6.2.3

It describes the modifications to an Individual application AM context resource.

PduidInformation

5.6.2.10

It contains the PDUID and its validity timer.

ServiceAreaCoverageInfo

5.6.2.11

It represents a list of Tracking Areas within a serving network.

AsTimeDistributionParam

3GPP TS 29.507 [16]

Contains the 5G access stratum time distribution parameters.

DurationSec

3GPP TS 29.571 [20]

Indicates a period of time in units of seconds.

DurationSecRm

3GPP TS 29.571 [20]

It is defined as DurationSec but with the nullable property set to "true".

Gpsi

3GPP TS 29.571 [20]

Identifies a GPSI.

NotificationMethod

3GPP TS 29.508 [21]

It includes information about the notification methods that can be subscribed by the NF service consumer.

Pduid

3GPP TS 29.555 [24]

String containing a PDUID

RedirectResponse

3GPP TS 29.571 [20]

It contains redirection related information.

Supi

3GPP TS 29.571 [20]

Identifies the SUPI.

SupportedFeatures

3GPP TS 29.571 [20]

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

Tac

3GPP TS 29.571 [20]

It contains a Tracking Area Code

PlmnIdNid

3GPP TS 29.571 [20]

It contains the serving PLMN ID and, for a SNPN, the NID that together with the PLMN ID identifies the SNPN.

Uinteger

3GPP TS 29.571 [20]

Unsigned integer.

Uri

3GPP TS 29.571 [20]

String providing a URI.

evSubsc

AmEventsSubscData

O

0..1

Represents the subscription to one or more AM policy events. (NOTE)

supi

Supi

M

1

Identifies the SUPI.

gpsi

Gpsi

O

0..1

Identifies the GPSI.

suppFeat

SupportedFeatures

C

0..1

This IE represents a list of Supported features used as described in clause 5.8.

It shall be supplied by the NF service consumer in the POST request that requests a creation of an Individual application AM context resource.

It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual application AM context resource.

termNotifUri

Uri

M

1

Identifies the callback URI where the PCF notifies termination requests.

expiry

DurationSec

O

0..1

Indicates the time duration that the requested policy shall last. If omitted, it indicates that the requested policy lasts till the Individual Application AM context resource is deleted.

highThruInd

boolean

C

0..1

Indicates whether high throughput is desired for the indicated UE traffic. Set to "true" if high throughput is desired; otherwise set to "false". Default value is "false" if omitted.

(NOTE)

covReq

array(ServiceAreaCoverageInfo)

C

1..N

Identifies a list of Tracking Areas per serving network where the service is allowed.

(NOTE)

asTimeDisParam

AsTimeDistributionParam

C

0..1

Contains the 5G access stratum time distribution parameters.

(NOTE)

NOTE: When neither the "asTimeDisParam" attribute is included nor the "evSubsc" is provided to subscribe to events without an existing AF application AM context, the "highThruInd" attribute, the "covReq" attribute or both of them shall be included. When neither the "highThruInd" attribute nor the "covReq" attribute is included, then the "asTimeDisParam" attribute shall be included, unless the data type is used for subscribing to events without an existing AF application AM context as described in clause 4.2.5.3, in which case it is sufficient to provide the "evSubsc" attribute.

evSubsc

AmEventsSubscDataRm

O

0..1

Represents the subscription to one or more AM policy events.

termNotifUri

Uri

O

0..1

Identifies the callback URI where the PCF notifies termination requests.

expiry

DurationSecRm

O

0..1

The expiration time of the AM related policy. If removed (i.e. set to "NULL"), it indicates that the requested policy lasts till the Individual Application AM context resource is deleted.

highThruInd

boolean

O

0..1

Indicates whether high throughput is desired for the indicated UE traffic. Set to "true" if high throughput is desired; otherwise set to "false".

covReq

array(ServiceAreaCoverageInfo)

O

1..N

Identifies a list of Tracking Areas per serving network where the service is allowed.

asTimeDisParam

AsTimeDistributionParam

O

0..1

Contains the 5G access stratum time distribution parameters.

eventNotifUri

Uri

M

1

Indicates the callback URI where the PCF sends the access and mobility changes events met.

events

array(AmEventData)

O

1..N

Indicates the one or more access and mobility related events.

repEvents

array(AmEventNotification)

M

1..N

The list of the reported events.

appAmContextId

string

C

0..1

Contains the AM Policy Events Subscription resource identifier related to the event notification. It shall be included in the notification requests. It may be omitted in the resource creation/update replies. (NOTE)

NOTE: The complete resource URI defined in clause 5.3.4.2 is included.

appAmContextId

string

M

1

Contains the Individual application AM context resource identifier related to the termination notification. (NOTE)

termCause

AmTerminationCause

M

1

Indicates the cause for requesting the termination of the Individual application AM context resource.

NOTE: The complete resource URI defined in clause 5.3.3.2 is included.

eventNotifUri

Uri

O

0..1

Indicates the callback URI where the PCF sends the access and mobility changes events met.

events

array(AmEventData)

O

1..N

Indicates the one or more access and mobility related events.

event

AmEvent

M

1

Subscribed Event.

immRep

boolean

O

0..1

Indication of immediate reporting:

– true: requires the immediate reporting of the current value of the subscribed event, if available.

– false (default): event report occurs when the event is met.

notifMethod

NotificationMethod

O

0..1

Represents the notification method (periodic, one time, on event detection). If "notifMethod" attribute is not supplied, the default value "ON_EVENT_DETECTION" applies.

maxReportNbr

Uinteger

O

0..1

Represents the maximum number of reports, after which the subscription ceases to exist (i.e., the reporting ends). It may be present for the "PERIODIC" and on "ON_EVENT_DETECTION" notification methods. If omitted, there is no limit.

monDur

DateTime

C

0..1

Represents the time at which the subscription ceases to exist (i.e the subscription becomes invalid and the reporting ends). If omitted, there is no time limit. If present in the subscription request, it shall be present in the subscription response.

repPeriod

DurationSec

O

0..1

Indicates the time interval between successive event notifications.It is supplied for notification method "PERIODIC".

event

AmEvent

M

1

Notified event.

appliedCov

ServiceAreaCoverageInfo

C

0..1

The list of applied Tracking Areas for the serving network where the UE is camping. It shall be present when the notified event is "SAC_CH".

pduidInfo

PduidInformation

C

0..1

Contains the PDUID and its validity timer. It shall be included when the "PDUID_CH" event is reported.

expiry

DateTime

M

1

Contains the expiration time of validity of UE policies for 5G Prose direct discovery.

pduid

Pduid

M

1

Contains the PDUID as defined in Table 5.3.1.1 of 3GPP TS 24.555 [23].

tacList

array(Tac)

M

0..N

It contains a list of the Tracking Area codes where the requested service shall be allowed.

An empty array may be included within the AmEventNotification data type and indicates the service is restricted in the serving network.

servingNetwork

PlmnIdNid

O

0..1

It contains the serving PLMN ID and, for a SNPN, the NID that together with the PLMN ID identifies the SNPN. It may be omitted when serving network is the UE H-PLMN.

SAC_CH

This trigger indicates a service area coverage change for a UE.

PDUID_CH

The PDUID assigned to a UE for the UE ProSe Policies has changed.

(NOTE)

NOTE: This event can only be subscribed using the Npcf_AMPolicyAuthorization_Subscribe service operation.

UE_DEREGISTERED

UE initiates the deregistration procedure.

UNSPECIFIED

This value is used for unspecified reasons.

INSUFFICIENT_RESOURCES

Indicates that the server is overloaded and needs to release the AF application AM context resource.

AmEventsNotification

0..1

It represents the notification of a match event during the creation or modification of the Individual application AM context data.

AppAmContextData

1

It represents the Individual application AM context resource.

AmEventsSubscData

1

It represents the AM Policy Events subscription resource.

AmEventsNotification

0..1

It represents the notification of a match event during the creation or modification of the AM Policy Events Subscription resource.

INVALID_POLICY_REQUEST

400 Bad Request

The HTTP request is rejected because the service information for the AM context is invalid or insufficient for the PCF to perform the requested action. (NOTE 1)

APPLICATION_AM_CONTEXT_NOT_FOUND

404 Not Found

The HTTP request is rejected because the specified Individual Application AM Context does not exist. (NOTE 3)

POLICY_ASSOCIATION_NOT_AVAILABLE

500 Internal Server Error

The PCF failed in executing binding with the UE/AM Policy Context. (NOTE 2)

NOTE 1: This application error is included in the response to the PATCH request (see clauses 4.2.3.2).

NOTE 2: This application error is included in the response to the POST request (see clauses 4.2.2.2 and 4.2.5.3).

NOTE 3: This application error is included in the responses to the GET, PATCH and DELETE requests to the Individual Application AM Context resource, and to the PUT and DELETE requests to the AM Policy Events Subscription resource.