API docs by Redocly

Unified Data Repository Service API file for Application Data (-)

Download OpenAPI specification:

The API version is defined in 3GPP TS 29.504
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.519 V18.8.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure.

PFD Data (Store)

Retrieve PFDs for application identifier(s)

Authorizations:
NoneNoneNoneNone
query Parameters
appId
Array of strings (ApplicationId) non-empty

Contains the information of the application identifier(s) for the querying PFD Data resource. If none appId is included in the URI, it applies to all application identifier(s) for the querying PFD Data resource.

supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual PFD Data (Document)

Retrieve the corresponding PFDs of the specified application identifier

Authorizations:
NoneNoneNoneNone
path Parameters
appId
required
string

Indicate the application identifier for the request pfd(s). It shall apply the format of Data type ApplicationId.

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

Supported Features

Responses

Response samples

Content type
application/json
{
  • "applicationId": "string",
  • "pfds": [
    ],
  • "cachingTime": "2019-08-24T14:15:22Z",
  • "cachingTimer": 0,
  • "suppFeat": "string",
  • "resetIds": [
    ],
  • "allowedDelay": 0
}

Delete the corresponding PFDs of the specified application identifier

Authorizations:
NoneNoneNoneNone
path Parameters
appId
required
string

Indicate the application identifier for the request pfd(s). It shall apply the format of Data type ApplicationId.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Create or update the corresponding PFDs for the specified application identifier

Authorizations:
NoneNoneNoneNone
path Parameters
appId
required
string

Indicate the application identifier for the request pfd(s). It shall apply the format of Data type ApplicationId.

Request Body schema: application/json
required
applicationId
required
string (ApplicationId)

String providing an application identifier.

required
Array of objects (PfdContent) non-empty
cachingTime
string <date-time> (DateTime)

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

cachingTimer
integer (DurationSec)

indicating a time in seconds.

suppFeat
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.

resetIds
Array of strings non-empty
allowedDelay
integer (DurationSec)

indicating a time in seconds.

Responses

Request samples

Content type
application/json
{
  • "applicationId": "string",
  • "pfds": [
    ],
  • "cachingTime": "2019-08-24T14:15:22Z",
  • "cachingTimer": 0,
  • "suppFeat": "string",
  • "resetIds": [
    ],
  • "allowedDelay": 0
}

Response samples

Content type
application/json
{
  • "applicationId": "string",
  • "pfds": [
    ],
  • "cachingTime": "2019-08-24T14:15:22Z",
  • "cachingTimer": 0,
  • "suppFeat": "string",
  • "resetIds": [
    ],
  • "allowedDelay": 0
}

Influence Data (Store)

Retrieve Traffic Influence Data

Authorizations:
NoneNoneNoneNone
query Parameters
influence-Ids
Array of strings non-empty

Each element identifies a service.

dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a slice.

internal-Group-Ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

internal-group-ids-Add
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies an internal Group.

subscriber-categories
Array of strings non-empty

Each element identifies a subscriber category.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual Influence Data (Document)

Create or update an individual Influence Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
influenceId
required
string

The Identifier of an Individual Influence Data to be created or updated. It shall apply the format of Data type string.

Request Body schema: application/json
required
One of
One of
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Modify part of the properties of an individual Influence Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
influenceId
required
string

The Identifier of an Individual Influence Data to be updated. It shall apply the format of Data type string.

Request Body schema: application/merge-patch+json
required
upPathChgNotifCorreId
string

Contains the Notification Correlation Id allocated by the NEF for the UP path change notification.

appReloInd
boolean

Identifies whether an application can be relocated once a location of the application has been selected.

Array of objects (EthFlowDescription) non-empty

Identifies Ethernet packet filters. Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.

Array of objects (FlowInfo) non-empty

Identifies IP packet filters. Either "trafficFilters" or "ethTrafficFilters" shall be included if applicable.

Array of (object or null) or (object or null) (RouteToLocation) non-empty

Identifies the N6 traffic routing requirement.

sfcIdDl
string or null

Reference to a pre-configured service function chain for DL traffic

sfcIdUl
string or null

Reference to a pre-configured service function chain for UL traffic

metadata
string or null <byte> (Metadata)

A String which is transparently passed to the UPF to be applied for traffic to SFC.

traffCorreInd
boolean
object or null (TrafficCorrelationInfo)

Contains the information for traffic correlation.

validStartTime
string <date-time> (DateTime)

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

validEndTime
string <date-time> (DateTime)

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

Array of objects or null (TemporalValidity) non-empty

Identifies the temporal validities for the N6 traffic routing requirement.

object (NetworkAreaInfo)

Describes a network area information in which the NF service consumer requests the number of UEs.

upPathChgNotifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

headers
Array of strings non-empty

Contains the headers provisioned by the NEF.

afAckInd
boolean
addrPreserInd
boolean
maxAllowedUpLat
integer or null (UintegerRm) >= 0

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible with the OpenAPI 'nullable: true' property.

simConnInd
boolean

