API docs by Redocly

Npcf_EventExposure (1.3.0)

Download OpenAPI specification:

PCF Event Exposure Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.523 V18.5.0; 5G System; Policy Control Event Exposure Service; Stage 3.

Policy Control Events Subscription (Collection)

Creates a new Individual Policy Control Events Subscription resource

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
required
Array of strings or strings (PcEvent) non-empty
object (ReportingInformation)

Represents the type of reporting that the subscription requires.

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

filterDnns
Array of strings (Dnn) non-empty
Array of objects (Snssai) non-empty
Array of objects (SnssaiDnnCombination) non-empty
Array of ServiceIdentification (object) or ServiceIdentification (object) or ServiceIdentification (object) (ServiceIdentification) non-empty
appIds
Array of strings (ApplicationId) non-empty
notifUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

notifId
required
string
Array of objects (PcEventNotification) non-empty
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

Callbacks

Request samples

Content type
application/json
{
  • "eventSubs": [
    ],
  • "eventsRepInfo": {
    },
  • "groupId": "string",
  • "filterDnns": [
    ],
  • "filterSnssais": [
    ],
  • "snssaiDnns": [
    ],
  • "filterServices": [
    ],
  • "appIds": [
    ],
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifs": [
    ],
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "eventSubs": [
    ],
  • "eventsRepInfo": {
    },
  • "groupId": "string",
  • "filterDnns": [
    ],
  • "filterSnssais": [
    ],
  • "snssaiDnns": [
    ],
  • "filterServices": [
    ],
  • "appIds": [
    ],
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifs": [
    ],
  • "suppFeat": "string"
}

Callback payload samples

Callback
POST: {$request.body#/notifUri}
Content type
application/json
{
  • "notifId": "string",
  • "eventNotifs": [
    ]
}

Individual Policy Control Events Subscription (Document)

Reads an existing Individual Policy Control Events Subscription

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Policy Control Event Subscription ID.

Responses

Response samples

Content type
application/json
{
  • "eventSubs": [
    ],
  • "eventsRepInfo": {
    },
  • "groupId": "string",
  • "filterDnns": [
    ],
  • "filterSnssais": [
    ],
  • "snssaiDnns": [
    ],
  • "filterServices": [
    ],
  • "appIds": [
    ],
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifs": [
    ],
  • "suppFeat": "string"
}

Modifies an existing Individual Policy Control Events Subscription

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Policy Control Event Subscription ID.

Request Body schema: application/json
required
required
Array of strings or strings (PcEvent) non-empty
object (ReportingInformation)

Represents the type of reporting that the subscription requires.

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

filterDnns
Array of strings (Dnn) non-empty
Array of objects (Snssai) non-empty
Array of objects (SnssaiDnnCombination) non-empty
Array of ServiceIdentification (object) or ServiceIdentification (object) or ServiceIdentification (object) (ServiceIdentification) non-empty
appIds
Array of strings (ApplicationId) non-empty
notifUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

notifId
required
string
Array of objects (PcEventNotification) non-empty
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
{
  • "eventSubs": [
    ],
  • "eventsRepInfo": {
    },
  • "groupId": "string",
  • "filterDnns": [
    ],
  • "filterSnssais": [
    ],
  • "snssaiDnns": [
    ],
  • "filterServices": [
    ],
  • "appIds": [
    ],
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifs": [
    ],
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "eventSubs": [
    ],
  • "eventsRepInfo": {
    },
  • "groupId": "string",
  • "filterDnns": [
    ],
  • "filterSnssais": [
    ],
  • "snssaiDnns": [
    ],
  • "filterServices": [
    ],
  • "appIds": [
    ],
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifs": [
    ],
  • "suppFeat": "string"
}

Cancels an existing Individual Policy Control Events Subscription

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Policy Control Event Subscription ID.

Responses

Response samples

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