2020-06-17 05:22:28 +00:00
openapi : 3.0 .0
info :
2021-07-07 08:32:55 +00:00
version : '1.1.4'
2020-06-17 05:22:28 +00:00
title : 'Nsmf_PDUSession'
description : |
SMF PDU Session Service.
2021-07-07 08:32:55 +00:00
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
2020-06-17 05:22:28 +00:00
All rights reserved.
externalDocs :
2021-07-07 08:32:55 +00:00
description : 3GPP TS 29.502 V16.8.0; 5G System; Session Management Services; Stage 3
2020-06-17 05:22:28 +00:00
url : http://www.3gpp.org/ftp/Specs/archive/29_series/29.502/
servers :
- url : '{apiRoot}/nsmf-pdusession/v1'
variables :
apiRoot :
default : https://example.com
description : apiRoot as defined in clause 4.4 of 3GPP TS 29.501. The sm-contexts and pdu-sessions resources can be distributed on different processing instances or hosts. Thus the authority and/or deployment-specific string of the apiRoot of the created individual sm context and pdu-session resources' URIs may differ from the authority and/or deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions collections' URIs.
security :
- {}
- oAuth2ClientCredentials :
- nsmf-pdusession
paths :
/sm-contexts :
post :
summary : Create SM Context
tags :
- SM contexts collection
operationId : PostSmContexts
requestBody :
description : representation of the SM context to be created in the SMF
required : true
content :
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateData'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
binaryDataN2SmInformationExt1 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformationExt1 :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
callbacks :
smContextStatusNotification :
'{$request.body#/smContextStatusUri}' :
post :
requestBody : # contents of the callback message
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/SmContextStatusNotification'
responses :
'204' :
description : successful notification
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
responses :
'201' :
description : successful creation of an SM context
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreatedData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreatedData'
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
headers :
Location :
description: 'Contains the URI of the newly created resource, according to the structure : {apiRoot}/nsmf-pdusession/{apiVersion}/sm-contexts/{smContextRef}'
required : true
schema :
type : string
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2020-06-17 05:22:28 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
description : unsuccessful creation of an SM context - bad request
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateError'
binaryDataN1SmMessage :
type : string
format : binary
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
type : string
format : binary
2020-06-17 05:22:28 +00:00
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
2020-06-17 05:22:28 +00:00
'403' :
description : unsuccessful creation of an SM context - forbidden
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateError'
binaryDataN1SmMessage :
type : string
format : binary
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
type : string
format : binary
2020-06-17 05:22:28 +00:00
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
2020-06-17 05:22:28 +00:00
'404' :
description : unsuccessful creation of an SM context - not found
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreateError'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateError'
binaryDataN1SmMessage :
type : string
format : binary
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
type : string
format : binary
2020-06-17 05:22:28 +00:00
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
2020-06-17 05:22:28 +00:00
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/413'
2020-06-17 05:22:28 +00:00
'415' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/415'
2020-06-17 05:22:28 +00:00
'429' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/429'
2020-06-17 05:22:28 +00:00
'500' :
description : unsuccessful creation of an SM context - internal server error
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateError'
binaryDataN1SmMessage :
type : string
format : binary
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
type : string
format : binary
2020-06-17 05:22:28 +00:00
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
2020-06-17 05:22:28 +00:00
'503' :
description : unsuccessful creation of an SM context - service unavailable
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateError'
binaryDataN1SmMessage :
type : string
format : binary
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
type : string
format : binary
2020-06-17 05:22:28 +00:00
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
2020-06-17 05:22:28 +00:00
'504' :
description : unsuccessful creation of an SM context - gateway timeout
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextCreateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextCreateError'
binaryDataN1SmMessage :
type : string
format : binary
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
type : string
format : binary
2020-06-17 05:22:28 +00:00
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
binaryDataN2SmMessage :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
2020-06-17 05:22:28 +00:00
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/sm-contexts/{smContextRef}/retrieve:
post :
summary : Retrieve SM Context
tags :
- Individual SM context
operationId : RetrieveSmContext
parameters :
- name : smContextRef
in : path
description : SM context reference
required : true
schema :
type : string
requestBody :
description : parameters used to retrieve the SM context
required : false
content :
application/json :
schema :
$ref : '#/components/schemas/SmContextRetrieveData'
responses :
'200' :
description : successful retrieval of an SM context
content :
application/json :
schema :
$ref : '#/components/schemas/SmContextRetrievedData'
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
'504' :
$ref : 'TS29571_CommonData.yaml#/components/responses/504'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/sm-contexts/{smContextRef}/modify:
post :
summary : Update SM Context
tags :
- Individual SM context
operationId : UpdateSmContext
parameters :
- name : smContextRef
in : path
description : SM context reference
required : true
schema :
type : string
requestBody :
description : representation of the updates to apply to the SM context
required : true
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdateData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdateData'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
binaryDataN2SmInformationExt1 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformationExt1 :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
responses :
'200' :
description : successful update of an SM context with content in the response
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdatedData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdatedData'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
'204' :
description : successful update of an SM context without content in the response
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
description : unsuccessful update of an SM context - bad request
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdateError'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
'403' :
description : unsuccessful update of an SM context - forbidden
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdateError'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
'404' :
description : unsuccessful update of an SM context - not found
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdateError'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdateError'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/413'
2020-06-17 05:22:28 +00:00
'415' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/415'
2020-06-17 05:22:28 +00:00
'429' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/429'
2020-06-17 05:22:28 +00:00
'500' :
description : unsuccessful update of an SM context - Internal server error
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdateError'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
'503' :
description : unsuccessful update of an SM context - Service Unavailable
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextUpdateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextUpdateError'
binaryDataN1SmMessage :
type : string
format : binary
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmMessage :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/sm-contexts/{smContextRef}/release:
post :
summary : Release SM Context
tags :
- Individual SM context
operationId : ReleaseSmContext
parameters :
- name : smContextRef
in : path
description : SM context reference
required : true
schema :
type : string
requestBody :
description : representation of the data to be sent to the SMF when releasing the SM context
required : false
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/SmContextReleaseData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/SmContextReleaseData'
binaryDataN2SmInformation :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN2SmInformation :
contentType : application/vnd.3gpp.ngap
headers :
Content-Id :
schema :
type : string
responses :
'200' :
description : successful release of a PDU session with content in the response
content :
2021-03-08 12:25:09 +00:00
application/json : # message without binary body part
2020-06-17 05:22:28 +00:00
schema :
$ref : '#/components/schemas/SmContextReleasedData'
'204' :
description : successful release of an SM context without content in the response
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/sm-contexts/{smContextRef}/send-mo-data:
post :
summary : Send MO Data
tags :
- Individual SM context
operationId : SendMoData
parameters :
- name : smContextRef
in : path
description : SM context reference
required : true
schema :
type : string
requestBody :
description : representation of the payload of Send MO Data Request
required : true
content :
multipart/related : # message with a binary body part
schema :
type : object
2021-03-08 12:25:09 +00:00
properties :
2020-06-17 05:22:28 +00:00
jsonData :
$ref : '#/components/schemas/SendMoDataReqData'
binaryMoData :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryMoData :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
responses :
'204' :
description : successful sending of MO data
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/400'
2020-06-17 05:22:28 +00:00
'401' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/401'
2020-06-17 05:22:28 +00:00
'403' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/403'
2020-06-17 05:22:28 +00:00
'404' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/404'
2020-06-17 05:22:28 +00:00
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/413'
2020-06-17 05:22:28 +00:00
'415' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/415'
2020-06-17 05:22:28 +00:00
'429' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/429'
2020-06-17 05:22:28 +00:00
'500' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/500'
2020-06-17 05:22:28 +00:00
'503' :
2021-03-08 12:25:09 +00:00
$ref : '#/components/responses/503'
2020-06-17 05:22:28 +00:00
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/pdu-sessions :
post :
summary : Create
tags :
- PDU sessions collection
operationId : PostPduSessions
requestBody :
description : representation of the PDU session to be created in the H-SMF or SMF
required : true
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/PduSessionCreateData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/PduSessionCreateData'
binaryDataN1SmInfoFromUe :
type : string
format : binary
binaryDataUnknownN1SmInfo :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoFromUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataUnknownN1SmInfo :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
callbacks :
statusNotification :
'{$request.body#/vsmfPduSessionUri}' :
post :
summary : Notify Status
tags :
- Individual PDU session (V-SMF)
operationId : NotifyStatus
requestBody :
$ref : '#/components/requestBodies/NotifyStatusRequestBody'
responses :
'204' :
description : successful notificationof the status change
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
statusNotification-ismf :
'{$request.body#/ismfPduSessionUri}' :
post :
summary : Notify Status
tags :
- Individual PDU session (I-SMF)
operationId : NotifyStatus-isfm
requestBody :
$ref : '#/components/requestBodies/NotifyStatusRequestBody'
responses :
'204' :
description : successful notificationof the status change
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
update :
'{$request.body#/vsmfPduSessionUri}/modify' :
post :
summary : Update (initiated by H-SMF)
tags :
- Individual PDU session (V-SMF)
operationId : ModifyPduSession
requestBody :
$ref : '#/components/requestBodies/VsmfUpdateRequestBody'
responses :
'200' :
$ref : '#/components/responses/VsmfUpdateResponse200'
'204' :
description : successful update of a PDU session without content in the response
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : '#/components/responses/VsmfUpdateError'
'403' :
$ref : '#/components/responses/VsmfUpdateError'
'404' :
$ref : '#/components/responses/VsmfUpdateError'
2021-03-08 12:25:09 +00:00
'409' :
$ref : '#/components/responses/VsmfUpdateError'
2020-06-17 05:22:28 +00:00
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : '#/components/responses/VsmfUpdateError'
'503' :
$ref : '#/components/responses/VsmfUpdateError'
'504' :
$ref : '#/components/responses/VsmfUpdateError'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
update-ismf :
'{$request.body#/ismfPduSessionUri}/modify' :
post :
summary : Update (initiated by SMF)
tags :
- Individual PDU session (I-SMF)
operationId : ModifyPduSession-ismf
requestBody :
$ref : '#/components/requestBodies/VsmfUpdateRequestBody'
responses :
'200' :
$ref : '#/components/responses/VsmfUpdateResponse200'
'204' :
description : successful update of a PDU session without content in the response
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : '#/components/responses/VsmfUpdateError'
'403' :
$ref : '#/components/responses/VsmfUpdateError'
'404' :
$ref : '#/components/responses/VsmfUpdateError'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : '#/components/responses/VsmfUpdateError'
'503' :
$ref : '#/components/responses/VsmfUpdateError'
'504' :
$ref : '#/components/responses/VsmfUpdateError'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
transferMtData :
'{$request.body#/vsmfPduSessionUri}/transfer-mt-data' :
post :
summary : Transfer MT Data (by H-SMF)
tags :
- Individual PDU session (V-SMF)
operationId : TransferMtData
requestBody :
description : representation of the payload of Transfer MT Data Request
required : true
content :
multipart/related : # message with a binary body part
schema :
type : object
2021-03-08 12:25:09 +00:00
properties :
2020-06-17 05:22:28 +00:00
jsonData :
$ref : '#/components/schemas/TransferMtDataReqData'
binaryMtData :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryMtData :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
responses :
'204' :
description : successful transfering of MT data
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29571_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
'504' :
description : unsuccessful delivery of mobile terminated data - gateway timeout
content :
application/json :
schema :
$ref : '#/components/schemas/TransferMtDataError'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
transferMtData-ismf :
'{$request.body#/ismfPduSessionUri}/transfer-mt-data' :
post :
summary : Transfer MT Data (by SMF)
tags :
- Individual PDU session (I-SMF)
operationId : TransferMtData-ismf
requestBody :
description : representation of the payload of Transfer MT Data Request
required : true
content :
multipart/related : # message with a binary body part
schema :
type : object
2021-03-08 12:25:09 +00:00
properties :
2020-06-17 05:22:28 +00:00
jsonData :
$ref : '#/components/schemas/TransferMtDataReqData'
binaryMtData :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryMtData :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
responses :
'204' :
description : successful transfering of MT data
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29571_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
'504' :
description : unsuccessful delivery of mobile terminated data - gateway timeout
content :
application/json :
schema :
$ref : '#/components/schemas/TransferMtDataError'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
responses :
'201' :
description : successful creation of a PDU session
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/PduSessionCreatedData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/PduSessionCreatedData'
binaryDataN1SmInfoToUe :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoToUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
headers :
Location :
description: 'Contains the URI of the newly created resource, according to the structure : {apiRoot}/nsmf-pdusession/{apiVersion}/pdu-sessions/{pduSessionRef}'
required : true
schema :
type : string
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2020-06-17 05:22:28 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : '#/components/responses/PduSessionCreateError'
'403' :
$ref : '#/components/responses/PduSessionCreateError'
'404' :
$ref : '#/components/responses/PduSessionCreateError'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : '#/components/responses/PduSessionCreateError'
'503' :
$ref : '#/components/responses/PduSessionCreateError'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/pdu-sessions/{pduSessionRef}/modify:
post :
summary : Update (initiated by V-SMF or I-SMF)
tags :
- Individual PDU session (H-SMF or SMF)
operationId : UpdatePduSession
parameters :
- name : pduSessionRef
in : path
description : PDU session reference
required : true
schema :
type : string
requestBody :
description : representation of the updates to apply to the PDU session
required : true
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/HsmfUpdateData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/HsmfUpdateData'
binaryDataN1SmInfoFromUe :
type : string
format : binary
binaryDataUnknownN1SmInfo :
type : string
format : binary
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoFromUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataUnknownN1SmInfo :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
responses :
'200' :
description : successful update of a PDU session with content in the response
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/HsmfUpdatedData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/HsmfUpdatedData'
binaryDataN1SmInfoToUe :
type : string
format : binary
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoToUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
'204' :
description : successful update of a PDU session without content in the response
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2021-03-08 12:25:09 +00:00
'400' :
$ref : '#/components/responses/HsmfUpdateError'
'403' :
$ref : '#/components/responses/HsmfUpdateError'
'404' :
$ref : '#/components/responses/HsmfUpdateError'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : '#/components/responses/HsmfUpdateError'
'503' :
$ref : '#/components/responses/HsmfUpdateError'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/pdu-sessions/{pduSessionRef}/release:
post :
summary : Release
tags :
- Individual PDU session (H-SMF or SMF)
operationId : ReleasePduSession
parameters :
- name : pduSessionRef
in : path
description : PDU session reference
required : true
schema :
type : string
requestBody :
description : data sent to H-SMF or SMF when releasing the PDU session
required : false
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/ReleaseData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties :
jsonData :
$ref : '#/components/schemas/ReleaseData'
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
responses :
'200' :
description : successful release of a PDU session with content in the response
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/ReleasedData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties :
jsonData :
$ref : '#/components/schemas/ReleasedData'
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
'204' :
description : successful release of a PDU session
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
2020-06-17 05:22:28 +00:00
'403' :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
2020-06-17 05:22:28 +00:00
'404' :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
2020-06-17 05:22:28 +00:00
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
2020-06-17 05:22:28 +00:00
'503' :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
2020-06-17 05:22:28 +00:00
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
2021-03-08 12:25:09 +00:00
/pdu-sessions/{pduSessionRef}/retrieve:
2020-06-17 05:22:28 +00:00
post :
2021-03-08 12:25:09 +00:00
summary : Retrieve
2020-06-17 05:22:28 +00:00
tags :
- Individual PDU session (H-SMF or SMF)
2021-03-08 12:25:09 +00:00
operationId : RetrievePduSession
2020-06-17 05:22:28 +00:00
parameters :
- name : pduSessionRef
in : path
description : PDU session reference
required : true
schema :
type : string
requestBody :
2021-03-08 12:25:09 +00:00
description : representation of the payload of the Retrieve Request
required : true
2020-06-17 05:22:28 +00:00
content :
application/json :
schema :
2021-03-08 12:25:09 +00:00
$ref : '#/components/schemas/RetrieveData'
2020-06-17 05:22:28 +00:00
responses :
'200' :
2021-03-08 12:25:09 +00:00
description : successful information retrieval
2020-06-17 05:22:28 +00:00
content :
2021-03-08 12:25:09 +00:00
application/json : # message without binary body part
2020-06-17 05:22:28 +00:00
schema :
2021-03-08 12:25:09 +00:00
$ref : '#/components/schemas/RetrievedData'
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
2021-03-08 12:25:09 +00:00
'504' :
$ref : 'TS29571_CommonData.yaml#/components/responses/504'
2020-06-17 05:22:28 +00:00
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/pdu-sessions/{pduSessionRef}/transfer-mo-data:
post :
summary : Transfer MO Data
tags :
- Individual PDU session (H-SMF or SMF)
operationId : TransferMoData
parameters :
- name : pduSessionRef
in : path
description : PDU session reference
required : true
schema :
type : string
requestBody :
description : representation of the payload of Transfer MO Data Request
required : true
content :
multipart/related : # message with a binary body part
schema :
type : object
2021-03-08 12:25:09 +00:00
properties :
2020-06-17 05:22:28 +00:00
jsonData :
$ref : '#/components/schemas/TransferMoDataReqData'
binaryMoData :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryMoData :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
responses :
'204' :
description : successful transfering of MO data
2021-03-08 12:25:09 +00:00
'307' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/307'
2021-03-08 12:25:09 +00:00
'308' :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/responses/308'
2020-06-17 05:22:28 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29571_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29571_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29571_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
components :
securitySchemes :
oAuth2ClientCredentials :
type : oauth2
flows :
clientCredentials :
tokenUrl : '{nrfApiRoot}/oauth2/token'
scopes :
nsmf-pdusession : Access to the nsmf-pdusession API
schemas :
#
# STRUCTURED DATA TYPES
#
SmContextCreateData :
type : object
properties :
supi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Supi'
unauthenticatedSupi :
type : boolean
default : false
pei :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Pei'
gpsi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
pduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
dnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
2021-03-08 12:25:09 +00:00
selectedDnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
2020-06-17 05:22:28 +00:00
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
hplmnSnssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
servingNfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
guami :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
serviceName :
$ref : 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
servingNetwork :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
requestType :
$ref : '#/components/schemas/RequestType'
n1SmMsg :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
anType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
additionalAnType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
ratType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RatType'
presenceInLadn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PresenceState'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
smContextStatusUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
hSmfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
2021-03-08 12:25:09 +00:00
hSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-06-17 05:22:28 +00:00
smfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
2021-03-08 12:25:09 +00:00
smfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-06-17 05:22:28 +00:00
additionalHsmfUri :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
minItems : 1
2021-03-08 12:25:09 +00:00
additionalHsmfId :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems : 1
2020-06-17 05:22:28 +00:00
additionalSmfUri :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
minItems : 1
2021-03-08 12:25:09 +00:00
additionalSmfId :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems : 1
2020-06-17 05:22:28 +00:00
oldPduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
pduSessionsActivateList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
minItems : 1
ueEpsPdnConnection :
$ref : '#/components/schemas/EpsPdnCnxContainer'
hoState :
$ref : '#/components/schemas/HoState'
pcfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
pcfGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
pcfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
nrfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
selMode :
$ref : '#/components/schemas/DnnSelectionMode'
backupAmfInfo :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo'
minItems : 1
traceData :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TraceData'
udmGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
routingIndicator :
type : string
epsInterworkingInd :
$ref : '#/components/schemas/EpsInterworkingIndication'
indirectForwardingFlag :
type : boolean
2021-03-08 12:25:09 +00:00
directForwardingFlag :
type : boolean
2020-06-17 05:22:28 +00:00
targetId :
$ref : 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId'
epsBearerCtxStatus :
$ref : '#/components/schemas/EpsBearerContextStatus'
cpCiotEnabled :
type : boolean
default : false
cpOnlyInd :
type : boolean
default : false
invokeNef :
type : boolean
default : false
maRequestInd :
type : boolean
default : false
maNwUpgradeInd :
type : boolean
default : false
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
n2SmInfoExt1 :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoTypeExt1 :
$ref : '#/components/schemas/N2SmInfoType'
smContextRef :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
2021-03-08 12:25:09 +00:00
smContextSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smContextSmfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
smContextSmfServiceSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId'
smContextSmfBinding :
$ref : 'TS29518_Namf_Communication.yaml#/components/schemas/SbiBindingLevel'
2020-06-17 05:22:28 +00:00
upCnxState :
$ref : '#/components/schemas/UpCnxState'
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
extendedNasSmTimerInd :
type : boolean
default : false
dlDataWaitingInd :
type : boolean
default : false
ddnFailureSubs :
$ref : '#/components/schemas/DdnFailureSubs'
smfTransferInd :
type : boolean
default : false
oldSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
oldSmContextRef :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
wAgfInfo :
$ref : 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo'
tngfInfo :
$ref : 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo'
twifInfo :
$ref : 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo'
2021-07-07 08:32:55 +00:00
ranUnchangedInd :
type : boolean
2020-06-17 05:22:28 +00:00
required :
- servingNfId
- servingNetwork
- anType
- smContextStatusUri
SmContextCreatedData :
type : object
properties :
hSmfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
smfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
pduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
upCnxState :
$ref : '#/components/schemas/UpCnxState'
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
allocatedEbiList :
type : array
items :
$ref : '#/components/schemas/EbiArpMapping'
minItems : 1
hoState :
$ref : '#/components/schemas/HoState'
gpsi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
smfServiceInstanceId :
type : string
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2021-03-08 12:25:09 +00:00
selectedSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
selectedOldSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-06-17 05:22:28 +00:00
SmContextUpdateData :
type : object
properties :
pei :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Pei'
servingNfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
guami :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
servingNetwork :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
backupAmfInfo :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo'
minItems : 1
nullable : true
anType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
additionalAnType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
2021-03-08 12:25:09 +00:00
anTypeToReactivate :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
2020-06-17 05:22:28 +00:00
ratType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RatType'
presenceInLadn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PresenceState'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
upCnxState :
$ref : '#/components/schemas/UpCnxState'
hoState :
$ref : '#/components/schemas/HoState'
toBeSwitched :
type : boolean
default : false
failedToBeSwitched :
type : boolean
n1SmMsg :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
targetId :
$ref : 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId'
targetServingNfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smContextStatusUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
dataForwarding :
type : boolean
default : false
n9ForwardingTunnel :
$ref : '#/components/schemas/TunnelInfo'
n9DlForwardingTnlList :
type : array
items :
$ref : '#/components/schemas/IndirectDataForwardingTunnelInfo'
minItems : 1
n9UlForwardingTnlList :
type : array
items :
$ref : '#/components/schemas/IndirectDataForwardingTunnelInfo'
minItems : 1
epsBearerSetup :
type : array
items :
$ref : '#/components/schemas/EpsBearerContainer'
minItems : 0
revokeEbiList :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
release :
type : boolean
default : false
cause :
$ref : '#/components/schemas/Cause'
ngApCause :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
5gMmCauseValue :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5GMmCause'
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
traceData :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TraceData'
epsInterworkingInd :
$ref : '#/components/schemas/EpsInterworkingIndication'
anTypeCanBeChanged :
type : boolean
default : false
n2SmInfoExt1 :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoTypeExt1 :
$ref : '#/components/schemas/N2SmInfoType'
maReleaseInd :
$ref : '#/components/schemas/MaReleaseIndication'
maNwUpgradeInd :
type : boolean
default : false
maRequestInd :
type : boolean
default : false
exemptionInd :
$ref : '#/components/schemas/ExemptionInd'
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
moExpDataCounter :
$ref : 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter'
extendedNasSmTimerInd :
type : boolean
forwardingFTeid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
forwardingBearerContexts :
type : array
items :
$ref : '#/components/schemas/ForwardingBearerContainer'
minItems : 1
ddnFailureSubs :
$ref : '#/components/schemas/DdnFailureSubs'
SmContextUpdatedData :
type : object
properties :
upCnxState :
$ref : '#/components/schemas/UpCnxState'
hoState :
$ref : '#/components/schemas/HoState'
releaseEbiList :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
allocatedEbiList :
type : array
items :
$ref : '#/components/schemas/EbiArpMapping'
minItems : 1
modifiedEbiList :
type : array
items :
$ref : '#/components/schemas/EbiArpMapping'
minItems : 1
n1SmMsg :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
epsBearerSetup :
type : array
items :
$ref : '#/components/schemas/EpsBearerContainer'
minItems : 1
dataForwarding :
type : boolean
n3DlForwardingTnlList :
type : array
items :
$ref : '#/components/schemas/IndirectDataForwardingTunnelInfo'
minItems : 1
n3UlForwardingTnlList :
type : array
items :
$ref : '#/components/schemas/IndirectDataForwardingTunnelInfo'
minItems : 1
cause :
$ref : '#/components/schemas/Cause'
maAcceptedInd :
type : boolean
default : false
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
forwardingFTeid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
forwardingBearerContexts :
type : array
items :
$ref : '#/components/schemas/ForwardingBearerContainer'
minItems : 1
2021-03-08 12:25:09 +00:00
selectedSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
selectedOldSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-06-17 05:22:28 +00:00
SmContextReleaseData :
type : object
properties :
cause :
$ref : '#/components/schemas/Cause'
ngApCause :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
5gMmCauseValue :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5GMmCause'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
vsmfReleaseOnly :
type : boolean
default : false
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
ismfReleaseOnly :
type : boolean
default : false
SmContextReleasedData :
type : object
properties :
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
SmContextStatusNotification :
type : object
properties :
statusInfo :
$ref : '#/components/schemas/StatusInfo'
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
ddnFailureStatus :
type : boolean
default : false
2021-03-08 12:25:09 +00:00
notifyCorrelationIdsForddnFailure :
type : array
items :
type : string
minItems : 1
2020-06-17 05:22:28 +00:00
newSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
newSmfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
oldSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
oldSmContextRef :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
2021-07-07 08:32:55 +00:00
altAnchorSmfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
altAnchorSmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-06-17 05:22:28 +00:00
required :
- statusInfo
PduSessionCreateData :
type : object
properties :
supi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Supi'
unauthenticatedSupi :
type : boolean
default : false
pei :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Pei'
pduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
dnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
2021-03-08 12:25:09 +00:00
selectedDnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
2020-06-17 05:22:28 +00:00
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
vsmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
ismfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
servingNetwork :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
requestType :
$ref : '#/components/schemas/RequestType'
epsBearerId :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
pgwS8cFteid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
vsmfPduSessionUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
ismfPduSessionUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
vcnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
icnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
n9ForwardingTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
additionalCnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
anType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
additionalAnType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
ratType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RatType'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
gpsi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
n1SmInfoFromUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
unknownN1SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
hPcfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
pcfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
pcfGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
pcfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
hoPreparationIndication :
type : boolean
selMode :
$ref : '#/components/schemas/DnnSelectionMode'
alwaysOnRequested :
type : boolean
default : false
udmGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
routingIndicator :
type : string
epsInterworkingInd :
$ref : '#/components/schemas/EpsInterworkingIndication'
vSmfServiceInstanceId :
type : string
iSmfServiceInstanceId :
type : string
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
roamingChargingProfile :
$ref : 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile'
chargingId :
type : string
oldPduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
epsBearerCtxStatus :
$ref : '#/components/schemas/EpsBearerContextStatus'
amfNfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
guami :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
2021-03-08 12:25:09 +00:00
maxIntegrityProtectedDataRateUl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
maxIntegrityProtectedDataRateDl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
2020-06-17 05:22:28 +00:00
cpCiotEnabled :
type : boolean
default : false
cpOnlyInd :
type : boolean
default : false
invokeNef :
type : boolean
default : false
maRequestInd :
type : boolean
default : false
maNwUpgradeInd :
type : boolean
default : false
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems : 1
presenceInLadn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PresenceState'
secondaryRatUsageInfo :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
minItems : 1
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
dlServingPlmnRateCtl :
type : integer
minimum : 10
2021-03-08 12:25:09 +00:00
upSecurityInfo :
$ref : '#/components/schemas/UpSecurityInfo'
vplmnQos :
$ref : '#/components/schemas/VplmnQos'
2020-06-17 05:22:28 +00:00
required :
- dnn
- servingNetwork
- anType
oneOf :
- required : [ vsmfId, vsmfPduSessionUri ]
- required : [ ismfId, ismfPduSessionUri ]
PduSessionCreatedData :
type : object
properties :
pduSessionType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
sscMode :
type : string
pattern : '^[0-7]$'
hcnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
cnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
additionalCnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
sessionAmbr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ambr'
qosFlowsSetupList :
type : array
items :
$ref : '#/components/schemas/QosFlowSetupItem'
minItems : 1
hSmfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
pduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
enablePauseCharging :
type : boolean
default : false
ueIpv4Address :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ueIpv6Prefix :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
n1SmInfoToUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
epsPdnCnxInfo :
$ref : '#/components/schemas/EpsPdnCnxInfo'
epsBearerInfo :
type : array
items :
$ref : '#/components/schemas/EpsBearerInfo'
minItems : 1
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
maxIntegrityProtectedDataRate :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
2021-03-08 12:25:09 +00:00
maxIntegrityProtectedDataRateDl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
2020-06-17 05:22:28 +00:00
alwaysOnGranted :
type : boolean
default : false
gpsi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
upSecurity :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UpSecurity'
roamingChargingProfile :
$ref : 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile'
hSmfServiceInstanceId :
type : string
smfServiceInstanceId :
type : string
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems : 1
ipv6MultiHomingInd :
type : boolean
default : false
maAcceptedInd :
type : boolean
default : false
homeProvidedChargingId :
type : string
nefExtBufSupportInd :
type : boolean
default : false
2021-03-08 12:25:09 +00:00
smallDataRateControlEnabled :
type : boolean
default : false
ueIpv6InterfaceId :
type : string
pattern : '^[A-Fa-f0-9]{16}$'
ipv6Index :
$ref : 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex'
dnAaaAddress :
$ref : '#/components/schemas/IpAddress'
2021-07-07 08:32:55 +00:00
redundantPduSessionInfo :
$ref : '#/components/schemas/RedundantPduSessionInformation'
2020-06-17 05:22:28 +00:00
required :
- pduSessionType
- sscMode
oneOf :
- required : [ hSmfInstanceId ]
- required : [ smfInstanceId ]
HsmfUpdateData :
type : object
properties :
requestIndication :
$ref : '#/components/schemas/RequestIndication'
pei :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Pei'
vcnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
icnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
additionalCnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
servingNetwork :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
anType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
additionalAnType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
ratType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RatType'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
pauseCharging :
type : boolean
pti :
$ref : '#/components/schemas/ProcedureTransactionId'
n1SmInfoFromUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
unknownN1SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
qosFlowsRelNotifyList :
type : array
items :
$ref : '#/components/schemas/QosFlowItem'
minItems : 1
qosFlowsNotifyList :
type : array
items :
$ref : '#/components/schemas/QosFlowNotifyItem'
minItems : 1
NotifyList :
type : array
items :
$ref : '#/components/schemas/PduSessionNotifyItem'
minItems : 1
epsBearerId :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 0
hoPreparationIndication :
type : boolean
revokeEbiList :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
cause :
$ref : '#/components/schemas/Cause'
ngApCause :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
5gMmCauseValue :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5GMmCause'
alwaysOnRequested :
type : boolean
default : false
epsInterworkingInd :
$ref : '#/components/schemas/EpsInterworkingIndication'
secondaryRatUsageReport :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport'
minItems : 1
secondaryRatUsageInfo :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
minItems : 1
anTypeCanBeChanged :
type : boolean
default : false
maReleaseInd :
$ref : '#/components/schemas/MaReleaseIndication'
maNwUpgradeInd :
type : boolean
default : false
maRequestInd :
type : boolean
default : false
unavailableAccessInd :
$ref : '#/components/schemas/UnavailableAccessIndication'
psaInfo :
type : array
items :
$ref : '#/components/schemas/PsaInformation'
minItems : 1
ulclBpInfo :
$ref : '#/components/schemas/UlclBpInformation'
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
$ref : '#/components/schemas/N4Information'
presenceInLadn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PresenceState'
vsmfPduSessionUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
vsmfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
vSmfServiceInstanceId :
type : string
ismfPduSessionUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
ismfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
iSmfServiceInstanceId :
type : string
dlServingPlmnRateCtl :
type : integer
minimum : 10
nullable : true
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems : 1
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
roamingChargingProfile :
$ref : 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile'
moExpDataCounter :
$ref : 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter'
vplmnQos :
$ref : '#/components/schemas/VplmnQos'
2021-03-08 12:25:09 +00:00
securityResult :
$ref : '#/components/schemas/SecurityResult'
upSecurityInfo :
$ref : '#/components/schemas/UpSecurityInfo'
2021-07-07 08:32:55 +00:00
amfNfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
guami :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
2020-06-17 05:22:28 +00:00
required :
- requestIndication
HsmfUpdatedData :
type : object
properties :
n1SmInfoToUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
$ref : '#/components/schemas/N4Information'
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems : 1
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
roamingChargingProfile :
$ref : 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile'
2021-03-08 12:25:09 +00:00
upSecurity :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UpSecurity'
maxIntegrityProtectedDataRateUl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
maxIntegrityProtectedDataRateDl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
2020-06-17 05:22:28 +00:00
ipv6MultiHomingInd :
type : boolean
default : false
2021-07-07 08:32:55 +00:00
qosFlowsSetupList :
type : array
items :
$ref : '#/components/schemas/QosFlowSetupItem'
minItems : 1
sessionAmbr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ambr'
epsPdnCnxInfo :
$ref : '#/components/schemas/EpsPdnCnxInfo'
epsBearerInfo :
type : array
items :
$ref : '#/components/schemas/EpsBearerInfo'
minItems : 1
pti :
$ref : '#/components/schemas/ProcedureTransactionId'
2020-06-17 05:22:28 +00:00
ReleaseData :
type : object
properties :
cause :
$ref : '#/components/schemas/Cause'
ngApCause :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
5gMmCauseValue :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5GMmCause'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
secondaryRatUsageReport :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport'
minItems : 1
secondaryRatUsageInfo :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
minItems : 1
2021-03-08 12:25:09 +00:00
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
$ref : '#/components/schemas/N4Information'
2020-06-17 05:22:28 +00:00
ReleasedData :
type : object
properties :
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
2021-03-08 12:25:09 +00:00
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
$ref : '#/components/schemas/N4Information'
2020-06-17 05:22:28 +00:00
VsmfUpdateData :
type : object
properties :
requestIndication :
$ref : '#/components/schemas/RequestIndication'
sessionAmbr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ambr'
qosFlowsAddModRequestList :
type : array
items :
$ref : '#/components/schemas/QosFlowAddModifyRequestItem'
minItems : 1
qosFlowsRelRequestList :
type : array
items :
$ref : '#/components/schemas/QosFlowReleaseRequestItem'
minItems : 1
epsBearerInfo :
type : array
items :
$ref : '#/components/schemas/EpsBearerInfo'
minItems : 1
assignEbiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Arp'
minItems : 1
revokeEbiList :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
modifiedEbiList :
type : array
items :
$ref : '#/components/schemas/EbiArpMapping'
minItems : 1
pti :
$ref : '#/components/schemas/ProcedureTransactionId'
n1SmInfoToUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
alwaysOnGranted :
type : boolean
default : false
hsmfPduSessionUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
cause :
$ref : '#/components/schemas/Cause'
n1smCause :
type : string
backOffTimer :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
maReleaseInd :
$ref : '#/components/schemas/MaReleaseIndication'
maAcceptedInd :
type : boolean
default : false
additionalCnTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
$ref : '#/components/schemas/N4Information'
2021-03-08 12:25:09 +00:00
smallDataRateControlEnabled :
type : boolean
qosMonitoringInfo :
$ref : '#/components/schemas/QosMonitoringInfo'
2020-06-17 05:22:28 +00:00
required :
- requestIndication
VsmfUpdatedData :
type : object
properties :
qosFlowsAddModList :
type : array
items :
$ref : '#/components/schemas/QosFlowItem'
minItems : 1
qosFlowsRelList :
type : array
items :
$ref : '#/components/schemas/QosFlowItem'
minItems : 1
qosFlowsFailedtoAddModList :
type : array
items :
$ref : '#/components/schemas/QosFlowItem'
minItems : 1
qosFlowsFailedtoRelList :
type : array
items :
$ref : '#/components/schemas/QosFlowItem'
minItems : 1
n1SmInfoFromUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
unknownN1SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
addUeLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
assignedEbiList :
type : array
items :
$ref : '#/components/schemas/EbiArpMapping'
minItems : 1
failedToAssignEbiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Arp'
minItems : 1
releasedEbiList :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
secondaryRatUsageReport :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport'
minItems : 1
secondaryRatUsageInfo :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
minItems : 1
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
2021-03-08 12:25:09 +00:00
$ref : '#/components/schemas/N4Information'
2020-06-17 05:22:28 +00:00
StatusNotification :
type : object
properties :
statusInfo :
$ref : '#/components/schemas/StatusInfo'
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
required :
- statusInfo
QosFlowItem :
type : object
properties :
qfi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Qfi'
cause :
$ref : '#/components/schemas/Cause'
2021-03-08 12:25:09 +00:00
currentQosProfileIndex :
type : integer
minimum : 1
maximum : 8
nullQoSProfileIndex :
type : boolean
2020-06-17 05:22:28 +00:00
required :
- qfi
QosFlowSetupItem :
type : object
properties :
qfi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Qfi'
qosRules :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
ebi :
$ref : '#/components/schemas/EpsBearerId'
qosFlowDescription :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
qosFlowProfile :
$ref : '#/components/schemas/QosFlowProfile'
associatedAnType :
$ref : '#/components/schemas/QosFlowAccessType'
required :
- qfi
- qosRules
QosFlowAddModifyRequestItem :
type : object
properties :
qfi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Qfi'
ebi :
$ref : '#/components/schemas/EpsBearerId'
qosRules :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
qosFlowDescription :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
qosFlowProfile :
$ref : '#/components/schemas/QosFlowProfile'
associatedAnType :
$ref : '#/components/schemas/QosFlowAccessType'
required :
- qfi
QosFlowReleaseRequestItem :
type : object
properties :
qfi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Qfi'
qosRules :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
qosFlowDescription :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
required :
- qfi
QosFlowProfile :
type : object
properties :
5qi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5Qi'
nonDynamic5Qi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NonDynamic5Qi'
dynamic5Qi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dynamic5Qi'
arp :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Arp'
gbrQosFlowInfo :
$ref : '#/components/schemas/GbrQosFlowInformation'
rqa :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ReflectiveQoSAttribute'
additionalQosFlowInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AdditionalQosFlowInfo'
2021-03-08 12:25:09 +00:00
qosMonitoringReq :
$ref : '#/components/schemas/QosMonitoringReq'
qosRepPeriod :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
2020-06-17 05:22:28 +00:00
required :
- 5qi
GbrQosFlowInformation :
type : object
properties :
maxFbrDl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxFbrUl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
guaFbrDl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
guaFbrUl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
notifControl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NotificationControl'
maxPacketLossRateDl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
maxPacketLossRateUl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
2021-03-08 12:25:09 +00:00
alternativeQosProfileList :
type : array
items :
$ref : '#/components/schemas/AlternativeQosProfile'
2020-06-17 05:22:28 +00:00
required :
- maxFbrDl
- maxFbrUl
- guaFbrDl
- guaFbrUl
QosFlowNotifyItem :
type : object
properties :
qfi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Qfi'
notificationCause :
$ref : '#/components/schemas/NotificationCause'
2021-03-08 12:25:09 +00:00
currentQosProfileIndex :
type : integer
minimum : 1
maximum : 8
nullQoSProfileIndex :
type : boolean
2020-06-17 05:22:28 +00:00
required :
- qfi
- notificationCause
SmContextRetrieveData :
type : object
properties :
targetMmeCap :
$ref : '#/components/schemas/MmeCapabilities'
smContextType :
$ref : '#/components/schemas/SmContextType'
servingNetwork :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
notToTransferEbiList :
type : array
items :
$ref : '#/components/schemas/EpsBearerId'
minItems : 1
2021-07-07 08:32:55 +00:00
ranUnchangedInd :
type : boolean
default : false
2020-06-17 05:22:28 +00:00
SmContextRetrievedData :
type : object
properties :
ueEpsPdnConnection :
$ref : '#/components/schemas/EpsPdnCnxContainer'
smContext :
$ref : '#/components/schemas/SmContext'
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
apnRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus'
dlDataWaitingInd :
type : boolean
default : false
required :
- ueEpsPdnConnection
MmeCapabilities :
type : object
properties :
nonIpSupported :
type : boolean
default : false
ethernetSupported :
type : boolean
default : false
TunnelInfo :
type : object
properties :
ipv4Addr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
gtpTeid :
$ref : '#/components/schemas/Teid'
anType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
required :
- gtpTeid
StatusInfo :
type : object
properties :
resourceStatus :
$ref : '#/components/schemas/ResourceStatus'
cause :
$ref : '#/components/schemas/Cause'
cnAssistedRanPara :
$ref : '#/components/schemas/CnAssistedRanPara'
anType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
required :
- resourceStatus
EpsPdnCnxInfo :
type : object
properties :
pgwS8cFteid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
pgwNodeName :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
linkedBearerId :
$ref : '#/components/schemas/EpsBearerId'
required :
- pgwS8cFteid
EpsBearerInfo :
type : object
properties :
ebi :
$ref : '#/components/schemas/EpsBearerId'
pgwS8uFteid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
bearerLevelQoS :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Bytes'
required :
- ebi
- pgwS8uFteid
- bearerLevelQoS
PduSessionNotifyItem :
type : object
properties :
notificationCause :
$ref : '#/components/schemas/NotificationCause'
required :
- notificationCause
EbiArpMapping :
type : object
properties :
epsBearerId :
$ref : '#/components/schemas/EpsBearerId'
arp :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Arp'
required :
- epsBearerId
- arp
SmContextCreateError :
type : object
properties :
error :
2021-03-08 12:25:09 +00:00
$ref : '#/components/schemas/ExtProblemDetails'
2020-06-17 05:22:28 +00:00
n1SmMsg :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
2021-03-08 12:25:09 +00:00
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
2020-06-17 05:22:28 +00:00
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required :
- error
SmContextUpdateError :
type : object
properties :
error :
2021-03-08 12:25:09 +00:00
$ref : '#/components/schemas/ExtProblemDetails'
2020-06-17 05:22:28 +00:00
n1SmMsg :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n2SmInfoType :
$ref : '#/components/schemas/N2SmInfoType'
upCnxState :
$ref : '#/components/schemas/UpCnxState'
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required :
- error
PduSessionCreateError :
type : object
properties :
error :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
n1smCause :
type : string
pattern : '^[A-F0-9]{2}$'
n1SmInfoToUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
backOffTimer :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required :
- error
HsmfUpdateError :
type : object
properties :
error :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
pti :
$ref : '#/components/schemas/ProcedureTransactionId'
n1smCause :
type : string
pattern : '^[A-F0-9]{2}$'
n1SmInfoToUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
backOffTimer :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required :
- error
VsmfUpdateError :
type : object
properties :
error :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
pti :
$ref : '#/components/schemas/ProcedureTransactionId'
n1smCause :
type : string
pattern : '^[A-F0-9]{2}$'
n1SmInfoFromUe :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
unknownN1SmInfo :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
failedToAssignEbiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Arp'
minItems : 1
ngApCause :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NgApCause'
5gMmCauseValue :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5GMmCause'
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
n4Info :
$ref : '#/components/schemas/N4Information'
n4InfoExt1 :
$ref : '#/components/schemas/N4Information'
n4InfoExt2 :
2021-03-08 12:25:09 +00:00
$ref : '#/components/schemas/N4Information'
2020-06-17 05:22:28 +00:00
required :
- error
SmContext :
type : object
properties :
pduSessionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
dnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
2021-07-07 08:32:55 +00:00
selectedDnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
2020-06-17 05:22:28 +00:00
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
hplmnSnssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
pduSessionType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
gpsi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
hSmfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
smfUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
pduSessionRef :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
pcfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
pcfGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
pcfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
selMode :
$ref : '#/components/schemas/DnnSelectionMode'
udmGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
routingIndicator :
type : string
sessionAmbr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ambr'
qosFlowsList :
type : array
items :
$ref : '#/components/schemas/QosFlowSetupItem'
minItems : 1
hSmfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2021-03-08 12:25:09 +00:00
pduSessionSmfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
pduSessionSmfServiceSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId'
pduSessionSmfBinding :
$ref : 'TS29518_Namf_Communication.yaml#/components/schemas/SbiBindingLevel'
2020-06-17 05:22:28 +00:00
enablePauseCharging :
type : boolean
default : false
ueIpv4Address :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ueIpv6Prefix :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
epsPdnCnxInfo :
$ref : '#/components/schemas/EpsPdnCnxInfo'
epsBearerInfo :
type : array
items :
$ref : '#/components/schemas/EpsBearerInfo'
minItems : 1
maxIntegrityProtectedDataRate :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
alwaysOnGranted :
type : boolean
default : false
upSecurity :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UpSecurity'
hSmfServiceInstanceId :
type : string
smfServiceInstanceId :
type : string
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
forwardingInd :
type : boolean
default : false
psaTunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
2021-07-07 08:32:55 +00:00
chargingId :
2020-06-17 05:22:28 +00:00
type : string
chargingInfo :
$ref : 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation'
roamingChargingProfile :
$ref : 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile'
nefExtBufSupportInd :
type : boolean
default : false
2021-03-08 12:25:09 +00:00
ipv6Index :
$ref : 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex'
dnAaaAddress :
$ref : '#/components/schemas/IpAddress'
2021-07-07 08:32:55 +00:00
redundantPduSessionInfo :
$ref : '#/components/schemas/RedundantPduSessionInformation'
ranTunnelInfo :
$ref : '#/components/schemas/QosFlowTunnel'
addRanTunnelInfo :
type : array
items :
$ref : '#/components/schemas/QosFlowTunnel'
minItems : 1
redRanTunnelInfo :
$ref : '#/components/schemas/QosFlowTunnel'
addRedRanTunnelInfo :
type : array
items :
$ref : '#/components/schemas/QosFlowTunnel'
minItems : 1
2020-06-17 05:22:28 +00:00
required :
- pduSessionId
- dnn
- sNssai
- pduSessionType
- sessionAmbr
- qosFlowsList
ExemptionInd :
type : object
properties :
dnnCongestion :
type : boolean
default : false
snssaiOnlyCongestion :
type : boolean
default : false
snssaiDnnCongestion :
type : boolean
default : false
PsaInformation :
type : object
properties :
psaInd :
$ref : '#/components/schemas/PsaIndication'
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems : 1
ueIpv6Prefix :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
psaUpfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
DnaiInformation :
type : object
properties :
dnai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
noDnaiChangeInd :
type : boolean
noLocalPsaChangeInd :
type : boolean
required :
- dnai
N4Information :
type : object
properties :
n4MessageType :
$ref : '#/components/schemas/N4MessageType'
n4MessagePayload :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
n4DnaiInfo :
$ref : '#/components/schemas/DnaiInformation'
required :
- n4MessageType
- n4MessagePayload
IndirectDataForwardingTunnelInfo :
type : object
properties :
ipv4Addr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
gtpTeid :
$ref : '#/components/schemas/Teid'
drbId :
$ref : '#/components/schemas/DrbId'
2021-03-08 12:25:09 +00:00
additionalTnlNb :
2020-06-17 05:22:28 +00:00
$ref : '#/components/schemas/AdditionalTnlNb'
required :
- gtpTeid
not :
required : [ drbId, additionalTnlNb ]
SendMoDataReqData :
type : object
properties :
moData :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
moExpDataCounter :
$ref : 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
required :
- moData
CnAssistedRanPara :
type : object
properties :
stationaryIndication :
$ref : 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication'
communicationDurationTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
periodicTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
scheduledCommunicationTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
scheduledCommunicationType :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationType'
trafficProfile :
$ref : 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile'
batteryIndication :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication'
UlclBpInformation :
type : object
properties :
ulclBpUpfId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
TransferMoDataReqData :
type : object
properties :
moData :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
moExpDataCounter :
$ref : 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter'
ueLocation :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
required :
- moData
TransferMtDataReqData :
type : object
properties :
mtData :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
required :
- mtData
TransferMtDataError :
allOf :
- $ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref : '#/components/schemas/TransferMtDataAddInfo'
TransferMtDataAddInfo :
type : object
properties :
maxWaitingTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
VplmnQos :
type : object
properties :
5qi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/5Qi'
arp :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Arp'
sessionAmbr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ambr'
maxFbrDl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxFbrUl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
guaFbrDl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
guaFbrUl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
DdnFailureSubs :
type : object
properties :
ddnFailureSubsInd :
type : boolean
default : false
2021-03-08 12:25:09 +00:00
ddnFailureSubsInfoList :
type : array
items :
$ref : '#/components/schemas/DdnFailureSubInfo'
minItems : 1
DdnFailureSubInfo :
type : object
required :
- notifyCorrelationId
properties :
notifyCorrelationId :
type : string
2020-06-17 05:22:28 +00:00
dddTrafficDescriptorList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor'
minItems : 1
2021-03-08 12:25:09 +00:00
RetrieveData :
type : object
properties :
smallDataRateStatusReq :
type : boolean
default : false
RetrievedData :
type : object
properties :
smallDataRateStatus :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus'
SecurityResult :
type : object
properties :
integrityProtectionResult :
$ref : '#/components/schemas/ProtectionResult'
confidentialityProtectionResult :
$ref : '#/components/schemas/ProtectionResult'
UpSecurityInfo :
type : object
properties :
upSecurity :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UpSecurity'
maxIntegrityProtectedDataRateUl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
maxIntegrityProtectedDataRateDl :
$ref : '#/components/schemas/MaxIntegrityProtectedDataRate'
securityResult :
$ref : '#/components/schemas/SecurityResult'
required :
- upSecurity
AlternativeQosProfile :
type : object
properties :
index :
type : integer
minimum : 1
maximum : 8
guaFbrDl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
guaFbrUl :
$ref : 'TS29571_CommonData.yaml#/components/schemas/BitRate'
packetDelayBudget :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
packetErrRate :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
required :
- index
ExtProblemDetails :
allOf :
- $ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref : '#/components/schemas/ProblemDetailsAddInfo'
ProblemDetailsAddInfo :
type : object
properties :
remoteError :
type : boolean
QosMonitoringInfo :
type : object
properties :
qosMonitoringInd :
type : boolean
default : false
IpAddress :
type : object
oneOf :
- required :
- ipv4Addr
- required :
- ipv6Addr
- required :
- ipv6Prefix
properties :
ipv4Addr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
ipv6Prefix :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
2021-07-07 08:32:55 +00:00
RedundantPduSessionInformation :
description : Redundant PDU Session Information
type : object
properties :
rsn :
$ref : '#/components/schemas/Rsn'
required :
- rsn
QosFlowTunnel :
description : Tunnel Information per QoS Flow
type : object
properties :
qfiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Qfi'
minItems : 1
tunnelInfo :
$ref : '#/components/schemas/TunnelInfo'
required :
- qfiList
- tunnelInfo
2021-03-08 12:25:09 +00:00
2020-06-17 05:22:28 +00:00
#
# SIMPLE DATA TYPES
#
ProcedureTransactionId :
type : integer
minimum : 0
maximum : 255
EpsBearerId :
type : integer
minimum : 0
maximum : 15
EpsPdnCnxContainer :
type : string
EpsBearerContainer :
type : string
Teid :
type : string
2021-03-08 12:25:09 +00:00
pattern : '^[A-Fa-f0-9]{8}$'
2020-06-17 05:22:28 +00:00
EpsBearerContextStatus :
type : string
pattern : '^[A-Fa-f0-9]{4}$'
DrbId :
type : integer
minimum : 1
maximum : 32
AdditionalTnlNb :
type : integer
minimum : 1
maximum : 3
ForwardingBearerContainer :
type : string
#
# ENUMERATIONS
#
UpCnxState :
anyOf :
- type : string
enum :
- ACTIVATED
- DEACTIVATED
- ACTIVATING
- SUSPENDED
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- ACTIVATED
- DEACTIVATED
- ACTIVATING
- SUSPENDED
HoState :
anyOf :
- type : string
enum :
- NONE
- PREPARING
- PREPARED
- COMPLETED
- CANCELLED
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- NONE
- PREPARING
- PREPARED
- COMPLETED
- CANCELLED
RequestType :
anyOf :
- type : string
enum :
- INITIAL_REQUEST
- EXISTING_PDU_SESSION
- INITIAL_EMERGENCY_REQUEST
- EXISTING_EMERGENCY_PDU_SESSION
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- INITIAL_REQUEST
- EXISTING_PDU_SESSION
- INITIAL_EMERGENCY_REQUEST
- EXISTING_EMERGENCY_PDU_SESSION
RequestIndication :
anyOf :
- type : string
enum :
- UE_REQ_PDU_SES_MOD
- UE_REQ_PDU_SES_REL
- PDU_SES_MOB
- NW_REQ_PDU_SES_AUTH
- NW_REQ_PDU_SES_MOD
- NW_REQ_PDU_SES_REL
- EBI_ASSIGNMENT_REQ
2021-03-08 12:25:09 +00:00
- REL_DUE_TO_5G_AN_REQUEST
2020-06-17 05:22:28 +00:00
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- UE_REQ_PDU_SES_MOD
- UE_REQ_PDU_SES_REL
- PDU_SES_MOB
- NW_REQ_PDU_SES_AUTH
- NW_REQ_PDU_SES_MOD
- NW_REQ_PDU_SES_REL
- EBI_ASSIGNMENT_REQ
2021-03-08 12:25:09 +00:00
- REL_DUE_TO_5G_AN_REQUEST
2020-06-17 05:22:28 +00:00
NotificationCause :
anyOf :
- type : string
enum :
- QOS_FULFILLED
- QOS_NOT_FULFILLED
- UP_SEC_FULFILLED
- UP_SEC_NOT_FULFILLED
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- QOS_FULFILLED
- QOS_NOT_FULFILLED
- UP_SEC_FULFILLED
- UP_SEC_NOT_FULFILLED
Cause :
anyOf :
- type : string
enum :
- REL_DUE_TO_HO
- EPS_FALLBACK
- REL_DUE_TO_UP_SEC
- DNN_CONGESTION
- S_NSSAI_CONGESTION
- REL_DUE_TO_REACTIVATION
- 5G_AN_NOT_RESPONDING
- REL_DUE_TO_SLICE_NOT_AVAILABLE
- REL_DUE_TO_DUPLICATE_SESSION_ID
- PDU_SESSION_STATUS_MISMATCH
- HO_FAILURE
- INSUFFICIENT_UP_RESOURCES
- PDU_SESSION_HANDED_OVER
- PDU_SESSION_RESUMED
- CN_ASSISTED_RAN_PARAMETER_TUNING
- ISMF_CONTEXT_TRANSFER
- SMF_CONTEXT_TRANSFER
- REL_DUE_TO_PS_TO_CS_HO
- REL_DUE_TO_SUBSCRIPTION_CHANGE
- HO_CANCEL
- REL_DUE_TO_SLICE_NOT_AUTHORIZED
- PDU_SESSION_HAND_OVER_FAILURE
- DDN_FAILURE_STATUS
2021-03-08 12:25:09 +00:00
- REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
- NOT_SUPPORTED_WITH_ISMF
2021-07-07 08:32:55 +00:00
- CHANGED_ANCHOR_SMF
- CHANGED_INTERMEDIATE_SMF
2020-06-17 05:22:28 +00:00
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- REL_DUE_TO_HO
- EPS_FALLBACK
- REL_DUE_TO_UP_SEC
- DNN_CONGESTION
- S_NSSAI_CONGESTION
- REL_DUE_TO_REACTIVATION
- 5G_AN_NOT_RESPONDING
- REL_DUE_TO_SLICE_NOT_AVAILABLE
- REL_DUE_TO_DUPLICATE_SESSION_ID
- PDU_SESSION_STATUS_MISMATCH
- HO_FAILURE
- INSUFFICIENT_UP_RESOURCES
- PDU_SESSION_HANDED_OVER
- PDU_SESSION_RESUMED
- CN_ASSISTED_RAN_PARAMETER_TUNING
- ISMF_CONTEXT_TRANSFER
- SMF_CONTEXT_TRANSFER
- REL_DUE_TO_PS_TO_CS_HO
- REL_DUE_TO_SUBSCRIPTION_CHANGE
- HO_CANCEL
- REL_DUE_TO_SLICE_NOT_AUTHORIZED
- PDU_SESSION_HAND_OVER_FAILURE
- DDN_FAILURE_STATUS
2021-03-08 12:25:09 +00:00
- REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
- NOT_SUPPORTED_WITH_ISMF
2021-07-07 08:32:55 +00:00
- CHANGED_ANCHOR_SMF
- CHANGED_INTERMEDIATE_SMF
2020-06-17 05:22:28 +00:00
ResourceStatus :
anyOf :
- type : string
enum :
- RELEASED
- UNCHANGED
- TRANSFERRED
- UPDATED
2021-07-07 08:32:55 +00:00
- ALT_ANCHOR_SMF
2020-06-17 05:22:28 +00:00
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- RELEASED
- UNCHANGED
2021-07-07 08:32:55 +00:00
- TRANSFERRED
2020-06-17 05:22:28 +00:00
- UPDATED
2021-07-07 08:32:55 +00:00
- ALT_ANCHOR_SMF
2020-06-17 05:22:28 +00:00
DnnSelectionMode :
anyOf :
- type : string
enum :
- VERIFIED
- UE_DNN_NOT_VERIFIED
- NW_DNN_NOT_VERIFIED
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- VERIFIED
- UE_DNN_NOT_VERIFIED
- NW_DNN_NOT_VERIFIED
EpsInterworkingIndication :
anyOf :
- type : string
enum :
- NONE
- WITH_N26
- WITHOUT_N26
- IWK_NON_3GPP
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- NONE
- WITH_N26
- WITHOUT_N26
- IWK_NON_3GPP
N2SmInfoType :
anyOf :
- type : string
enum :
- PDU_RES_SETUP_REQ
- PDU_RES_SETUP_RSP
- PDU_RES_SETUP_FAIL
- PDU_RES_REL_CMD
- PDU_RES_REL_RSP
- PDU_RES_MOD_REQ
- PDU_RES_MOD_RSP
- PDU_RES_MOD_FAIL
- PDU_RES_NTY
- PDU_RES_NTY_REL
- PDU_RES_MOD_IND
- PDU_RES_MOD_CFM
- PATH_SWITCH_REQ
- PATH_SWITCH_SETUP_FAIL
- PATH_SWITCH_REQ_ACK
- PATH_SWITCH_REQ_FAIL
- HANDOVER_REQUIRED
- HANDOVER_CMD
- HANDOVER_PREP_FAIL
- HANDOVER_REQ_ACK
- HANDOVER_RES_ALLOC_FAIL
- SECONDARY_RAT_USAGE
2021-03-08 12:25:09 +00:00
- PDU_RES_MOD_IND_FAIL
2020-06-17 05:22:28 +00:00
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- PDU_RES_SETUP_REQ
- PDU_RES_SETUP_RSP
- PDU_RES_SETUP_FAIL
- PDU_RES_REL_CMD
- PDU_RES_REL_RSP
- PDU_RES_MOD_REQ
- PDU_RES_MOD_RSP
- PDU_RES_MOD_FAIL
- PDU_RES_NTY
- PDU_RES_NTY_REL
- PDU_RES_MOD_IND
- PDU_RES_MOD_CFM
- PATH_SWITCH_REQ
- PATH_SWITCH_SETUP_FAIL
- PATH_SWITCH_REQ_ACK
- PATH_SWITCH_REQ_FAIL
- HANDOVER_REQUIRED
- HANDOVER_CMD
- HANDOVER_PREP_FAIL
- HANDOVER_REQ_ACK
- HANDOVER_RES_ALLOC_FAIL
- SECONDARY_RAT_USAGE
2021-03-08 12:25:09 +00:00
- PDU_RES_MOD_IND_FAIL
2020-06-17 05:22:28 +00:00
MaxIntegrityProtectedDataRate :
anyOf :
- type : string
enum :
- 64_KBPS
- MAX_UE_RATE
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- 64_KBPS
- MAX_UE_RATE
MaReleaseIndication :
anyOf :
- type : string
enum :
- REL_MAPDU_OVER_3GPP
- REL_MAPDU_OVER_N3GPP
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- REL_MAPDU_OVER_3GPP
- REL_MAPDU_OVER_N3GPP
SmContextType :
anyOf :
- type : string
enum :
- EPS_PDN_CONNECTION
- SM_CONTEXT
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- EPS_PDN_CONNECTION
- SM_CONTEXT
PsaIndication :
anyOf :
- type : string
enum :
- PSA_INSERTED
- PSA_REMOVED
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- PSA_INSERTED
- PSA_REMOVED
N4MessageType :
anyOf :
- type : string
enum :
- PFCP_SES_EST_REQ
- PFCP_SES_EST_RSP
- PFCP_SES_MOD_REQ
- PFCP_SES_MOD_RSP
- PFCP_SES_DEL_REQ
- PFCP_SES_DEL_RSP
- PFCP_SES_REP_REQ
- PFCP_SES_REP_RSP
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- PFCP_SES_EST_REQ
- PFCP_SES_EST_RSP
- PFCP_SES_MOD_REQ
- PFCP_SES_MOD_RSP
- PFCP_SES_DEL_REQ
- PFCP_SES_DEL_RSP
- PFCP_SES_REP_REQ
- PFCP_SES_REP_RSP
QosFlowAccessType :
anyOf :
- type : string
enum :
- 3GPP
- NON_3GPP
- 3GPP_AND_NON_3GPP
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- 3GPP
- NON_3GPP
- 3GPP_AND_NON_3GPP
UnavailableAccessIndication :
anyOf :
- type : string
enum :
- 3GA_UNAVAILABLE
- N3GA_UNAVAILABLE
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- 3GA_UNAVAILABLE
- N3GA_UNAVAILABLE
2021-03-08 12:25:09 +00:00
ProtectionResult :
anyOf :
- type : string
enum :
- PERFORMED
- NOT_PERFORMED
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- PERFORMED
- NOT_PERFORMED
QosMonitoringReq :
anyOf :
- type : string
enum :
- UL
- DL
- BOTH
- NONE
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Possible values are
- UL
- DL
- BOTH
- NONE
2021-07-07 08:32:55 +00:00
Rsn :
anyOf :
- type : string
enum :
- V1
- V2
- type : string
description : >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description : >
Redundancy Sequence Number. Possible values are
- V1
- V2
2020-06-17 05:22:28 +00:00
#
# HTTP request bodies
#
requestBodies :
'VsmfUpdateRequestBody' :
description : representation of updates to apply to the PDU session
required : true
content :
application/+json : # message without binary body part
schema :
$ref : '#/components/schemas/VsmfUpdateData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/VsmfUpdateData'
binaryDataN1SmInfoToUe :
type : string
format : binary
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoToUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
2021-03-08 12:25:09 +00:00
type : string
2020-06-17 05:22:28 +00:00
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
'NotifyStatusRequestBody' :
description : representation of the status notification
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/StatusNotification'
#
# HTTP responses
#
responses :
'VsmfUpdateResponse200' :
description : successful update of a PDU session with content in the response
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/VsmfUpdatedData'
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/VsmfUpdatedData'
binaryDataN1SmInfoFromUe :
type : string
format : binary
binaryDataUnknownN1SmInfo :
type : string
format : binary
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoFromUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataUnknownN1SmInfo :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
2021-03-08 12:25:09 +00:00
type : string
2020-06-17 05:22:28 +00:00
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
'PduSessionCreateError' :
description : unsuccessful creation of a PDU session
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/PduSessionCreateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/PduSessionCreateError'
binaryDataN1SmInfoToUe :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoToUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
'HsmfUpdateError' :
description : unsuccessful update of a PDU session
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/HsmfUpdateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/HsmfUpdateError'
binaryDataN1SmInfoToUe :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoToUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
'VsmfUpdateError' :
description : unsuccessful update of a PDU session
content :
application/json : # message without binary body part
schema :
$ref : '#/components/schemas/VsmfUpdateError'
2021-07-07 08:32:55 +00:00
application/problem+json :
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
2020-06-17 05:22:28 +00:00
multipart/related : # message with binary body part(s)
schema :
type : object
properties : # Request parts
jsonData :
$ref : '#/components/schemas/VsmfUpdateError'
binaryDataN1SmInfoFromUe :
type : string
format : binary
binaryDataUnknownN1SmInfo :
type : string
format : binary
binaryDataN4Information :
type : string
format : binary
binaryDataN4InformationExt1 :
type : string
format : binary
binaryDataN4InformationExt2 :
type : string
format : binary
encoding :
jsonData :
contentType : application/json
binaryDataN1SmInfoFromUe :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataUnknownN1SmInfo :
contentType : application/vnd.3gpp.5gnas
headers :
Content-Id :
schema :
type : string
binaryDataN4Information :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt1 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
binaryDataN4InformationExt2 :
contentType : application/vnd.3gpp.pfcp
headers :
Content-Id :
schema :
type : string
2021-03-08 12:25:09 +00:00
'400' :
description : Bad request
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'401' :
description : Unauthorized
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'403' :
description : Forbidden
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'404' :
description : Not Found
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'413' :
description : Payload Too Large
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'415' :
description : Unsupported Media Type
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'429' :
description : Too Many Requests
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'500' :
description : Internal Server Error
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'
'503' :
description : Service Unavailable
content :
application/problem+json :
schema :
$ref : '#/components/schemas/ExtProblemDetails'