ueId registrations amf 3gpp access
put:
Summary: register as AMF for 3GPP access
Operation ID: Registration
Tags:
- AMF registration for 3GPP access
Parameters:
- name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
Required/Optional: true
Responses:
'201' Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-3gpp-access'
Required/Optional: true
Schema:
Type: string
'200' OK
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
'204' 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' 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' 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
patch:
Summary: Update a parameter in the AMF registration for 3GPP access
Operation ID: Update
Tags:
- Parameter update in the AMF registration for 3GPP access
Parameters:
- name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
application/merge-patch+json:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistrationModification'
Required/Optional: true
Responses:
'204' Expected response to a valid request
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'
'422' 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: retrieve the AMF registration for 3GPP access information
Operation ID: Get
Tags:
- AMF 3Gpp-access Registration Info Retrieval
Parameters:
- name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
- name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200' Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
'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