Indicates whether simultaneous connectivity should be temporarily maintained for the source and target PSA.

simConnTerm
integer or null (DurationSecRm)

indicating a time in seconds with OpenAPI defined 'nullable: true' property.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "upPathChgNotifCorreId": "string",
  • "appReloInd": true,
  • "ethTrafficFilters": [
    ],
  • "trafficFilters": [
    ],
  • "trafficRoutes": [
    ],
  • "sfcIdDl": "string",
  • "sfcIdUl": "string",
  • "metadata": "string",
  • "traffCorreInd": true,
  • "tfcCorreInfo": {
    },
  • "validStartTime": "2019-08-24T14:15:22Z",
  • "validEndTime": "2019-08-24T14:15:22Z",
  • "tempValidities": [
    ],
  • "nwAreaInfo": {
    },
  • "upPathChgNotifUri": "string",
  • "headers": [
    ],
  • "afAckInd": true,
  • "addrPreserInd": true,
  • "maxAllowedUpLat": 0,
  • "simConnInd": true,
  • "simConnTerm": 0
}

Response samples

Content type
application/json
{ }

Delete an individual Influence Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
influenceId
required
string

The Identifier of an Individual Influence Data to be deleted. It shall apply the format of Data type string.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Influence Data Subscriptions (Collection)

Create a new Individual Influence Data Subscription resource

Authorizations:
NoneNoneNoneNone
Request Body schema: application/json
required
dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a slice.

internalGroupIds
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

internalGroupIdsAdd
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies an internal group.

subscriberCatList
Array of strings non-empty

Each element identifies a subscriber category.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

ipv4Addr
string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2...

String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.

ipv6Addr
string (Ipv6Addr) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used.

notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

expiry
string <date-time> (DateTime)

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

supportedFeatures
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.

resetIds
Array of strings non-empty
immRep
boolean

If provided and set to true, it indicates that existing entries that match this subscription shall be immediately reported in the response.

Array of objects (TrafficInfluDataNotif) non-empty

Immediate report with existing UDR entries.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "dnns": [
    ],
  • "snssais": [
    ],
  • "internalGroupIds": [
    ],
  • "internalGroupIdsAdd": [
    ],
  • "subscriberCatList": [
    ],
  • "supis": [
    ],
  • "plmnId": {
    },
  • "ipv4Addr": "198.51.100.1",
  • "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "notificationUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immRep": true,
  • "immReports": [
    ]
}

Response samples

Content type
application/json
{
  • "dnns": [
    ],
  • "snssais": [
    ],
  • "internalGroupIds": [
    ],
  • "internalGroupIdsAdd": [
    ],
  • "subscriberCatList": [
    ],
  • "supis": [
    ],
  • "plmnId": {
    },
  • "ipv4Addr": "198.51.100.1",
  • "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "notificationUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immRep": true,
  • "immReports": [
    ]
}

Callback payload samples

Callback
POST: {$request.body#/notificationUri}
Content type
application/json
[
  • {
    }
]

Read Influence Data Subscriptions

Authorizations:
NoneNoneNoneNone
query Parameters
dnn
string (Dnn)

Identifies a DNN.

object (Snssai)

Identifies a slice.

internal-Group-Id
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

Identifies a group of users.

supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

Identifies a user.

internal-group-ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies an internal group.

subscriber-categories
Array of strings non-empty

Each element identifies a subscriber category.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual Influence Data Subscription (Document)

Get an existing individual Influence Data Subscription resource

Authorizations:
NoneNoneNoneNone
path Parameters
subscriptionId
required
string

String identifying a subscription to the Individual Influence Data Subscription

Responses

Response samples

Content type
application/json
{
  • "dnns": [
    ],
  • "snssais": [
    ],
  • "internalGroupIds": [
    ],
  • "internalGroupIdsAdd": [
    ],
  • "subscriberCatList": [
    ],
  • "supis": [
    ],
  • "plmnId": {
    },
  • "ipv4Addr": "198.51.100.1",
  • "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "notificationUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immRep": true,
  • "immReports": [
    ]
}

Modify an existing individual Influence Data Subscription resource

Authorizations:
NoneNoneNoneNone
path Parameters
subscriptionId
required
string

String identifying a subscription to the Individual Influence Data Subscription.

Request Body schema: application/json
required
dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a slice.

internalGroupIds
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

internalGroupIdsAdd
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies an internal group.

subscriberCatList
Array of strings non-empty

Each element identifies a subscriber category.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

ipv4Addr
string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2...

String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.

ipv6Addr
string (Ipv6Addr) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used.

notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

expiry
string <date-time> (DateTime)

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

supportedFeatures
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.

resetIds
Array of strings non-empty
immRep
boolean

If provided and set to true, it indicates that existing entries that match this subscription shall be immediately reported in the response.

Array of objects (TrafficInfluDataNotif) non-empty

Immediate report with existing UDR entries.

Responses

Request samples

Content type
application/json
{
  • "dnns": [
    ],
  • "snssais": [
    ],
  • "internalGroupIds": [
    ],
  • "internalGroupIdsAdd": [
    ],
  • "subscriberCatList": [
    ],
  • "supis": [
    ],
  • "plmnId": {
    },
  • "ipv4Addr": "198.51.100.1",
  • "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "notificationUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immRep": true,
  • "immReports": [
    ]
}

Response samples

Content type
application/json
{
  • "dnns": [
    ],
  • "snssais": [
    ],
  • "internalGroupIds": [
    ],
  • "internalGroupIdsAdd": [
    ],
  • "subscriberCatList": [
    ],
  • "supis": [
    ],
  • "plmnId": {
    },
  • "ipv4Addr": "198.51.100.1",
  • "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
  • "notificationUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immRep": true,
  • "immReports": [
    ]
}

Delete an individual Influence Data Subscription resource

Authorizations:
NoneNoneNoneNone
path Parameters
subscriptionId
required
string

String identifying a subscription to the Individual Influence Data Subscription.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

BdtPolicy Data (Store)

Retrieve applied BDT Policy Data

Authorizations:
NoneNoneNoneNone
query Parameters
bdt-policy-ids
Array of strings non-empty

Each element identifies a service.

internal-group-ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual Applied BDT Policy Data (Document)

Create an individual applied BDT Policy Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
bdtPolicyId
required
string

The Identifier of an Individual Applied BDT Policy Data to be created or updated. It shall apply the format of Data type string.

Request Body schema: application/json
required
interGroupId
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
bdtRefId
required
string (BdtReferenceId)

string identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS 29.154.

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

resUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "interGroupId": "string",
  • "supi": "string",
  • "bdtRefId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "resUri": "string",
  • "resetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "interGroupId": "string",
  • "supi": "string",
  • "bdtRefId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "resUri": "string",
  • "resetIds": [
    ]
}

Modify part of the properties of an individual Applied BDT Policy Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
bdtPolicyId
required
string

The Identifier of an Individual Applied BDT Policy Data to be updated. It shall apply the format of Data type string.

Request Body schema: application/merge-patch+json
required
bdtRefId
required
string (BdtReferenceId)

string identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS 29.154.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "bdtRefId": "string"
}

Response samples

Content type
application/json
{
  • "interGroupId": "string",
  • "supi": "string",
  • "bdtRefId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "resUri": "string",
  • "resetIds": [
    ]
}

Delete an individual Applied BDT Policy Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
bdtPolicyId
required
string

The Identifier of an Individual Applied BDT Policy Data to be deleted. It shall apply the format of Data type string.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

IPTV Configuration Data (Store)

Retrieve IPTV configuration Data

Authorizations:
NoneNoneNoneNone
query Parameters
config-ids
Array of strings non-empty

Each element identifies a configuration.

dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a slice.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

inter-group-ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual IPTV Configuration Data (Document)

Create or update an individual IPTV configuration resource

Authorizations:
NoneNoneNoneNone
path Parameters
configurationId
required
string

The Identifier of an Individual IPTV Configuration Data to be created or updated. It shall apply the format of Data type string.

Request Body schema: application/json
required
One of
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
interGroupId
required
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

afAppId
required
string
required
object non-empty

Identifies a list of multicast address access control information. Any string value can be used as a key of the map.

suppFeat
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.

resUri
string (Uri)

String providing an URI formatted according to RFC 3986.

resetIds
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "supi": "string",
  • "interGroupId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "afAppId": "string",
  • "multiAccCtrls": {
    },
  • "suppFeat": "string",
  • "resUri": "string",
  • "resetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "supi": "string",
  • "interGroupId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "afAppId": "string",
  • "multiAccCtrls": {
    },
  • "suppFeat": "string",
  • "resUri": "string",
  • "resetIds": [
    ]
}

Partial update an individual IPTV configuration resource

Authorizations:
NoneNoneNoneNone
path Parameters
configurationId
required
string

The Identifier of an Individual IPTV Configuration Data to be updated. It shall apply the format of Data type string.

Request Body schema: application/merge-patch+json
required
object non-empty

Identifies a list of multicast address access control information. Any string value can be used as a key of the map.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "multiAccCtrls": {
    }
}

Response samples

Content type
application/json
{
  • "supi": "string",
  • "interGroupId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "afAppId": "string",
  • "multiAccCtrls": {
    },
  • "suppFeat": "string",
  • "resUri": "string",
  • "resetIds": [
    ]
}

Delete an individual IPTV configuration resource

Authorizations:
NoneNoneNoneNone
path Parameters
configurationId
required
string

The Identifier of an Individual IPTV Configuration to be deleted. It shall apply the format of Data type string.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Service Parameter Data (Store)

Retrieve Service Parameter Data

Authorizations:
NoneNoneNoneNone
query Parameters
service-param-ids
Array of strings non-empty

Each element identifies a service.

dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a slice.

internal-group-ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

