A.24 MBSUserService API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

openapi: 3.0.0

info:

title: 3gpp-mbs-us

version: 1.0.1

description: |

API for MBS User Service.

© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

All rights reserved.

externalDocs:

description: >

3GPP TS 29.522 V17.8.0; 5G System; Network Exposure Function Northbound APIs.

url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/’

servers:

– url: ‘{apiRoot}/3gpp-mbs-us/v1’

variables:

apiRoot:

default: https://example.com

description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122

security:

– {}

– oAuth2ClientCredentials: []

paths:

/mbs-user-services:

get:

summary: Retrieve all the active MBS User Service resources managed by the NEF.

tags:

– MBS User Services

operationId: RetrieveMBSUserServices

responses:

‘200’:

description: >

OK. All the active MBS User Services managed by the NEF are returned.

content:

application/json:

schema:

type: array

items:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

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 MBS User Service resource.

tags:

– MBS User Services

operationId: CreateMBSUserService

requestBody:

description: >

Contains the parameters to request the creation of a new MBS User Service at the NEF.

required: true

content:

application/json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

responses:

‘201’:

description: >

Created. A new MBS User Service is successfully created and a representation of the

created Individual MBS User Service resource is returned.

content:

application/json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

headers:

Location:

description: >

Contains the URI of the newly created resource, according to the structure

{apiRoot}/3gpp-mbs-us/v1/mbs-user-services/{mbsUserServId}

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’

/mbs-user-services/{mbsUserServId}:

parameters:

– name: mbsUserServId

in: path

description: Identifier of the Individual MBS User Service resource.

required: true

schema:

type: string

get:

summary: Retrieve an existing Individual MBS User Service resource.

tags:

– Individual MBS User Service

operationId: RetrieveIndivMBSUserService

responses:

‘200’:

description: >

OK. The requested Individual MBS User Service resource is successfully returned.

content:

application/json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

‘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 MBS User Service resource.

tags:

– Individual MBS User Service

operationId: UpdateIndivMBSUserService

requestBody:

description: >

Contains the updated representation of the Individual MBS User Service resource.

required: true

content:

application/json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

responses:

‘200’:

description: >

OK. The concerned Individual MBS User Service resource is successfully updated and a

representation of the updated resource is returned.

content:

application/json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

‘204’:

description: >

No Content. The concerned Individual MBS User Service resource is successfully updated.

‘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’

patch:

summary: Request the modification of an existing Individual MBS User Service resource.

tags:

– Individual MBS User Service

operationId: ModifyIndivMBSUserService

requestBody:

description: >

Contains the parameters to request the modification of the Individual MBS User

Service resource.

required: true

content:

application/merge-patch+json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserServicePatch’

responses:

‘200’:

description: >

OK. The concerned Individual MBS User Service resource is successfully modified and a

representation of the updated resource is returned.

content:

application/json:

schema:

$ref: ‘TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService’

‘204’:

description: >

No Content. The concerned Individual MBS User Service resource is successfully modified.

‘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: Deletes an existing Individual MBS User Service resource.

tags:

– Individual MBS User Service

operationId: DeleteIndivMBSUserService

responses:

‘204’:

description: >

No Content. The Individual MBS User Service 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

#