put:
Summary: register as SMF
Operation ID: Registration
Tags:
- SMF SmfRegistration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: pduSessionId
In: path
Description: Identifier of the PDU session
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
Required/Optional: true
Responses:
'201':
Description: Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations/{pduSessionId}'
Required/Optional: true
Schema:
Type: string
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Callbacks:
deregistrationeNotification:
'{request.body#/deregCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/DeregistrationData'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
pcscfRestorationNotification:
'{request.body#/pcscfRestorationCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/PcscfRestorationNotification'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
delete:
Summary: delete an SMF registration
Operation ID: SmfDeregistration
Tags:
- SMF Deregistration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: pduSessionId
In: path
Description: Identifier of the PDU session
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
- Name: smf-set-id
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
Responses:
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'422':
Description: Unprocessable Request
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: get an SMF registration
Operation ID: RetrieveSmfRegistration
Tags:
- Retrieve SMF Registration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: pduSessionId
In: path
Description: Identifier of the PDU session
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error