ue-ipv4s
Array of strings (Ipv4Addr) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]
Example: ue-ipv4s=198.51.100.1

Each element identifies the user.

ue-ipv6s
Array of strings (Ipv6Addr) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]
Example: ue-ipv6s=2001:db8:85a3::8a2e:370:7334

Each element identifies the user.

ue-macs
Array of strings (MacAddr48) non-empty [ items^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$ ]

Each element identifies the user.

any-ue
boolean

Indicates whether the request is for any UE.

Array of objects or objects or objects (NetworkDescription) non-empty

Each element identifies oner or more PLMNs for a roaming UE.

supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual Service Parameter Data (Document)

Create or update an individual Service Parameter Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
serviceParamId
required
string

The Identifier of an Individual Service Parameter Data to be created or updated. It shall apply the format of Data type string.

Request Body schema: application/json
required
appId
string

Identifies an application.

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

interGroupId
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
ueIpv4
string (schemas-Ipv4Addr)

string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166.

ueIpv6
string (schemas-Ipv6Addr)

string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.

ueMac
string (MacAddr48) ^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$

String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042.

anyUeInd
boolean

Identifies whether the service parameters applies to any non roaming UE.

Array of objects or objects or objects (NetworkDescription) non-empty

Each element identifies one or more PLMN IDs of inbound roamers.

paramOverPc5
string (ParameterOverPc5)

Represents configuration parameters for V2X communications over PC5 reference point.

paramOverUu
string (ParameterOverUu)

Represents configuration parameters for V2X communications over Uu reference point.

a2xParamsPc5
string (A2xParamsPc5)

Represents configuration parameters for A2X communications over PC5 reference point.

a2xParamsUu
string (A2xParamsUu)

Represents configuration parameters for A2X communications over Uu reference point.

paramForProSeDd
string (ParamForProSeDd)

Represents the service parameters for 5G ProSe direct discovery.

paramForProSeDc
string (ParamForProSeDc)

Represents the service parameters for 5G ProSe direct communications.

paramForProSeU2NRelUe
string (ParamForProSeU2NRelUe)

Represents the service parameters for 5G ProSe UE-to-network relay UE.

paramForProSeRemUe
string (ParamForProSeRemUe)

Represents the service parameters for 5G ProSe Remote UE.

paramForProSeU2URelUe
string (ParamForProSeU2URelUe)

Represents the service parameters for 5G ProSe UE-to-UE relay UE.

paramForProSeEndUe
string (ParamForProSeEndUe)

Represents the service parameters for 5G ProSe End UE.

Array of objects (UrspRuleRequest) non-empty

Contains the service parameters used to guide the URSP rule(s).

Array of objects (UrspRuleRequest) non-empty

Contains the service parameters used to guide the VPLMN-specific URSP rule(s).

Array of objects (TnapId) non-empty

Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user.

Array of strings or strings (Event) non-empty

Contains the outcome of the UE Policy Delivery.

policDelivNotifCorreId
string

Contains the Notification Correlation Id allocated by the NEF for the notification of UE Policy delivery outcome.

policDelivNotifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

suppFeat
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.

resUri
string (Uri)

String providing an URI formatted according to RFC 3986.

headers
Array of strings non-empty

Contains the headers provisioned by the NEF.

resetIds
Array of strings non-empty
paramForRangingSlPos
string (ParamForRangingSlPos)

Represents the service parameters for ranging and sidelink positioning.

Responses

Request samples

Content type
application/json
{
  • "appId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "interGroupId": "string",
  • "supi": "string",
  • "ueIpv4": "string",
  • "ueIpv6": "string",
  • "ueMac": "string",
  • "anyUeInd": true,
  • "roamUeNetDescs": [
    ],
  • "paramOverPc5": "string",
  • "paramOverUu": "string",
  • "a2xParamsPc5": "string",
  • "a2xParamsUu": "string",
  • "paramForProSeDd": "string",
  • "paramForProSeDc": "string",
  • "paramForProSeU2NRelUe": "string",
  • "paramForProSeRemUe": "string",
  • "paramForProSeU2URelUe": "string",
  • "paramForProSeEndUe": "string",
  • "urspGuidance": [
    ],
  • "vpsUrspGuidance": [
    ],
  • "tnaps": [
    ],
  • "deliveryEvents": [
    ],
  • "policDelivNotifCorreId": "string",
  • "policDelivNotifUri": "string",
  • "suppFeat": "string",
  • "resUri": "string",
  • "headers": [
    ],
  • "resetIds": [
    ],
  • "paramForRangingSlPos": "string"
}

Response samples

