Nsmf_PDUSession

SMF PDU Session Service.

OpenAPI

OpenAPI Version: 3.0.0

info

Version: '1.0.0'

Title: 'Nsmf_PDUSession'

Description: 'SMF PDU Session Service'

externalDocs

Description: 3GPP TS 29.502 V15.2.1; 5G System; Session Management Services; Stage 3

URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.502/

security

- {}

- oAuth2Clientcredentials:

- nsmf-pdusession

servers

URL: '{apiRoot}/nsmf-pdusession/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 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.

paths

/sm-contexts

Method: Post

Summary: Create SM Context

Tags:

- SM contexts collection

Operation ID: PostSmContexts

Request Body:

Description: representation of the SM context to be created in the SMF

Required/Optional: true

Content:

Multipart/Related:

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateData'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

Callbacks:

smContextStatusNotification:

'{$request.body#/smContextStatusUri}':

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmContextStatusNotification'

Responses:

'204' successful notification

'307' temporary redirect

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

Responses:

'201' successful creation of an SM context

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreatedData'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreatedData'

binaryDataN2SmInformation:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN2SmInformation:

Content Type: 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/v1/sm-contexts/{smContextRef}'

Required/Optional: true

Schema:

Type: string

'307' temporary redirect

'308' permanent redirect

'400' unsuccessful creation of an SM context - bad request

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreateError'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateError'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

'403' unsuccessful creation of an SM context - forbidden

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreateError'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateError'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

'404' unsuccessful creation of an SM context - not found

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreateError'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateError'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500' unsuccessful creation of an SM context - internal server error

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreateError'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateError'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

'503' unsuccessful creation of an SM context - service unavailable

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreateError'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateError'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

'504' unsuccessful creation of an SM context - gateway timeout

Content:

Application/JSON: # message without binary body part

Schema:

Reference: '#/components/schemas/SmContextCreateError'

Multipart/Related: # message with binary body part(s)

Schema:

Type: object

Properties: # Request parts

JSON Data:

Reference: '#/components/schemas/SmContextCreateError'

binaryDataN1SmMessage:

Type: string

Format: binary

Encoding:

JSON Data:

Content Type: application/json

binaryDataN1SmMessage:

Content Type: application/vnd.3gpp.5gnas

Headers:

Content ID:

Schema:

Type: string

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

/sm-contexts/{smContextRef}/retrieve

Method: Post

Summary: Retrieve SM Context

Tags:

- Individual SM context

Operation ID: RetrieveSmContext

Parameters:

- name: smContextRef

In: path

Description: SM context reference

Required/Optional: true

Schema:

Type: string

Request Body:

Description: parameters used to retrieve the SM context

Required/Optional: false

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmContextRetrieveData'

Responses:

'200' successful retrieval of an SM context

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmContextRetrievedData'