API docs by Redocly

Nnef_PFDmanagement Service API (1.3.0)

Download OpenAPI specification:

Packet Flow Description Management Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.551 v18.5.0, 5G System; Packet Flow Description Management Service

PFD of applications

Retrieve PFDs for all applications or for one or multiple applications with query parameter.

Authorizations:
NoneoAuth2ClientCredentials
query Parameters
application-ids
required
Array of strings (ApplicationId) non-empty

The required application identifier(s) for the returned PFDs.

supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

To filter irrelevant responses related to unsupported features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PFD of applications by partial update

retrieve the PFD(s) by partial update

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
Array (non-empty)
applicationId
required
string (ApplicationId)

String providing an application identifier.

pfdTimestamp
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Individual application PFD

Retrieve the PFD for an application.

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
appId
required
string

The required application identifier(s) for the returned PFDs.

query Parameters
supported-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

To filter irrelevant responses related to unsupported features

Responses

Response samples

Content type
application/json
{
  • "applicationId": "string",
  • "pfds": [
    ],
  • "cachingTime": "2019-08-24T14:15:22Z",
  • "cachingTimer": 0,
  • "pfdTimestamp": "2019-08-24T14:15:22Z",
  • "partialFlag": false,
  • "supportedFeatures": "string"
}

PFD subscriptions

Subscribe the notification of PFD changes.

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required

a PfdSubscription resource to be created.

applicationIds
Array of strings (ApplicationId) non-empty
immRep
boolean
notifyUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of objects (PfdContent) non-empty
supportedFeatures
required
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "applicationIds": [
    ],
  • "immRep": true,
  • "notifyUri": "string",
  • "pfds": [
    ],
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "applicationIds": [
    ],
  • "immRep": true,
  • "notifyUri": "string",
  • "pfds": [
    ],
  • "supportedFeatures": "string"
}

Callback payload samples

Callback
Content type
application/json
[
  • {
    }
]

Individual PFD subscription

Updates/replaces an existing subscription resource

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Identify the subscription.

Request Body schema: application/json
required

Parameters to update/replace the existing subscription

applicationIds
Array of strings (ApplicationId) non-empty
immRep
boolean
notifyUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of objects (PfdContent) non-empty
supportedFeatures
required
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Request samples

Content type
application/json
{
  • "applicationIds": [
    ],
  • "immRep": true,
  • "notifyUri": "string",
  • "pfds": [
    ],
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "applicationIds": [
    ],
  • "immRep": true,
  • "notifyUri": "string",
  • "pfds": [
    ],
  • "supportedFeatures": "string"
}

Delete a subscription of PFD change notification.

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Identify the subscription.

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}