Content type
application/json
{
  • "appId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "interGroupId": "string",
  • "supi": "string",
  • "ueIpv4": "string",
  • "ueIpv6": "string",
  • "ueMac": "string",
  • "anyUeInd": true,
  • "roamUeNetDescs": [
    ],
  • "paramOverPc5": "string",
  • "paramOverUu": "string",
  • "a2xParamsPc5": "string",
  • "a2xParamsUu": "string",
  • "paramForProSeDd": "string",
  • "paramForProSeDc": "string",
  • "paramForProSeU2NRelUe": "string",
  • "paramForProSeRemUe": "string",
  • "paramForProSeU2URelUe": "string",
  • "paramForProSeEndUe": "string",
  • "urspGuidance": [
    ],
  • "vpsUrspGuidance": [
    ],
  • "tnaps": [
    ],
  • "deliveryEvents": [
    ],
  • "policDelivNotifCorreId": "string",
  • "policDelivNotifUri": "string",
  • "suppFeat": "string",
  • "resUri": "string",
  • "headers": [
    ],
  • "resetIds": [
    ],
  • "paramForRangingSlPos": "string"
}

Modify part of the properties of an individual Service Parameter Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
serviceParamId
required
string

The Identifier of an Individual Service Parameter Data to be updated. It shall apply the format of Data type string.

Request Body schema: application/merge-patch+json
required
paramOverPc5
string or null (ParameterOverPc5Rm)

Represents the same as the ParameterOverPc5 data type but with the nullable:true property.

paramOverUu
string or null (ParameterOverUuRm)

Represents the same as the ParameterOverUu data type but with the nullable:true property.

a2xParamsPc5
string or null (A2xParamsPc5Rm)

Represents the same as the A2xParamsPc5 data type but with the nullable:true property.

a2xParamsUu
string or null (A2xParamsUuRm)

Represents the same as the A2xParamsUu data type but with the nullable:true property.

paramForProSeDd
string or null (ParamForProSeDdRm)

This data type is defined in the same way as the ParamForProSeDd data type, but with the OpenAPI nullable property set to true.

paramForProSeDc
string or null (ParamForProSeDcRm)

This data type is defined in the same way as the ParamForProSeDc data type, but with the OpenAPI nullable property set to true.

paramForProSeU2NRelUe
string or null (ParamForProSeU2NRelUeRm)

This data type is defined in the same way as the ParamForProSeU2NRelay data type, but with the OpenAPI nullable property set to true.

paramForProSeRemUe
string or null (ParamForProSeRemUeRm)

This data type is defined in the same way as the ParamForProSeRemUe data type, but with the OpenAPI nullable property set to true.

paramForProSeU2URelUE
string or null (ParamForProSeU2URelUeRm)

This data type is defined in the same way as the ParamForProSeU2URelay data type, but with the OpenAPI nullable property set to true.

paramForProSeEndUe
string or null (ParamForProSeEndUeRm)

This data type is defined in the same way as the ParamForProSeEndUe data type, but with the OpenAPI nullable property set to true.

Array of objects (UrspRuleRequest) non-empty
Deprecated

Contains the service parameter used to influence the URSP. This attribute is deprecated by the urspGuidance attribute.

Array of objects or null (UrspRuleRequest) non-empty

Contains the service parameters used to influence the URSP rule(s).

Array of objects or null (UrspRuleRequest) non-empty

Contains the service parameters used to guide the VPLMN specific URSP rule(s).

Array of objects or null (TnapId) non-empty

Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user.

Array of strings or strings or null (Event) non-empty

Contains the outcome of the UE Policy Delivery.

policDelivNotifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

headers
Array of strings non-empty

Contains the headers provisioned by the NEF.

paramForRangingSlPos
string or null (ParamForRangingSlPosRm)

This data type is defined in the same way as the ParamForRangingslpos data type, but with the OpenAPI nullable property set to true.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "paramOverPc5": "string",
  • "paramOverUu": "string",
  • "a2xParamsPc5": "string",
  • "a2xParamsUu": "string",
  • "paramForProSeDd": "string",
  • "paramForProSeDc": "string",
  • "paramForProSeU2NRelUe": "string",
  • "paramForProSeRemUe": "string",
  • "paramForProSeU2URelUE": "string",
  • "paramForProSeEndUe": "string",
  • "urspInfluence": [
    ],
  • "urspGuidance": [
    ],
  • "vpsUrspGuidance": [
    ],
  • "tnaps": [
    ],
  • "deliveryEvents": [
    ],
  • "policDelivNotifUri": "string",
  • "headers": [
    ],
  • "paramForRangingSlPos": "string"
}

Response samples

Content type
application/json
{
  • "appId": "string",
  • "dnn": "string",
  • "snssai": {
    },
  • "interGroupId": "string",
  • "supi": "string",
  • "ueIpv4": "string",
  • "ueIpv6": "string",
  • "ueMac": "string",
  • "anyUeInd": true,
  • "roamUeNetDescs": [
    ],
  • "paramOverPc5": "string",
  • "paramOverUu": "string",
  • "a2xParamsPc5": "string",
  • "a2xParamsUu": "string",
  • "paramForProSeDd": "string",
  • "paramForProSeDc": "string",
  • "paramForProSeU2NRelUe": "string",
  • "paramForProSeRemUe": "string",
  • "paramForProSeU2URelUe": "string",
  • "paramForProSeEndUe": "string",
  • "urspGuidance": [
    ],
  • "vpsUrspGuidance": [
    ],
  • "tnaps": [
    ],
  • "deliveryEvents": [
    ],
  • "policDelivNotifCorreId": "string",
  • "policDelivNotifUri": "string",
  • "suppFeat": "string",
  • "resUri": "string",
  • "headers": [
    ],
  • "resetIds": [
    ],
  • "paramForRangingSlPos": "string"
}

