API for Media Streaming Event Exposure. An OpenAPI 3.0.0 document with 2 path(s), API version 1.2.1, published verbatim by 3GPP in 3GPP TS 29.522 as part of the 5G NEF Northbound (Network Exposure) suite and mirrored in the public 3GPP Forge GitLab repository.
openapi: 3.0.0
info:
title: 3gpp-ms-event-exposure
version: 1.2.1
description: |
API for Media Streaming Event Exposure.
© 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.522 V19.6.0; 5G System; Network Exposure Function Northbound APIs.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers:
- url: '{apiRoot}/3gpp-ms-event-exposure/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
security:
- {}
- oAuth2ClientCredentials: []
paths:
/subscriptions:
get:
summary: Retrieve all the active Media Streaming Event Exposure Subscription resources managed by the NEF.
tags:
- Media Streaming Event Exposure Subscriptions (Collection)
operationId: RetrieveMSEventExposureSubscs
responses:
'200':
description: >
OK. All the active Media Streaming Event Exposure Subscriptions managed by the NEF are
returned.
content:
application/json:
schema:
type: array
items:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
minItems: 0
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
post:
summary: Request the creation of a new Individual Media Streaming Event Exposure Subscription resource.
tags:
- Media Streaming Event Exposure Subscriptions (Collection)
operationId: CreateMSEventExposureSubsc
requestBody:
description: >
Contains the parameters to request the creation of a new Media Streaming Event Exposure
Subscriptionat the NEF.
required: true
content:
application/json:
schema:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
responses:
'201':
description: >
Created. Successful creation of a new Individual Media Streaming Event Exposure
Subscription resource.
content:
application/json:
schema:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
msEventExposureNotif:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureNotif'
responses:
'204':
description: No Content. Successful reception of the notification.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
parameters:
- name: subscriptionId
in: path
description: >
Identifier of the Individual Media Streaming Event Exposure Subscription resource.
required: true
schema:
type: string
get:
summary: Retrieve an existing Individual Media Streaming Event Exposure Subscription resource.
tags:
- Individual Media Streaming Event Exposure Subscription (Document)
operationId: RetrieveIndivMSEventExposureSubsc
responses:
'200':
description: >
OK. The requested Individual Media Streaming Event Exposure Subscription resource is
successfully returned.
content:
application/json:
schema:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Request the update of an existing Individual Media Streaming Event Exposure Subscription resource.
tags:
- Individual Media Streaming Event Exposure Subscription (Document)
operationId: UpdateIndivMSEventExposureSubsc
requestBody:
description: >
Contains the updated representation of the Individual Media Streaming Event Exposure
Subscription resource.
resource.
required: true
content:
application/json:
schema:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
responses:
'200':
description: >
OK. The concerned Individual Media Streaming Event Exposure Subscription resource is
successfully updated and a representation of the updated resource is returned in the
response body.
content:
application/json:
schema:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
'204':
description: >
No Content. The concerned Individual Media Streaming Event Exposure Subscription
resource was successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Request the deletion of an existing Individual Media Streaming Event Exposure Subscription resource.
tags:
- Individual Media Streaming Event Exposure Subscription (Document)
operationId: DeleteIndivMSEventExposureSubsc
responses:
'204':
description: >
No Content. The Individual Media Streaming Event Exposure Subscription resource is
successfully deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
#
# STRUCTURED DATA TYPES
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#