API docs by Redocly

Namf_EventExposure (1.3.0)

Download OpenAPI specification:

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

3GPP TS 29.518 V18.6.0; 5G System; Access and Mobility Management Services

Subscriptions collection (Collection)

Namf_EventExposure Subscribe service Operation

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
required
object (AmfEventSubscription)

Represents an individual event subscription resource on AMF

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.

object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "subscription": {
    },
  • "supportedFeatures": "string",
  • "oldGuami": {
    }
}

Response samples

Content type
application/json
{
  • "subscription": {
    },
  • "subscriptionId": "string",
  • "reportList": [
    ],
  • "supportedFeatures": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "notifyCorrelationId": "string",
  • "subsChangeNotifyCorrelationId": "string",
  • "reportList": [
    ],
  • "eventSubsSyncInfo": {
    }
}

Individual subscription (Document)

Namf_EventExposure Subscribe Modify service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Unique ID of the subscription to be modified

Request Body schema: application/json-patch+json
required
One of
non-empty
Array (non-empty)
op
required
string
Enum: "add" "remove" "replace"
path
required
string^\/eventList\/-|(\/eventList\/0|\/eventList\/...
value
any

Responses

Request samples

Content type
application/json-patch+json
Example
[ ]

Response samples

Content type
application/json
{
  • "subscription": {
    },
  • "reportList": [
    ]
}

Namf_EventExposure Unsubscribe service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Unique ID of the subscription to be deleted

Responses

Response samples

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