Delete an individual Service Parameter Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
serviceParamId
required
string

The Identifier of an Individual Service Parameter Data to be deleted. It shall apply the format of Data type string.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

AM Influence Data (Store)

Retrieve AM Influence Data

Authorizations:
NoneNoneNoneNone
query Parameters
am-influence-ids
Array of strings non-empty

Each element identifies a service.

dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a slice.

Array of objects (DnnSnssaiInformation) non-empty

Each element identifies a combination of (DNN, S-NSSAI).

internal-group-ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of users.

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies the user.

any-ue
boolean

Indicates whether the request is for any UE.

Array of objects (PlmnId) non-empty

Each element identifies a PLMN.

supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual AM Influence Data (Document)

Create or update an individual AM Influence Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
amInfluenceId
required
string

The Identifier of an Individual AM Influence Data to be created or updated. It shall apply the format of Data type string.

Request Body schema: application/json
required
One of
Any of
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Modify part of the properties of an individual AM Influence Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
amInfluenceId
required
string

The Identifier of an Individual AM Influence Data to be updated. It shall apply the format of Data type string.

Request Body schema: application/merge-patch+json
required
appIds
Array of strings or null non-empty

Identifies one or more applications.

Array of objects or null (DnnSnssaiInformation) non-empty

Identifies one or more DNN, S-NSSAI combinations.

Array of strings or strings or null (AmInfluEvent) non-empty

List of AM related events for which a subscription is required.

headers
Array of strings non-empty

Contains the headers provisioned by the NEF.

thruReq
boolean or null

Indicates whether high throughput is desired for the indicated UE traffic.

notifUri
string or null (UriRm)

String providing an URI formatted according to RFC 3986 with the OpenAPI 'nullable: true' property.

notifCorrId
string or null

Notification correlation identifier.

Array of objects or null (ServiceAreaCoverageInfo) non-empty

Indicates the service area coverage requirement.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "appIds": [
    ],
  • "dnnSnssaiInfos": [
    ],
  • "evSubs": [
    ],
  • "headers": [
    ],
  • "thruReq": true,
  • "notifUri": "string",
  • "notifCorrId": "string",
  • "covReq": [
    ]
}

Response samples

Content type
application/json
{ }

Delete an individual AM Influence Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
amInfluenceId
required
string

The Identifier of an Individual AM Influence Data to be deleted. It shall apply the format of Data type string.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

ApplicationDataSubscriptions (Collection)

Create a subscription to receive notification of application data changes

Authorizations:
NoneNoneNoneNone
Request Body schema: application/json
required
notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of objects (DataFilter) non-empty
expiry
string <date-time> (DateTime)

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

immRep
boolean

Immediate reporting indication.

Array of (object or objects) or (object or objects) or (object or objects) or (object or objects) (AmInfluData) non-empty

The AM Influence Data entries stored in the UDR that match a subscription.

supportedFeatures
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.

resetIds
Array of strings non-empty
Array of objects (ApplicationDataChangeNotif) non-empty

Immediate report with existing UDR entries.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "notificationUri": "string",
  • "dataFilters": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "immRep": true,
  • "amInfluEntries": [
    ],
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immReports": [
    ]
}

Response samples

Content type
application/json
{
  • "notificationUri": "string",
  • "dataFilters": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "immRep": true,
  • "amInfluEntries": [
    ],
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immReports": [
    ]
}

Callback payload samples

Callback
POST: {$request.body#/notificationUri}
Content type
application/json
[
  • {
    }
]

Read Application Data change Subscriptions

Authorizations:
NoneNoneNoneNone
query Parameters
object (DataFilter)

The data filter for the query.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AF Requested QoS Data Sets (Collection)

Retrieve one or several existing Individual AF Requested QoS Data Set resource(s).

Authorizations:
NoneNoneNoneNone
query Parameters
dnns
Array of strings (Dnn) non-empty

Each element identifies a DNN.

Array of objects (Snssai) non-empty

Each element identifies a network slice.

int-group-ids
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]

Each element identifies a group of subscriber(s).

supis
Array of strings (Supi) non-empty [ items^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ ]

Each element identifies a subscriber.

data-set-ids
Array of strings non-empty

Each element identifies an Individual AF requested QoS Data Set resource.

supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual AF Requested QoS Data Set (Document)

Create or update an Individual AF Requested QoS Data Set resource.

Authorizations:
NoneNoneNoneNone
path Parameters
afReqQosId
required
string

Represents the identifier of the Individual AF Requested QoS Data Set resource.

