PFD of applications

/applications

GET

Nnef_PFDmanagement_Fetch.

Retrieve PFDs for one or multiple applications using query parameters.

/applications/partialpull

partialpull

(POST)

Request PFDs for one or multiple application identifier(s) by the partial update.

Individual application PFD

/applications/{appId}

GET

Nnef_PFDmanagement_Fetch.

Retrieve the PFD for an application.

PFD subscriptions

/subscriptions

POST

Nnef_PFDmanagement_Subscribe.

Subscribe the notification of PFD changes.

Individual PFD subscription

/subscriptions/{subscriptionId}

PUT

Nnef_PFDmanagement_Subscribe.

Update a subscription to PFD change notifications.

Individual PFD subscription

/subscriptions/{subscriptionId}

DELETE

Nnef_PFDmanagement_Unsubscribe.

Delete a subscription to PFD change notifications.

apiRoot

string

See clause 5.1

application-ids

array(ApplicationId)

M

1..N

The requested application identifier(s) for which PFD(s) shall be returned.

supported-features

SupportedFeatures

O

0..1

To filter irrelevant responses related to unsupported features.

n/a

array(PfdDataForApp)

M

0..N

200 OK

The PFDs for one or more application identifier(s) provided in the request URI are returned.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the GET method shall also apply.

Partialpull

/applications/partialpull

partialpull (POST)

Request PFDs for one or multiple application identifier(s) by the partial update.

array(ApplicationForPfdRequest)

M

1

Contains the application Identifier(s) for PFDs request.

array(PfdDataForApp)

M

0..N

200 OK

The PFDs for one or more application identifier(s) are returned.

n/a

204 No Content

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] shall also apply.

apiRoot

string

See clause 5.1.

appId

string

Identifies a set of PFD for an application identifier.

supported-features

SupportedFeatures

O

0..1

To filter irrelevant responses related to unsupported features.

n/a

PfdDataForApp

M

1

200 OK

A representation of PFDs for an application in the request URI is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

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

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

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

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the GET method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative PFDF (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 PFDF (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

n/a

PfdSubscription

M

1

Create a PfdSubscription resource.

PfdSubscription

M

1

201 Created

The creation of a PfdSubscription resource is confirmed and a representation of that resource is returned.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnef-pfdmanagement/v1/subscriptions/{subscriptionId}

apiRoot

string

See clause 5.1

subscriptionId

string

Identifies an individual subscription to the PFD management service

n/a

n/a

n/a

204 No Content

The PfdSubscription resource matching the subscriptionId was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual PFD subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PFDF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual PFD subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PFDF (service) instance.

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the DELETE method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative PFDF (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 PFDF (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

PfdSubscription

M

1

Update a PfdSubscription resource.

PfdSubscription

M

1

200 OK

The update of a PfdSubscription resource is confirmed and a representation of that resource is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

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

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

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

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the PUT method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative PFDF (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 PFDF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

PFD Change Notification

{notifyUri}

POST

Notification of PFD change.

Notification Push

{notifyUri}/notifypush

notifypush (POST)

Notifies NF service consumer to retrieve the PFDs for application identifier(s).

notifyUri

Uri

The Notification Uri as assigned within the PFD subscriptions resource and described within the PfdSubscription data type (see table 5.6.2.3-1).

n/a

array(PfdChangeNotification)

M

1..N

Provides PFD change information.

n/a

204 No Content

The PFD operation in the notification is performed successfully, i.e. all PFD changes are accepted by the NF service consumer.

array(PfdChangeReport)

M

1..N

200 OK

The PFD operation in the notification is performed and the PfdChangeReport indicates failure reason for each failed application in the partial success.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during PFD Change 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.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during PFD Change 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.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

500 Internal Server Error

The server encountered an unexpected condition that prevented it from fulfilling the request. PFDs for all applications are not accepted by the NF service consumer. (NOTE 2)

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply.

NOTE 2: Failure cases are described in clause 5.7.

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

notifyUri

Uri

The Notification Uri as assigned within the PFD subscriptions resource and described within the PfdSubscription data type (see table 5.6.2.3-1).

n/a

array(NotificationPush)

M

1..N

Provides the information for the NF service consumer to retrieve and/or remove the PFDs.

n/a

204 No Content

Notification PUSH is accepted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during PFD Change 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.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during PFD Change 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.

Applicable if the feature "ES3XX" is supported.

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply.

NOTE 2: Failure cases are described in clause 5.7.

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

ApplicationForPfdRequest

5.6.2.8

Contains the application identifier(s) for the PFDs request.

PartialPull

NotificationPush

5.6.2.7

Provides the information for the NF service consumer to retrieve the PFDs and/or remove the PFDs of the applicable application identifier(s).

NotificationPush

PfdChangeNotification

5.6.2.4

Represents PFD change information.

PfdChangeReport

5.6.2.6

Represents error of PFD change.

PfdContent

5.6.2.5

Represents the content of a PFD for an application identifier.

PfdDataForApp

5.6.2.2

Represents the PFDs for an application identifier.

PfdOperation

5.6.3.3

Indicates the operation of the PFDs.

NotificationPush

PfdSubscription

5.6.2.3

Represents a PFD subscription.

ApplicationId

3GPP TS 29.571 [10]

DateTime

3GPP TS 29.571 [10]

DomainNameProtocol

3GPP TS 29.122 [11]

Indicates the additional protocol and protocol field for domain names to be matched.

DomainNameProtocol

DurationSec

3GPP TS 29.571 [10]

Identifies a period of time in units of seconds.

NotificationPush

RedirectResponse

3GPP TS 29.571 [10]

Contains redirection related information.

ES3XX

SupportedFeatures

3GPP TS 29.571 [10]

Uri

3GPP TS 29.571 [10]

applicationId

ApplicationId

M

1

Identifier of an application.

pfds

array(PfdContent)

C

1..N

PFDs for the application identifier.

cachingTime

DateTime

O

0..1

Caching time for an application identifier.

cachingTimer

DurationSec

O

0..1

Caching timer for an application identifer expressed as duration with unit of second.

CachingTimer

pfdTimestamp

DateTime

O

0..1

The value represents the UTC time set for the PFD(s) of the application identifier provisioning by the PFDF.

PartialPull

partialFlag

boolean

O

0..1

Indication of partial update of PFDs for an existing application identifier if it is included and set to true. The default value "false" applies, if the attribute is not present.

PartialPull

supportedFeatures

SupportedFeatures

C

0..1

Used to negotiate the applicability of the optional features.

This attribute shall be present in in the HTTP GET response if the "supported-features" attribute query parameter is included in the HTTP GET request.

NOTE: The "pfds" attribute shall be included if the "PartialPull" feature is not supported.

applicationIds

array(ApplicationId)

O

1..N

Identifiers of applications with PFDs change.

notifyUri

Uri

M

1

Identifies the recipient of notifications sent by PFDF for this subscription.

supportedFeatures

SupportedFeatures

M

1

List of supported features used as described in clause 5.8.

applicationId

ApplicationId

M

1

Identifier of an application.

removalFlag

boolean

O

0..1

Indication of removal of PFDs for an existing application identifier.

partialFlag

boolean

O

0..1

Indication of partial update of PFDs for an existing application identifier if this operation is supported according to feature negotiation.

PartialUpdate

pfds

array(PfdContent)

O

1..N

PFD creation/update for the application identifier as specified in clause 6.3.3.5 of 3GPP TS 29.251 [12].

pfdId

string

C

0..1

Identifies a PDF of an application identifier. If PartialUpdate or PartialPull feature is supported, this attribute shall be provided by the PFDF.

flowDescriptions

array(string)

O

1..N

Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [18]. (NOTE)

urls

array(string)

O

1..N

Indicates a URL or a regular expression which is used to match the significant parts of the URL. (NOTE)

domainNames

array(string)

O

1..N

Indicates an FQDN or a regular expression as a domain name matching criteria. (NOTE)

dnProtocol

DomainNameProtocol

C

0..1

Indicates the additional protocol and protocol field for domain names to be matched, it may only be provided when domainNames attribute is present.

DomainNameProtocol

NOTE: If a PFD contains multiple filter types, the PFD is only matched when every filter type contained in the PFD has a matching value.

pfdError

ProblemDetails

M

1

More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure.

The "cause" attribute in the ProblemDetails shall be set to one of following application errors (see table 5.2.7.1-1 of 3GPP TS 29.500 [5]):

– SYSTEM_FAILURE

– INSUFFICIENT_RESOURCES

– UNSPECIFIED_NF_FAILURE

applicationId

array(ApplicationId)

M

1..N

Indicates the application identifier(s) which PFD(s) are failed to be added or modified.

appIds

array(ApplicationId)

M

1..N

Identifiers of one or more applications.

allowedDelay

DurationSec

O

0..1

Indicates the time limit that the NF service consumer shall retrieve the PFD(s).

pfdOp

PfdOperation

O

0..1

Indication the operation of the PFDs.

applicationId

ApplicationId

M

1

Identifier of an application.

pfdTimestamp

DateTime

O

1

The value represents the UTC time set for the PFD(s) of the application identifier provisioning by the PFDF.

RETRIEVE

Indicates to retrieve the PFD(s) for the application identifier(s). The NF service consumer determines which pull procedure can be applied to retrieve the PFD(s).

FULLPULL

Indicates to retrieve the PFD(s) for the application identifier(s) by the full pull procedure.

PARTIALPULL

Indicates to retrieve the PFD(s) for the application identifier(s) by the partial pull procedure. The NF consumer may decide to use full pull procedure instead if needed.

REMOVE

Indicates to remove the PFD(s) for the application identifier(s).

SYSTEM_FAILURE

500 Internal Server Error

Something functions wrongly in PFD provisioning or the PFD provisioning does not function at all. (NOTE)

INSUFFICIENT_RESOURCE

500 Internal Server Error

There is limitation for resource storage. (NOTE)

UNSPECIFIED_NF_FAILURE

500 Internal Server Error

Unspecified reason. (NOTE)

NOTE: This application error is included in the responses to the POST request of PFD change notification.

1

PartialUpdate

The PFDF can use this feature for partial update of PFDs.

2

DomainNameProtocol

This feature supports the additional protocol matching condition for the domain name in PFD data.

3

PfdChgSubsUpdate

The NF service consumer can use this feature for updating the PFD change subscription.

4

ES3XX

Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5].

5

PartialPull

The NF service consumer can use this feature to retrieve the PFDs by the partial update.

6

NotificationPush

The PFDF can use this feature to notify the NF service consumer to retrieve the PFDs.

7

CachingTimer

The PFDF and the NF service consumer can use this feature to support caching timer with unit of duration second.