Request Body schema: application/json
required
One of
One of
One of
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Individual AF requested QoS Data Set (Document)

Modify of an existing Individual AF Requested QoS Data Set resource

Authorizations:
NoneNoneNoneNone
path Parameters
afReqQosId
required
string

Represents the identifier of the Individual AF Requested QoS Data Set resource.

Request Body schema: application/merge-patch+json
required
afAppId
string or null

Identifies an AF application.

object or null (EventsSubscReqDataRm)

This data type is defined in the same way as the EventsSubscReqData data type, but with the OpenAPI nullable property set to true.

Array of objects or null (FlowInfo) non-empty
Array of objects (EthFlowDescription) non-empty
Array of objects (EthFlowInfo) non-empty
qosReference
string or null
object or null (QosRequirementsRm)

Represents QoS requirements.

altSerReqs
Array of strings or null non-empty
Array of objects or null (AlternativeServiceRequirementsData) non-empty

Contains removable alternative service requirements that include individual QoS parameter sets.

disUeNotif
boolean or null

true indicates to disable QoS flow parameters signalling to the UE. false indicates not to disable QoS flow parameters signalling to the UE.

object (TemporalInValidity)

Represents the temporal invalidity conditions, i.e., the time interval(s) during which the AF request is not to be applied.

headers
Array of strings non-empty

Contains the headers provisioned by the NEF.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "afAppId": "string",
  • "evSubsc": {
    },
  • "flowInfo": [
    ],
  • "ethFlowInfo": [
    ],
  • "enEthFlowInfo": [
    ],
  • "qosReference": "string",
  • "qosReqs": {
    },
  • "altSerReqs": [
    ],
  • "altSerReqsData": [
    ],
  • "disUeNotif": true,
  • "tempInValidity": {
    },
  • "headers": [
    ]
}

Response samples

Content type
application/json
{ }

Delete an existing Individual AF requested QoS Data Set resource

Authorizations:
NoneNoneNoneNone
path Parameters
afReqQosId
required
string

Represents the identifier of the Individual AF Requested QoS Data Set resource.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

IndividualApplicationDataSubscription (Document)

Modify a subscription to receive notification of application data changes

Authorizations:
NoneNoneNoneNone
path Parameters
subsId
required
string
Request Body schema: application/json
required
notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

Array of objects (DataFilter) non-empty
expiry
string <date-time> (DateTime)

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

immRep
boolean

Immediate reporting indication.

Array of (object or objects) or (object or objects) or (object or objects) or (object or objects) (AmInfluData) non-empty

The AM Influence Data entries stored in the UDR that match a subscription.

supportedFeatures
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.

resetIds
Array of strings non-empty
Array of objects (ApplicationDataChangeNotif) non-empty

Immediate report with existing UDR entries.

Responses

Request samples

Content type
application/json
{
  • "notificationUri": "string",
  • "dataFilters": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "immRep": true,
  • "amInfluEntries": [
    ],
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immReports": [
    ]
}

Response samples

Content type
application/json
{
  • "notificationUri": "string",
  • "dataFilters": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "immRep": true,
  • "amInfluEntries": [
    ],
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immReports": [
    ]
}

Delete the individual Application Data subscription

Authorizations:
NoneNoneNoneNone
path Parameters
subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

Get an existing individual Application Data Subscription resource

Authorizations:
NoneNoneNoneNone
path Parameters
subsId
required
string

String identifying a subscription to the Individual Application Data Subscription

Responses

Response samples

Content type
application/json
{
  • "notificationUri": "string",
  • "dataFilters": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "immRep": true,
  • "amInfluEntries": [
    ],
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "immReports": [
    ]
}

EAS Deployment Data (Store)

Retrieve EAS Deployment Information Data

Authorizations:
NoneNoneNoneNone
query Parameters
dnn
string (Dnn)

Identifies a DNN.

object (Snssai)

Identifies an S-NSSAI.

internal-group-id
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

Identifies a group of users.

appId
string

Identifies an application.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual EAS Deployment Data (Document)

Retrieve an individual EAS Deployment Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
easDeployInfoId
required
string

String identifying an Individual EAS Deployment Information Data resource.

Responses

Response samples

Content type
application/json
{
  • "appId": "string",
  • "dnaiInfos": {
    },
  • "dnn": "string",
  • "fqdnPatternList": [
    ],
  • "internalGroupId": "string",
  • "snssai": {
    },
  • "targetAfId": "string"
}

Create or update an individual EAS Deployment Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
easDeployInfoId
required
string

The Identifier of an Individual EAS Deployment Data to be created or updated. It shall apply the format of Data type string.

Request Body schema: application/json
required
appId
string
object non-empty

list of DNS server identifier (consisting of IP address and port) and/or IP address(s) of the EAS in the local DN for each DNAI. The key of map is the DNAI.

dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

required
Array of objects or objects (FqdnPatternMatchingRule) non-empty
internalGroupId
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

targetAfId
string

Identifier of the AF that is responsible for the EAS associated with this EAS deployment information.

Responses

Request samples

Content type
application/json
{
  • "appId": "string",
  • "dnaiInfos": {
    },
  • "dnn": "string",
  • "fqdnPatternList": [
    ],
  • "internalGroupId": "string",
  • "snssai": {
    },
  • "targetAfId": "string"
}

Response samples

Content type
application/json
{
  • "appId": "string",
  • "dnaiInfos": {
    },
  • "dnn": "string",
  • "fqdnPatternList": [
    ],
  • "internalGroupId": "string",
  • "snssai": {
    },
  • "targetAfId": "string"
}

Individual EasDeployment Data (Document)

Delete an individual EAS Deployment Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
easDeployInfoId
required
string

The Identifier of an Individual EAS Deployment Data to be deleted. It shall apply the format of Data type string.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

DnaiEasMapping (Document)

Retrieves the EAS address information for a DNAI.

Authorizations:
NoneNoneNoneNone
path Parameters
dnai
required
string
query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "dnaiEasInfos": [
    ]
}

ECS Address Roaming Data (Store)

Retrieve ECS Address Roaming Data

Authorizations:
NoneNoneNoneNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual ECS Address Roaming Data (Document)

Retrieve an individual ECS Address Roaming Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
ecsAddrInfoId
required
string

String identifying an Individual ECS Address Roaming Data resource.

Responses

Response samples

Content type
application/json
{
  • "self": "string",
  • "ecsServerAddr": {
    },
  • "spatialValidityCond": {
    },
  • "ecsAuthMethods": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "suppFeat": "string"
}

Create or update an individual ECS Address Roaming Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
ecsAddrInfoId
required
string

The Identifier of an Individual ECS Address Roaming Data to be created or updated.

Request Body schema: application/json
required
self
string (Link)

string formatted according to IETF RFC 3986 identifying a referenced resource.

required
object (EcsServerAddr)

Contains the Edge Configuration Server Address Configuration Information as defined in clause 5.2.3.6.1 of 3GPP TS 23.502.

object (SpatialValidityCond)

Contains the Spatial Validity Condition.

Array of strings or strings (EcsAuthMethod) non-empty
dnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

suppFeat
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
{
  • "self": "string",
  • "ecsServerAddr": {
    },
  • "spatialValidityCond": {
    },
  • "ecsAuthMethods": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "self": "string",
  • "ecsServerAddr": {
    },
  • "spatialValidityCond": {
    },
  • "ecsAuthMethods": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "suppFeat": "string"
}

Update an individual ECS Address Roaming Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
ecsAddrInfoId
required
string

The Identifier of an Individual ECS Address Roaming Data to be updated.

Request Body schema: application/json
required
object (EcsServerAddr)

Contains the Edge Configuration Server Address Configuration Information as defined in clause 5.2.3.6.1 of 3GPP TS 23.502.

object (SpatialValidityCond)

Contains the Spatial Validity Condition.

Array of strings or strings (EcsAuthMethod) non-empty

Responses

Request samples

Content type
application/json
{
  • "ecsServerAddr": {
    },
  • "spatialValidityCond": {
    },
  • "ecsAuthMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "self": "string",
  • "ecsServerAddr": {
    },
  • "spatialValidityCond": {
    },
  • "ecsAuthMethods": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "suppFeat": "string"
}

Delete an individual ECS Address Roaming Data resource

Authorizations:
NoneNoneNoneNone
path Parameters
ecsAddrInfoId
required
string

The Identifier of an Individual ECS Address Roaming Data to be updated.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

UE ID Mappings (Store)

Retrieve one or several UE ID Mapping(s).

Authorizations:
NoneNoneNoneNone
query Parameters
app-layer-ids
Array of strings (ApplicationlayerId) non-empty

Contains the requested Application layer Id(s).

gpsis
Array of strings (Gpsi) non-empty [ items^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ ]

Contains the requested GPSI(s).

supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individual UE ID Mapping (Document)

Retrieve an existing Individual UE ID Mapping resource.

Authorizations:
NoneNoneNoneNone
path Parameters
ueMappingId
required
string

Contains the identifier of the Individual UE ID Mapping resource.

Responses

Response samples

Content type
application/json
{
  • "rsUeIdMappingInfo": {
    },
  • "suppFeat": "string"
}

Create or update a UE ID Mapping.

Authorizations:
NoneNoneNoneNone
path Parameters
ueMappingId
required
string

Contains the identifier of the Individual UE ID Mapping resource.

Request Body schema: application/json
required
object (RangSlUeIdMappInfo)

Represents the Ranging/Sidelink UE ID mapping information between the Application Layer ID and the GPSI.

suppFeat
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
{
  • "rsUeIdMappingInfo": {
    },
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "rsUeIdMappingInfo": {
    },
  • "suppFeat": "string"
}

Delete an existing Individual UE ID Mapping resource.

Authorizations:
NoneNoneNoneNone
path Parameters
ueMappingId
required
string

Contains the identifier of the Individual UE ID Mapping resource.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}