{ "openapi":"3.0.0", "info":{ "title":"REST API Reference for Elastic Charging Engine", "version":"2026.10.12", "description":"The REST API for Elastic Charging Engine (ECE) supports the following:

Caution: Deploying charging for 5G with HTTP Gateway (5G CHF) requires a cloud native deployment of ECE and BRM components. The ECE REST API can be used only on an ECE cloud native system.", "x-summary":"The REST API for Elastic Charging Engine (ECE) supports the following: Nchf Converged Charging Performs converged online and offline charging for session-based and event-based Network Function (NF) services." }, "externalDocs":{ "description":"3GPP TS 32.291 V17.0.0: Telecommunication management; Charging management; 5G system, charging service; Stage 3.\n", "url":"http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/" }, "security":[ { }, { "oAuth2ClientCredentials":[ "nchf-offlineonlycharging" ] }, { "oAuth2ClientCredentials":[ "nchf-spendinglimitcontrol" ] }, { "oAuth2ClientCredentials":[ "nchf-convergedcharging" ] } ], "paths":{ "{apiRoot}/nchf-offlineonlycharging/v1/offlinechargingdata":{ "post":{ "summary":"Create Resource for Offline-Only Charging", "description":"Creates a request to start offline-only charging.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataRequest" } } } }, "responses":{ "201":{ "description":"The resource was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataResponse" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "410":{ "$ref":"#/components/responses/410" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Offline-Only Charging" ], "x-internal-id":"{apiRoot}-nchf-offlineonlycharging-v1-offlinechargingdata-post", "x-filename-id":"apiroot-nchf-offlineonlycharging-v1-offlinechargingdata-post" } }, "{apiRoot}/nchf-offlineonlycharging/v1/offlinechargingdata/{OfflineChargingDataRef}/update":{ "post":{ "summary":"Update Offline-Only Charging Resource", "description":"Updates the specified offline-only charging resource.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataRequest" } } } }, "parameters":[ { "name":"OfflineChargingDataRef", "in":"path", "description":"The unique identifier for a charging data resource in a PLMN.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The charging data resource was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataResponse" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "410":{ "$ref":"#/components/responses/410" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Offline-Only Charging" ], "x-internal-id":"{apiRoot}-nchf-offlineonlycharging-v1-offlinechargingdata-{OfflineChargingDataRef}-update-post", "x-filename-id":"apiroot-nchf-offlineonlycharging-v1-offlinechargingdata-offlinechargingdataref-update-post" } }, "{apiRoot}/nchf-offlineonlycharging/v1/offlinechargingdata/{OfflineChargingDataRef}/release":{ "post":{ "summary":"End an Offline-Only Charging Session", "description":"Ends an offline-only data charging session.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataRequest" } } } }, "parameters":[ { "name":"OfflineChargingDataRef", "in":"path", "description":"A unique identifier for a charging data resource in a PLMN.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The data charging session was ended successfully." }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "410":{ "$ref":"#/components/responses/410" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Offline-Only Charging" ], "x-internal-id":"{apiRoot}-nchf-offlineonlycharging-v1-offlinechargingdata-{OfflineChargingDataRef}-release-post", "x-filename-id":"apiroot-nchf-offlineonlycharging-v1-offlinechargingdata-offlinechargingdataref-release-post" } }, "{apiRoot}/queryUsageConsumption":{ "get":{ "summary":"Get Usage Consumption Objects", "description":"Gets all usage consumption objects.", "operationId":"listQueryUsageConsumption", "parameters":[ { "name":"fields", "in":"query", "description":"A comma-separated list of fields to include in the response.", "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"The usage consumption objects were returned successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of results.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The actual number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/QueryUsageConsumption" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The server couldn't find the requested object.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method isn't supported for the requested resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request couldn't be processed due to conflict. An item already exists.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "tags":[ "Usage Consumption" ], "x-internal-id":"{apiRoot}-queryUsageConsumption-get", "x-filename-id":"apiroot-queryusageconsumption-get" }, "post":{ "summary":"Create a Usage Consumption Object", "description":"Creates a usage consumption object.", "operationId":"createQueryUsageConsumption", "requestBody":{ "description":"Information about the usage consumption object to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/QueryUsageConsumption_Create" } } }, "required":true }, "responses":{ "201":{ "description":"The usage consumption object was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/QueryUsageConsumption" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This request method isn't supported for the requested resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request couldn't be processed due to a conflict. An item already exists.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"queryUsageConsumption", "tags":[ "Usage Consumption" ], "x-internal-id":"{apiRoot}-queryUsageConsumption-post", "x-filename-id":"apiroot-queryusageconsumption-post" } }, "{apiRoot}/queryUsageConsumption/{id}":{ "get":{ "summary":"Get a Usage Consumption Object by ID", "description":"Gets the usage consumption object with the specified ID. Attribute selection is enabled for all first-level attributes.", "operationId":"retrieveQueryUsageConsumption", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the usage consumption object.", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"A comma-separated list of fields to return in the response.", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The usage consumption object was returned successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/QueryUsageConsumption" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The server couldn't find the requested object.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method isn't supported for the requested resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request couldn't be processed due to a conflict. An item already exists.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "tags":[ "Usage Consumption" ], "x-internal-id":"{apiRoot}-queryUsageConsumption-{id}-get", "x-filename-id":"apiroot-queryusageconsumption-id-get" }, "delete":{ "summary":"Delete a Usage Consumption Object", "description":"Deletes the usage consumption object specified by the ID.", "operationId":"deleteQueryUsageConsumption", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the usage consumption object.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The usage consumption object was deleted successfully.", "content":{ } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The server couldn't find the requested object.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method isn't supported for the requested resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request couldn't be processed due to a conflict. An item already exists.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "tags":[ "Usage Consumption" ], "x-internal-id":"{apiRoot}-queryUsageConsumption-{id}-delete", "x-filename-id":"apiroot-queryusageconsumption-id-delete" } }, "{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions":{ "post":{ "summary":"Create a Spending Limit Control Subscription", "description":"Creates a new spending limit retrieval subscription for a specified subscriber.", "requestBody":{ "required":true, "description":"Details about the spending limit control subscription to create.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SpendingLimitContext" } } } }, "responses":{ "201":{ "description":"The resource was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SpendingLimitStatus" } } }, "headers":{ "Location":{ "description":"Contains the URI of the created individual spending limit resource, according to the structure. {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}\n", "required":true, "schema":{ "type":"string" } } } }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "415":{ "$ref":"#/components/responses/415" }, "429":{ "$ref":"#/components/responses/429" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "callbacks":{ "statusNotification":{ "{$request.body#/notifUri}/notify":{ "post":{ "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SpendingLimitStatus" } } } }, "responses":{ "204":{ "description":"The charging notification was created successfully." }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "415":{ "$ref":"#/components/responses/415" }, "429":{ "$ref":"#/components/responses/429" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "x-internal-id":"{apiRoot}-nchf-spendinglimitcontrol-v1-subscriptions-post-cb-statusNotification", "x-filename-id":"apiroot-nchf-spendinglimitcontrol-v1-subscriptions-cb-statusnotification", "summary":"statusNotification Callback" } } }, "subscriptionTermination":{ "{$request.body#/notifUri}/terminate":{ "post":{ "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SubscriptionTerminationInfo" } } } }, "responses":{ "204":{ "description":"The spending limit notification was created successfully." }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "415":{ "$ref":"#/components/responses/415" }, "429":{ "$ref":"#/components/responses/429" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "x-internal-id":"{apiRoot}-nchf-spendinglimitcontrol-v1-subscriptions-post-cb-subscriptionTermination", "x-filename-id":"apiroot-nchf-spendinglimitcontrol-v1-subscriptions-cb-subscriptiontermination", "summary":"subscriptionTermination Callback" } } } }, "tags":[ "Nchf Spending Limit Control" ], "x-internal-id":"{apiRoot}-nchf-spendinglimitcontrol-v1-subscriptions-post", "x-filename-id":"apiroot-nchf-spendinglimitcontrol-v1-subscriptions-post" } }, "{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}":{ "parameters":[ { "in":"path", "name":"subscriptionId", "description":"Identifies an individual spending limit retrieval subscription.", "required":true, "schema":{ "type":"string" } } ], "put":{ "summary":"Update a Spending Limit Control Subscription", "description":"Updates an existing spending limit subscription for a specified subscriber. For example, you could add policy counters.", "requestBody":{ "required":true, "description":"Information about the updates to make.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SpendingLimitContext" } } } }, "responses":{ "200":{ "description":"The spending limit control subscription was successfully updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SpendingLimitStatus" } } } }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "415":{ "$ref":"#/components/responses/415" }, "429":{ "$ref":"#/components/responses/429" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Spending Limit Control" ], "x-internal-id":"{apiRoot}-nchf-spendinglimitcontrol-v1-subscriptions-{subscriptionId}-put", "x-filename-id":"apiroot-nchf-spendinglimitcontrol-v1-subscriptions-subscriptionid-put" }, "delete":{ "summary":"End a Spending Limit Control Subscription", "description":"Ends an existing spending limit control subscription for a specified subscriber.", "responses":{ "204":{ "description":"The spending limit control subscription was ended succesfully." }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "400":{ "$ref":"#/components/responses/400" }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "$ref":"#/components/responses/403" }, "404":{ "$ref":"#/components/responses/404" }, "429":{ "$ref":"#/components/responses/429" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Spending Limit Control" ], "x-internal-id":"{apiRoot}-nchf-spendinglimitcontrol-v1-subscriptions-{subscriptionId}-delete", "x-filename-id":"apiroot-nchf-spendinglimitcontrol-v1-subscriptions-subscriptionid-delete" } }, "{apiRoot}/nchf-convergedcharging/v3/chargingdata":{ "post":{ "summary":"Create a Converged Charging Session", "description":"Creates an Nchf converged charging session and reserves an initial quota of service, such as 20 USD or 2 GB of data, for a subscriber.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataRequest" } } } }, "responses":{ "201":{ "description":"The converged charging session was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataResponse" } } } }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "400":{ "description":"The request isn't valid.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "405":{ "$ref":"#/components/responses/405" }, "408":{ "$ref":"#/components/responses/408" }, "410":{ "$ref":"#/components/responses/410" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Converged Charging" ], "x-internal-id":"{apiRoot}-nchf-convergedcharging-v3-chargingdata-post", "x-filename-id":"apiroot-nchf-convergedcharging-v3-chargingdata-post" } }, "{apiRoot}/nchf-convergedcharging/v3/{$request.body#/notifyUri}":{ "post":{ "summary":"Converged Charging Notification", "description":"Notifies the NF that one of the following is required:

", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingNotifyRequest" } } } }, "parameters":[ { "name":"$request.body#/notifyUri", "in":"path", "description":"The notification URI (notifyUri field) provided in the Create a Converged Charging Session request body.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The charging notification was created successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Converged Charging" ], "x-internal-id":"{apiRoot}-nchf-convergedcharging-v3-{$request.body#-notifyUri}-post", "x-filename-id":"apiroot-nchf-convergedcharging-v3-request-body-notifyuri-post" } }, "{apiRoot}/nchf-convergedcharging/v3/chargingdata/{ChargingDataRef}/update":{ "post":{ "summary":"Update a Converged Charging Session", "description":"Reserves additional units for an existing converged charging session.

You may need to reserve additional units for an existing Nchf converged charging session when:

", "requestBody":{ "description":"Details about the addition units to reserve.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataRequest" } } } }, "parameters":[ { "name":"ChargingDataRef", "in":"path", "description":"A unique ID for a charging data resource within a PLMN.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The converged charging session was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataResponse" } } } }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "400":{ "description":"The request isn't valid.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "401":{ "$ref":"#/components/responses/401" }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "405":{ "$ref":"#/components/responses/405" }, "408":{ "$ref":"#/components/responses/408" }, "410":{ "$ref":"#/components/responses/410" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Converged Charging" ], "x-internal-id":"{apiRoot}-nchf-convergedcharging-v3-chargingdata-{ChargingDataRef}-update-post", "x-filename-id":"apiroot-nchf-convergedcharging-v3-chargingdata-chargingdataref-update-post" } }, "{apiRoot}/nchf-convergedcharging/v3/chargingdata/{ChargingDataRef}/release":{ "post":{ "summary":"End a Converged Charging Session", "description":"Ends a converged charging session by releasing the subscriber's reservation and then providing a last report of service usage.", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ChargingDataRequest" } } } }, "parameters":[ { "name":"ChargingDataRef", "in":"path", "description":"A unique ID for a charging data resource in a PLMN", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The converged charging session was ended successfully." }, "307":{ "$ref":"#/components/responses/307" }, "308":{ "$ref":"#/components/responses/308" }, "401":{ "$ref":"#/components/responses/401" }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/problem+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/ProblemDetails" }, { "$ref":"#/components/schemas/ChargingDataResponse" } ] } } } }, "410":{ "$ref":"#/components/responses/410" }, "411":{ "$ref":"#/components/responses/411" }, "413":{ "$ref":"#/components/responses/413" }, "500":{ "$ref":"#/components/responses/500" }, "503":{ "$ref":"#/components/responses/503" }, "default":{ "$ref":"#/components/responses/default" } }, "tags":[ "Nchf Converged Charging" ], "x-internal-id":"{apiRoot}-nchf-convergedcharging-v3-chargingdata-{ChargingDataRef}-release-post", "x-filename-id":"apiroot-nchf-convergedcharging-v3-chargingdata-chargingdataref-release-post" } } }, "components":{ "securitySchemes":{ "oAuth2ClientCredentials":{ "type":"oauth2", "flows":{ "clientCredentials":{ "tokenUrl":"{nrfApiRoot}/oauth2/token", "scopes":{ "nchf-offlineonlycharging":"Access to the Nchf_OfflineOnlyCharging API" } } } } }, "schemas":{ "ChargingDataRequest":{ "type":"object", "description":"An offline-only charging request.", "properties":{ "subscriberIdentifier":{ "$ref":"#/components/schemas/Supi" }, "nfConsumerIdentification":{ "$ref":"#/components/schemas/NFIdentification" }, "invocationTimeStamp":{ "$ref":"#/components/schemas/DateTime" }, "invocationSequenceNumber":{ "$ref":"#/components/schemas/Uint32" }, "retransmissionIndicator":{ "type":"boolean", "description":"Whether this is a retransmitted request message (true) or not (false)." }, "serviceSpecificationInfo":{ "type":"string", "description":"The service-specific document that applies to the request, such as the 3GPP release document." }, "multipleUnitUsage":{ "type":"array", "description":"A list of multiple unit usage.", "items":{ "$ref":"#/components/schemas/MultipleUnitUsage" }, "minItems":0 }, "triggers":{ "type":"array", "description":"A list of triggers.", "items":{ "$ref":"#/components/schemas/Trigger" }, "minItems":0 }, "pDUSessionChargingInformation":{ "$ref":"#/components/schemas/PDUSessionChargingInformation" }, "roamingQBCInformation":{ "$ref":"#/components/schemas/RoamingQBCInformation" } }, "required":[ "nfConsumerIdentification", "invocationTimeStamp", "invocationSequenceNumber" ] }, "ChargingDataResponse":{ "type":"object", "description":"A response to a request for offline-only charging.", "properties":{ "invocationTimeStamp":{ "$ref":"#/components/schemas/DateTime" }, "invocationSequenceNumber":{ "$ref":"#/components/schemas/Uint32" }, "invocationResult":{ "$ref":"#/components/schemas/InvocationResult" }, "sessionFailover":{ "$ref":"#/components/schemas/SessionFailover" }, "triggers":{ "type":"array", "items":{ "$ref":"#/components/schemas/Trigger" }, "minItems":0 }, "pDUSessionChargingInformation":{ "$ref":"#/components/schemas/PDUSessionChargingInformation" }, "roamingQBCInformation":{ "$ref":"#/components/schemas/RoamingQBCInformation" } }, "required":[ "invocationTimeStamp", "invocationSequenceNumber" ] }, "NFIdentification":{ "type":"object", "description":"A Network Function (NF).", "properties":{ "nFName":{ "$ref":"#/components/schemas/NfInstanceId" }, "nFIPv4Address":{ "$ref":"#/components/schemas/Ipv4Addr" }, "nFIPv6Address":{ "$ref":"#/components/schemas/Ipv6Addr" }, "nFPLMNID":{ "$ref":"#/components/schemas/PlmnId" }, "nodeFunctionality":{ "$ref":"#/components/schemas/NodeFunctionality" }, "nFFqdn":{ "description":"The fully qualified domain name (FQDN) of the NF.", "type":"string" } }, "required":[ "nodeFunctionality" ] }, "MultipleUnitUsage":{ "type":"object", "description":"The parameters for the quota management request and/or usage report.", "properties":{ "ratingGroup":{ "$ref":"#/components/schemas/RatingGroup" }, "usedUnitContainer":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsedUnitContainer" }, "minItems":0 }, "uPFID":{ "$ref":"#/components/schemas/NfInstanceId" }, "multihomedPDUAddress":{ "$ref":"#/components/schemas/PDUAddress" } }, "required":[ "ratingGroup" ] }, "InvocationResult":{ "type":"object", "description":"The result of a charging service invocation by the NF consumer.", "properties":{ "error":{ "$ref":"#/components/schemas/ProblemDetails" }, "failureHandling":{ "$ref":"#/components/schemas/FailureHandling" } } }, "Trigger":{ "type":"object", "description":"A trigger event.", "properties":{ "triggerType":{ "$ref":"#/components/schemas/TriggerType" }, "triggerCategory":{ "$ref":"#/components/schemas/TriggerCategory" }, "timeLimit":{ "$ref":"#/components/schemas/DurationSec" }, "volumeLimit":{ "$ref":"#/components/schemas/Uint32" }, "volumeLimit64":{ "$ref":"#/components/schemas/Uint64" }, "eventLimit":{ "$ref":"#/components/schemas/Uint32" }, "maxNumberOfccc":{ "$ref":"#/components/schemas/Uint32" } }, "required":[ "triggerType", "triggerCategory" ] }, "UsedUnitContainer":{ "type":"object", "description":"The amount of used non-monetary service units.", "properties":{ "serviceId":{ "$ref":"#/components/schemas/ServiceId" }, "triggers":{ "type":"array", "items":{ "$ref":"#/components/schemas/Trigger" }, "minItems":0 }, "triggerTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "time":{ "$ref":"#/components/schemas/Uint32" }, "totalVolume":{ "$ref":"#/components/schemas/Uint64" }, "uplinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "downlinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "serviceSpecificUnits":{ "$ref":"#/components/schemas/Uint64" }, "eventTimeStamps":{ "type":"array", "description":"The date and time when the event occurred.", "items":{ "$ref":"#/components/schemas/DateTime" }, "minItems":0 }, "localSequenceNumber":{ "description":"The used unit sequence number. It starts at 1 and is incremented by 1 for each used unit generation.", "type":"integer" }, "pDUContainerInformation":{ "$ref":"#/components/schemas/PDUContainerInformation" } }, "required":[ "localSequenceNumber" ] }, "PDUSessionChargingInformation":{ "type":"object", "properties":{ "chargingId":{ "$ref":"#/components/schemas/ChargingId" }, "sMFChargingId":{ "type":"string" }, "userInformation":{ "$ref":"#/components/schemas/UserInformation" }, "userLocationinfo":{ "$ref":"#/components/schemas/UserLocation" }, "mAPDUNon3GPPUserLocationInfo":{ "$ref":"#/components/schemas/UserLocation" }, "userLocationTime":{ "$ref":"#/components/schemas/DateTime" }, "presenceReportingAreaInformation":{ "description":"When the data type is present in the response message, it includes the PRA information provisioned by the CHF, in which case the presenceState attribute within the PresenceInfo data type shall not be supplied. When the data type is present in the request message, it is used to report user presence reporting area status. The praId attribute within the PresenceInfo data type shall be the key of the map.", "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/PresenceInfo" }, "minProperties":0 }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "pduSessionInformation":{ "$ref":"#/components/schemas/PDUSessionInformation" }, "unitCountInactivityTimer":{ "$ref":"#/components/schemas/DurationSec" }, "rANSecondaryRATUsageReport":{ "$ref":"#/components/schemas/RANSecondaryRATUsageReport" } }, "required":[ "pduSessionInformation" ] }, "UserInformation":{ "type":"object", "description":"Information about a user and user equipment.", "properties":{ "servedGPSI":{ "$ref":"#/components/schemas/Gpsi" }, "servedPEI":{ "$ref":"#/components/schemas/Pei" }, "unauthenticatedFlag":{ "type":"boolean" }, "roamerInOut":{ "$ref":"#/components/schemas/RoamerInOut" } } }, "PDUSessionInformation":{ "type":"object", "description":"Information about a PDU session.", "properties":{ "networkSlicingInfo":{ "$ref":"#/components/schemas/NetworkSlicingInfo" }, "pduSessionID":{ "$ref":"#/components/schemas/PduSessionId" }, "pduType":{ "$ref":"#/components/schemas/PduSessionType" }, "sscMode":{ "$ref":"#/components/schemas/SscMode" }, "hPlmnId":{ "$ref":"#/components/schemas/PlmnId" }, "servingNetworkFunctionID":{ "$ref":"#/components/schemas/ServingNetworkFunctionID" }, "ratType":{ "$ref":"#/components/schemas/RatType" }, "mAPDUNon3GPPRATType":{ "$ref":"#/components/schemas/RatType" }, "dnnId":{ "$ref":"#/components/schemas/Dnn" }, "chargingCharacteristics":{ "type":"string" }, "chargingCharacteristicsSelectionMode":{ "$ref":"#/components/schemas/ChargingCharacteristicsSelectionMode" }, "startTime":{ "$ref":"#/components/schemas/DateTime" }, "stopTime":{ "$ref":"#/components/schemas/DateTime" }, "3gppPSDataOffStatus":{ "$ref":"#/components/schemas/3GPPPSDataOffStatus" }, "sessionStopIndicator":{ "type":"boolean" }, "pduAddress":{ "$ref":"#/components/schemas/PDUAddress" }, "diagnostics":{ "$ref":"#/components/schemas/Diagnostics" }, "authorizedQoSInformation":{ "$ref":"#/components/schemas/AuthorizedDefaultQos" }, "subscribedQoSInformation":{ "$ref":"#/components/schemas/SubscribedDefaultQos" }, "authorizedSessionAMBR":{ "$ref":"#/components/schemas/Ambr" }, "subscribedSessionAMBR":{ "$ref":"#/components/schemas/Ambr" }, "servingCNPlmnId":{ "$ref":"#/components/schemas/PlmnId" }, "mAPDUSessionInformation":{ "$ref":"#/components/schemas/MAPDUSessionInformation" }, "enhancedDiagnostics":{ "$ref":"#/components/schemas/EnhancedDiagnostics5G" } }, "required":[ "pduSessionID", "dnnId" ] }, "PDUContainerInformation":{ "type":"object", "properties":{ "timeofFirstUsage":{ "$ref":"#/components/schemas/DateTime" }, "timeofLastUsage":{ "$ref":"#/components/schemas/DateTime" }, "qoSInformation":{ "$ref":"#/components/schemas/QosData" }, "qoSCharacteristics":{ "$ref":"#/components/schemas/QosCharacteristics" }, "aFCorrelationInformation":{ "description":"An identifier, provided from the AF, correlating the measurement for the Charging key/Service identifier values in this PCC rule with application-level reports.", "type":"string" }, "userLocationInformation":{ "$ref":"#/components/schemas/UserLocation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "rATType":{ "$ref":"#/components/schemas/RatType" }, "servingNodeID":{ "type":"array", "description":"The list of AMF Identifiers (AmfId) of AMFs.", "items":{ "$ref":"#/components/schemas/ServingNetworkFunctionID" }, "minItems":0 }, "presenceReportingAreaInformation":{ "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/PresenceInfo" }, "minProperties":0 }, "3gppPSDataOffStatus":{ "$ref":"#/components/schemas/3GPPPSDataOffStatus" }, "sponsorIdentity":{ "description":"An identifier of the sponsor.", "type":"string" }, "applicationserviceProviderIdentity":{ "description":"An identifier for the application service provider.", "type":"string" }, "chargingRuleBaseName":{ "description":"The reference to a group of PCC rules predefined at the SMF.", "type":"string" }, "mAPDUSteeringFunctionality":{ "$ref":"#/components/schemas/SteeringFunctionality" }, "mAPDUSteeringMode":{ "$ref":"#/components/schemas/SteeringMode" } } }, "NetworkSlicingInfo":{ "type":"object", "description":"Information about a network slice serving the PDU session.", "properties":{ "sNSSAI":{ "$ref":"#/components/schemas/Snssai" } }, "required":[ "sNSSAI" ] }, "PDUAddress":{ "type":"object", "description":"A group of user IP addresses.", "properties":{ "pduIPv4Address":{ "$ref":"#/components/schemas/Ipv4Addr" }, "pduIPv6AddresswithPrefix":{ "$ref":"#/components/schemas/Ipv6Addr" }, "pduAddressprefixlength":{ "description":"The length of the PDU address prefix for an IPv6 typed served PDU address. The field is not required for a prefix length of 64 bits.", "type":"integer" }, "iPv4dynamicAddressFlag":{ "description":"Indicates whether the served IPv4 PDU address is dynamically allocated (true) or not (false). This field is missing when the address is static.", "type":"boolean" }, "iPv6dynamicPrefixFlag":{ "description":"This field indicates whether the served IPv6 PDU address is dynamically allocated (true) or not (false). This field is missing if the address is static.", "type":"boolean" } } }, "ServingNetworkFunctionID":{ "type":"object", "description":"An identifier for the serving NF.", "properties":{ "servingNetworkFunctionInformation":{ "$ref":"#/components/schemas/NFIdentification" }, "aMFId":{ "$ref":"#/components/schemas/AmfId" } }, "required":[ "servingNetworkFunctionInformation" ] }, "RoamingQBCInformation":{ "type":"object", "description":"The 5G data connectivity-specific information for roaming QBC.", "properties":{ "multipleQFIcontainer":{ "type":"array", "items":{ "$ref":"#/components/schemas/MultipleQFIcontainer" }, "minItems":0 }, "uPFID":{ "$ref":"#/components/schemas/NfInstanceId" }, "roamingChargingProfile":{ "$ref":"#/components/schemas/RoamingChargingProfile" } } }, "MultipleQFIcontainer":{ "type":"object", "properties":{ "triggers":{ "type":"array", "items":{ "$ref":"#/components/schemas/Trigger" }, "minItems":0 }, "triggerTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "time":{ "$ref":"#/components/schemas/Uint32" }, "totalVolume":{ "$ref":"#/components/schemas/Uint64" }, "uplinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "localSequenceNumber":{ "type":"integer" }, "qFIContainerInformation":{ "$ref":"#/components/schemas/QFIContainerInformation" } }, "required":[ "localSequenceNumber" ] }, "QFIContainerInformation":{ "type":"object", "properties":{ "qFI":{ "$ref":"#/components/schemas/Qfi" }, "timeofFirstUsage":{ "$ref":"#/components/schemas/DateTime" }, "timeofLastUsage":{ "$ref":"#/components/schemas/DateTime" }, "qoSInformation":{ "$ref":"#/components/schemas/QosData" }, "qoSCharacteristics":{ "$ref":"#/components/schemas/QosCharacteristics" }, "userLocationInformation":{ "$ref":"#/components/schemas/UserLocation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "presenceReportingAreaInformation":{ "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/PresenceInfo" }, "minProperties":0 }, "rATType":{ "$ref":"#/components/schemas/RatType" }, "servingNetworkFunctionID":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServingNetworkFunctionID" }, "minItems":0 }, "3gppPSDataOffStatus":{ "$ref":"#/components/schemas/3GPPPSDataOffStatus" } } }, "RoamingChargingProfile":{ "type":"object", "properties":{ "triggers":{ "type":"array", "items":{ "$ref":"#/components/schemas/Trigger" }, "minItems":0 }, "partialRecordMethod":{ "$ref":"#/components/schemas/PartialRecordMethod" } } }, "RANSecondaryRATUsageReport":{ "type":"object", "properties":{ "rANSecondaryRATType":{ "$ref":"#/components/schemas/RatType" }, "qosFlowsUsageReports":{ "type":"array", "items":{ "$ref":"#/components/schemas/QosFlowsUsageReport" } } } }, "Diagnostics":{ "type":"integer" }, "IPFilterRule":{ "type":"string" }, "QosFlowsUsageReport":{ "type":"object", "properties":{ "qFI":{ "$ref":"#/components/schemas/Qfi" }, "startTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "endTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "uplinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "downlinkVolume":{ "$ref":"#/components/schemas/Uint64" } } }, "MAPDUSessionInformation":{ "type":"object", "properties":{ "mAPDUSessionIndicator":{ "$ref":"#/components/schemas/MaPduIndication" }, "aTSSSCapability":{ "$ref":"#/components/schemas/AtsssCapability" } } }, "EnhancedDiagnostics5G":{ "$ref":"#/components/schemas/RanNasCauseList" }, "RanNasCauseList":{ "type":"array", "items":{ "$ref":"#/components/schemas/RanNasRelCause" } }, "MaPduIndication":{ "description":"Contains the MA PDU session indication, that is, MA PDU Request or MA PDU Network-Upgrade Allowed.", "type":"string", "enum":[ "MA_PDU_REQUEST", "MA_PDU_NETWORK_UPGRADE_ALLOWED" ] }, "RanNasRelCause":{ "description":"Contains the RAN/NAS release cause.", "type":"object", "properties":{ "ngApCause":{ "$ref":"#/components/schemas/NgApCause" }, "5gMmCause":{ "$ref":"#/components/schemas/5GMmCause" }, "5gSmCause":{ "$ref":"#/components/schemas/5GSmCause" }, "epsCause":{ "$ref":"#/components/schemas/EpsRanNasRelCause" } } }, "5GSmCause":{ "$ref":"#/components/schemas/Uinteger" }, "EpsRanNasRelCause":{ "type":"string", "description":"Defines the EPS RAN/NAS release cause." }, "NodeFunctionality":{ "type":"string", "enum":[ "SMF", "SMSF", "I-SMF" ] }, "ChargingCharacteristicsSelectionMode":{ "type":"string", "enum":[ "HOME_DEFAULT", "ROAMING_DEFAULT", "VISITING_DEFAULT" ] }, "TriggerType":{ "type":"string", "enum":[ "FINAL", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "GFBR_GUARANTEED_STATUS_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ] }, "TriggerCategory":{ "type":"string", "enum":[ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ] }, "FailureHandling":{ "type":"string", "enum":[ "TERMINATE", "CONTINUE", "RETRY_AND_TERMINATE" ] }, "SessionFailover":{ "type":"string", "enum":[ "FAILOVER_NOT_SUPPORTED", "FAILOVER_SUPPORTED" ] }, "3GPPPSDataOffStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "ResultCode":{ "type":"string", "enum":[ "SUCCESS", "END_USER_SERVICE_DENIED" ] }, "PartialRecordMethod":{ "type":"string", "enum":[ "DEFAULT", "INDIVIDUAL" ] }, "RoamerInOut":{ "type":"string", "enum":[ "IN_BOUND", "OUT_BOUND" ] }, "Binary":{ "format":"binary", "type":"string", "description":"String in 'binary' format, as defined in OpenAPI." }, "BinaryRm":{ "format":"binary", "type":"string", "nullable":true, "description":"String in 'binary' format, as defined in OpenAPI with 'nullable: true' property." }, "Bytes":{ "format":"byte", "type":"string", "description":"String in 'bytes' format, as defined in OpenAPI." }, "BytesRm":{ "format":"byte", "type":"string", "nullable":true, "description":"String in 'bytes' format, as defined in OpenAPI with 'nullable: true' property.\n" }, "Date":{ "format":"date", "type":"string", "description":"String in 'date' format, as defined in OpenAPI." }, "DateRm":{ "format":"date", "type":"string", "nullable":true, "description":"String in 'date' format, as defined in OpenAPI with 'nullable: true' property.\n" }, "DateTime":{ "format":"date-time", "type":"string", "description":"String in 'date-time' format, as defined in OpenAPI." }, "DateTimeRm":{ "format":"date-time", "type":"string", "nullable":true, "description":"String in 'date-time' format, as defined in OpenAPI with 'nullable:true' property. \n" }, "DiameterIdentity":{ "$ref":"#/components/schemas/Fqdn" }, "DiameterIdentityRm":{ "$ref":"#/components/schemas/FqdnRm" }, "Double":{ "format":"double", "type":"number", "description":"String in 'double' format, as defined in OpenAPI." }, "DoubleRm":{ "format":"double", "type":"number", "nullable":true, "description":"String in 'double' format, as defined in OpenAPI with 'nullable: true' property.\n" }, "DurationSec":{ "type":"integer", "description":"Indicates a time in seconds." }, "DurationSecRm":{ "type":"integer", "nullable":true, "description":"Indicates a time in seconds, with OpenAPI defined as 'nullable: true' property." }, "Float":{ "format":"float", "type":"number", "description":"String in 'float' format, as defined in OpenAPI." }, "FloatRm":{ "format":"float", "type":"number", "nullable":true, "description":"String in 'float' format, as defined in OpenAPI with 'nullable: true' property.\n" }, "Int32":{ "format":"int32", "type":"integer", "description":"String in 'int32' format, as defined in OpenAPI." }, "Int32Rm":{ "format":"int32", "type":"integer", "nullable":true, "description":"String in 'int32' format, as defined in OpenAPI with 'nullable: true' property.\n" }, "Int64":{ "type":"integer", "format":"int64", "description":"String in 'int64' format, as defined in OpenAPI." }, "Int64Rm":{ "format":"int64", "type":"integer", "nullable":true, "description":"String in 'int64' format, as defined in OpenAPI with 'nullable: true' property.\n" }, "Ipv4Addr":{ "type":"string", "pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "example":"'198.51.100.1'", "description":"String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.\n" }, "Ipv4AddrRm":{ "type":"string", "pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "example":"'198.51.100.1'", "nullable":true, "description":"String identifying a IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166, with OpenAPI defined as 'nullable: true' property.\n" }, "Ipv4AddrMask":{ "type":"string", "pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$", "example":"'198.51.0.0/16'", "description":"\"String identifying a IPv4 address mask, formatted in the 'dotted decimal' notation as defined in RFC 1166.\"\n" }, "Ipv4AddrMaskRm":{ "type":"string", "pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$", "example":"'198.51.0.0/16'", "nullable":true, "description":"String identifying a IPv4 address mask, formatted in the 'dotted decimal' notation as defined in RFC 1166, with OpenAPI defined as 'nullable: true' property.\n" }, "Ipv6Addr":{ "type":"string", "example":"'2001:db8:85a3::8a2e:370:7334'", "description":"String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952. \n" }, "Ipv6AddrRm":{ "type":"string", "allOf":[ { "pattern":"^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$" }, { "pattern":"^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$" } ], "example":"'2001:db8:85a3::8a2e:370:7334'", "nullable":true, "description":"String identifying an IPv6 address, formatted according to clause 4 of RFC5952 with OpenAPI as 'nullable: true' property. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952 .\n" }, "Ipv6Prefix":{ "type":"string", "example":"'2001:db8:abcd:12::0/64'", "description":"String identifying an IPv6 address prefix, formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.\n" }, "Ipv6PrefixRm":{ "type":"string", "allOf":[ { "pattern":"^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$" }, { "pattern":"^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\\/.+)$" } ], "nullable":true, "description":"String identifying an IPv6 address prefix, formatted according to clause 4 of RFC 5952 with the OpenAPI as 'nullable: true' property. IPv6Prefix data type may contain an individual /128 IPv6 address.\n" }, "MacAddr48":{ "type":"string", "pattern":"^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$", "description":"String identifying a MAC address, formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042.\n" }, "MacAddr48Rm":{ "type":"string", "pattern":"^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$", "nullable":true, "description":"\"String identifying a MAC address, formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042, with OpenAPI as 'nullable: true' property.\"\n" }, "SupportedFeatures":{ "type":"string", "pattern":"^[A-Fa-f0-9]*$", "description":"A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.\n" }, "Uinteger":{ "type":"integer", "minimum":0, "description":"Unsigned Integer, that is, only 0 and integers above 0 are permissible." }, "UintegerRm":{ "type":"integer", "minimum":0, "description":"Unsigned Integer, that is, only 0 and integers above 0 are permissible with OpenAPI as 'nullable: true' property.\n", "nullable":true }, "Uint16":{ "type":"integer", "minimum":0, "maximum":65535, "description":"Integer where the allowed values correspond to the value range of an unsigned 16-bit integer." }, "Uint16Rm":{ "type":"integer", "minimum":0, "maximum":65535, "nullable":true, "description":"Integer where the allowed values correspond to the value range of an unsigned 16-bit integer, with OpenAPI as 'nullable: true' property.\n" }, "Uint32":{ "type":"integer", "minimum":0, "maximum":"4294967295", "description":"Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.\n" }, "Uint32Rm":{ "format":"int32", "type":"integer", "minimum":0, "maximum":"4294967295", "nullable":true, "description":"Integer where the allowed values correspond to the value range of an unsigned 32-bit integer, with OpenAPI as 'nullable: true' property.\n" }, "Uint64":{ "type":"integer", "minimum":0, "maximum":"18446744073709552000", "description":"Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.\n" }, "Uint64Rm":{ "type":"integer", "minimum":0, "maximum":"18446744073709552000", "nullable":true, "description":"Integer where the allowed values correspond to the value range of an unsigned 16-bit integer, with OpenAPI as 'nullable: true' property.\n" }, "Uri":{ "type":"string", "description":"String providing a URI formatted according to RFC 3986." }, "UriRm":{ "type":"string", "nullable":true, "description":"String providing a URI formatted according to RFC 3986, with OpenAPI as 'nullable: true' property.\n" }, "VarUeId":{ "type":"string", "pattern":"^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$", "description":"String represents the SUPI or GPSI." }, "VarUeIdRm":{ "type":"string", "pattern":"^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$", "nullable":true, "description":"String represents the SUPI or GPSI, with OpenAPI as 'nullable: true' property." }, "TimeZone":{ "type":"string", "example":"-08:00+1", "description":"String formatted as \"time-numoffset,\" optionally appended by \"daylightSavingTime,\" where \n- \"time-numoffset\" represents the time zone adjusted for daylight saving time and is encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; \n- \"daylightSavingTime\" represents the adjustment made and is encoded as \"+1\" or \"+2\" for a +1 or +2 hour adjustment. \n\nThe example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.\n" }, "TimeZoneRm":{ "type":"string", "nullable":true, "description":"\"String formatted as 'time-numoffset,' optionally appended by ',' where\n - 'time-numoffset' represents the time zone adjusted for daylight saving time and is\n encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;\n - 'daylightSavingTime' represents the adjustment made and is encoded as '+1' or '+2' for a +1 or +2 hours adjustment.\n\n But with OpenAPI as 'nullable: true' property.\"\n" }, "StnSr":{ "type":"string", "description":"String representing the STN-SR, as defined in clause 18.6 of 3GPP TS 23.003." }, "StnSrRm":{ "type":"string", "nullable":true, "description":"String representing the STN-SR, as defined in clause 18.6 of 3GPP TS 23.003 with OpenAPI as 'nullable: true' property. \n" }, "CMsisdn":{ "type":"string", "pattern":"^[0-9]{5,15}$", "description":"String representing the C-MSISDN, as defined in clause 18.7 of 3GPP TS 23.003." }, "CMsisdnRm":{ "type":"string", "pattern":"^[0-9]{5,15}$", "nullable":true, "description":"String representing the C-MSISDN, as defined in clause 18.7 of 3GPP TS 23.003 with OpenAPI as 'nullable: true' property. \n" }, "DayOfWeek":{ "type":"integer", "minimum":1, "maximum":7, "description":"Integer between and including 1 and 7 denoting a weekday. 1 indicates Monday, with subsequent weekdays represented by the next higher numbers. 7 indicates Sunday.\n" }, "TimeOfDay":{ "type":"string", "description":"String in partial-time or full-time format, as defined in clause 5.6 of IETF RFC 3339. Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). \n" }, "EmptyObject":{ "description":"Empty JSON object { }, it is defined with the keyword additionalProperties false.", "type":"object", "additionalProperties":false }, "Fqdn":{ "description":"Fully Qualified Domain Name.", "type":"string", "pattern":"^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\\.)+[A-Za-z]{2,63}\\.?$", "minLength":4, "maxLength":253 }, "FqdnRm":{ "description":"Fully Qualified Domain Name, but it also allows null value.", "anyOf":[ { "$ref":"#/components/schemas/Fqdn" }, { "$ref":"#/components/schemas/NullValue" } ] }, "PatchOperation":{ "type":"string", "enum":[ "add", "copy", "move", "remove", "replace", "test" ], "description":"Operations as defined in IETF RFC 6902." }, "UriScheme":{ "type":"string", "enum":[ "http", "https" ], "description":"HTTP and HTTPS URI scheme." }, "ChangeType":{ "type":"string", "enum":[ "ADD", "MOVE", "REMOVE", "REPLACE" ], "description":"Indicates the type of change to be performed." }, "HttpMethod":{ "anyOf":[ { "type":"string", "enum":[ "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "CONNECT", "TRACE" ] }, { "type":"string" } ], "description":"HTTP methods." }, "NullValue":{ "enum":[ null ], "description":"JSON's null value." }, "MatchingOperator":{ "anyOf":[ { "type":"string", "enum":[ "FULL_MATCH", "MATCH_ALL", "STARTS_WITH", "NOT_START_WITH", "ENDS_WITH", "NOT_END_WITH", "CONTAINS", "NOT_CONTAIN" ] }, { "type":"string" } ], "description":"The matching operation." }, "ProblemDetails":{ "description":"Provides additional information in an error response.", "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/Uri" }, "title":{ "type":"string" }, "status":{ "type":"integer" }, "detail":{ "type":"string", "description":"A human-readable explanation specific to this occurrence of the problem." }, "instance":{ "$ref":"#/components/schemas/Uri" }, "cause":{ "type":"string", "description":"A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information if available.\n" }, "invalidParams":{ "type":"array", "items":{ "$ref":"#/components/schemas/InvalidParam" }, "minItems":1 }, "supportedFeatures":{ "$ref":"#/components/schemas/SupportedFeatures" }, "accessTokenError":{ "$ref":"#/components/schemas/AccessTokenErr" }, "accessTokenRequest":{ "$ref":"#/components/schemas/AccessTokenReq" }, "nrfId":{ "$ref":"#/components/schemas/Fqdn" } } }, "AccessTokenErr":{ "description":"Error returned in the access token response message.", "type":"object", "required":[ "error" ], "properties":{ "error":{ "type":"string", "enum":[ "invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope" ] }, "error_description":{ "type":"string" }, "error_uri":{ "type":"string" } } }, "NFType":{ "description":"NF types known to NRF.", "type":"string", "enum":[ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ] }, "AccessTokenReq":{ "description":"Contains information related to an access token request.", "type":"object", "required":[ "grant_type", "nfInstanceId", "scope" ], "properties":{ "grant_type":{ "type":"string", "enum":[ "client_credentials" ] }, "nfInstanceId":{ "$ref":"#/components/schemas/NfInstanceId" }, "nfType":{ "$ref":"#/components/schemas/NFType" }, "targetNfType":{ "$ref":"#/components/schemas/NFType" }, "scope":{ "type":"string", "pattern":"^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$" }, "targetNfInstanceId":{ "$ref":"#/components/schemas/NfInstanceId" }, "requesterPlmn":{ "$ref":"#/components/schemas/PlmnId" }, "requesterPlmnList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlmnId" }, "minItems":2 }, "requesterSnssaiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":1 }, "requesterFqdn":{ "$ref":"#/components/schemas/Fqdn" }, "requesterSnpnList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlmnIdNid" }, "minItems":1 }, "targetPlmn":{ "$ref":"#/components/schemas/PlmnId" }, "targetSnpn":{ "$ref":"#/components/schemas/PlmnIdNid" }, "targetSnssaiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":1 }, "targetNsiList":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "targetNfSetId":{ "$ref":"#/components/schemas/NfSetId" }, "targetNfServiceSetId":{ "$ref":"#/components/schemas/NfServiceSetId" }, "hnrfAccessTokenUri":{ "$ref":"#/components/schemas/Uri" }, "sourceNfInstanceId":{ "$ref":"#/components/schemas/NfInstanceId" } } }, "Link":{ "type":"object", "properties":{ "href":{ "$ref":"#/components/schemas/Uri" } }, "description":"It contains the URI of the linked resource." }, "LinkRm":{ "type":"object", "properties":{ "href":{ "$ref":"#/components/schemas/Uri" } }, "nullable":true, "description":"It contains the URI of the linked resource with the OpenAPI as 'nullable: true' property.\n" }, "PatchItem":{ "type":"object", "properties":{ "op":{ "$ref":"#/components/schemas/PatchOperation" }, "path":{ "type":"string", "description":"Contains a JSON pointer value (as defined in IETF RFC 6901) that references the location of a resource on which the patch operation will be performed.\n" }, "from":{ "type":"string", "description":"Indicates the path of the source JSON element (according to JSON Pointer syntax) that is being moved or copied to the location specified by the \"path\" attribute.\n" }, "value":{ } }, "required":[ "op", "path" ], "description":"It contains information about the data to be changed." }, "LinksValueSchema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" }, "minItems":1, "description":"A list of mutually exclusive alternatives consisting of one or more links." }, "SelfLink":{ "type":"object", "properties":{ "self":{ "$ref":"#/components/schemas/Link" } }, "required":[ "self" ], "description":"It contains the URI of the linked resource." }, "InvalidParam":{ "description":"It contains an invalid parameter and a related description.", "type":"object", "properties":{ "param":{ "description":"If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string \"header\" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string \"query \" plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the \"{\" and \"}\" symbols used in the OpenAPI specification to represent variable path segments.\n", "type":"string" }, "reason":{ "description":"A human-readable reason, for example, \"must be a positive integer\". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, \" Replacement value invalid for attribute (failed operation index= 4).\"\n", "type":"string" } }, "required":[ "param" ] }, "ChangeItem":{ "type":"object", "properties":{ "op":{ "$ref":"#/components/schemas/ChangeType" }, "path":{ "type":"string", "description":"Contains a JSON pointer value (as defined in IETF RFC 6901) that references the target location within the resource where the change has been applied.\n" }, "from":{ "type":"string", "description":"Indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location specified by the \"path\" attribute. It should be present if the \"op\" attribute has the value \"MOVE\".\n" }, "origValue":{ }, "newValue":{ } }, "required":[ "op", "path" ], "description":"It contains data that needs to be changed." }, "NotifyItem":{ "type":"object", "required":[ "resourceId", "changes" ], "properties":{ "resourceId":{ "$ref":"#/components/schemas/Uri" }, "changes":{ "type":"array", "items":{ "$ref":"#/components/schemas/ChangeItem" }, "minItems":1 } }, "description":"Indicates changes to a resource." }, "ComplexQuery":{ "oneOf":[ { "$ref":"#/components/schemas/Cnf" }, { "$ref":"#/components/schemas/Dnf" } ], "description":"The ComplexQuery data type is either in conjunctive normal form or disjunctive normal form. The attribute names \"cnfUnits\" and \"dnfUnits\" (see clause 5.2.4.11 and clause 5.2.4.12) serve as discriminators.\n" }, "Cnf":{ "type":"object", "required":[ "cnfUnits" ], "properties":{ "cnfUnits":{ "type":"array", "items":{ "$ref":"#/components/schemas/CnfUnit" }, "minItems":1 } }, "description":"A conjunctive normal form." }, "Dnf":{ "type":"object", "required":[ "dnfUnits" ], "properties":{ "dnfUnits":{ "type":"array", "items":{ "$ref":"#/components/schemas/DnfUnit" }, "minItems":1 } }, "description":"A disjunctive normal form." }, "CnfUnit":{ "type":"object", "required":[ "cnfUnit" ], "properties":{ "cnfUnit":{ "type":"array", "items":{ "$ref":"#/components/schemas/Atom" }, "minItems":1 } }, "description":"During the processing of cnfUnits attribute, all members in the array should be interpreted as logically concatenated with a logical \"AND\".\n" }, "DnfUnit":{ "type":"object", "required":[ "dnfUnit" ], "properties":{ "dnfUnit":{ "type":"array", "items":{ "$ref":"#/components/schemas/Atom" }, "minItems":1 } }, "description":"During the processing of dnfUnits attribute, all members in the array should be interpreted as logically concatenated with a logical \"OR\".\n" }, "Atom":{ "description":"Contains a search parameter and its positive or negative content.", "type":"object", "required":[ "attr", "value" ], "properties":{ "attr":{ "type":"string", "description":"Contains the name of a defined query parameter." }, "value":{ }, "negative":{ "type":"boolean", "description":"Indicates whether the negative condition applies to the query condition." } } }, "PatchResult":{ "description":"The execution report results in a failed modification.", "type":"object", "required":[ "report" ], "properties":{ "report":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportItem" }, "minItems":1, "description":"The execution report contains an array of report items. Each report item indicates one failed modification.\n" } } }, "ReportItem":{ "type":"object", "required":[ "path" ], "properties":{ "path":{ "type":"string", "description":"Contains a JSON pointer value (as defined in IETF RFC 6901) that references the location of a resource subject to modification.\n" }, "reason":{ "type":"string", "description":"A human-readable reason providing details about the reported modification failure. The reason string should identify the operation that failed using the operation's array index to help in correlation of the invalid parameter with the failed operation, for example, \"Replacement value invalid for attribute (failed operation index= 4)\".\n" } }, "description":"Indicates performed modifications." }, "HalTemplate":{ "description":"Hypertext Application Language (HAL) template contains the extended 3GPP hypermedia format.\n", "type":"object", "required":[ "method" ], "properties":{ "title":{ "type":"string", "description":"A human-readable string that can be used to identify this template." }, "method":{ "$ref":"#/components/schemas/HttpMethod" }, "contentType":{ "type":"string", "description":"The media type that should be used for the corresponding request. If the attribute is missing, or contains an unrecognized value, the client should act as if the contentType is set to \"application/json\".\n" }, "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/Property" }, "minItems":1, "description":"The properties that should be included in the body of the corresponding request. If the contentType attribute is set to \"application/json\", then this attribute describes the attributes of the JSON object of the body.\n" } } }, "Property":{ "description":"If the contentType attribute is set to \"application/json\", then this attribute describes the attributes of the JSON object of the body.\n", "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"The name of the property." }, "required":{ "type":"boolean", "description":"Indicates whether the property is required – true= required – false(default)= not required.\n" }, "regex":{ "type":"string", "description":"A regular expression string to be applied to the value of the property." }, "value":{ "type":"string", "description":"The property value. When present, it should be a valid JSON string." } } }, "RedirectResponse":{ "description":"The response should include a Location header field containing a different URI (pointing to a different URI of an other service instance), or the same URI if a request is redirected to the same target resource via a different SCP.\n", "type":"object", "properties":{ "cause":{ "type":"string" }, "targetScp":{ "$ref":"#/components/schemas/Uri" }, "targetSepp":{ "$ref":"#/components/schemas/Uri" } } }, "TunnelAddress":{ "description":"Tunnel address.", "type":"object", "properties":{ "ipv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "portNumber":{ "$ref":"#/components/schemas/Uinteger" } }, "required":[ "portNumber" ], "anyOf":[ { "required":[ "ipv4Addr" ] }, { "required":[ "ipv6Addr" ] } ] }, "FqdnPatternMatchingRule":{ "description":"A matching rule for an FQDN pattern.", "type":"object", "oneOf":[ { "required":[ "regex" ] }, { "required":[ "stringMatchingRule" ] } ], "properties":{ "regex":{ "type":"string" }, "stringMatchingRule":{ "$ref":"#/components/schemas/StringMatchingRule" } } }, "StringMatchingRule":{ "description":"A list of conditions for matching string.", "type":"object", "properties":{ "stringMatchingConditions":{ "type":"array", "items":{ "$ref":"#/components/schemas/StringMatchingCondition" }, "minItems":1 } } }, "StringMatchingCondition":{ "description":"A String with matching operator.", "type":"object", "properties":{ "matchingString":{ "type":"string" }, "matchingOperator":{ "$ref":"#/components/schemas/MatchingOperator" } }, "required":[ "matchingOperator" ] }, "Dnn":{ "type":"string", "description":"A string representing a Data Network, as defined in clause 9A of 3GPP TS 23.003. It should contain either a DNN Network Identifier or a full DNN, including both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It should be coded as a string with labels separated by dots (for example, \"Label1.Label2.Label3\").\n" }, "DnnRm":{ "type":"string", "nullable":true, "description":"String representing a Data Network, as defined in clause 9A of 3GPP TS 23.003. It should contain either a DNN Network Identifier or a full DNN, including both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It should be coded as a string with labels separated by dots (for example, 'Label1.Label2.Label3') with the OpenAPI as 'nullable: true' property.\n" }, "WildcardDnn":{ "type":"string", "pattern":"^[*]$", "description":"String representing the Wildcard DNN. It should contain the string \"*\"." }, "WildcardDnnRm":{ "type":"string", "pattern":"^[*]$", "nullable":true, "description":"String representing the Wildcard DNN. It should contain the string '*', but with the OpenAPI as 'nullable: true' property.\n" }, "Gpsi":{ "type":"string", "pattern":"^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$", "description":"String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= \"extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier. \n" }, "GpsiRm":{ "type":"string", "pattern":"^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$", "nullable":true, "description":"String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= 'extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier with the OpenAPI as 'nullable: true' property. \n" }, "GroupId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$", "description":"String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003. \n" }, "GroupIdRm":{ "type":"string", "pattern":"^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$", "nullable":true, "description":"String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003 with the OpenAPI as 'nullable: true' property.\n" }, "ExternalGroupId":{ "type":"string", "pattern":"^extgroupid-[^@]+@[^@]+$", "description":"String identifying External Group Identifier that identifies a group made up of one or more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of 3GPP TS 23.003. \n" }, "ExternalGroupIdRm":{ "type":"string", "pattern":"^extgroupid-[^@]+@[^@]+$", "nullable":true, "description":"String identifying External Group Identifier that identifies a group made up of one or more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of 3GPP TS 23.003 with the OpenAPI as 'nullable: true' property. \n" }, "Pei":{ "type":"string", "pattern":"^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$", "description":"String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345. \n" }, "PeiRm":{ "type":"string", "pattern":"^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$", "nullable":true, "description":"This data type is defined in the same way as the 'Pei' data type, but with the OpenAPI as 'nullable: true' property.\n" }, "Supi":{ "type":"string", "pattern":"^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$", "description":"String identifying a Supi that should contain either an IMSI, a network specific identifier,\na Global Cable Identifier (GCI), or a Global Line Identifier (GLI) as specified in clause \n2.2A of 3GPP TS 23.003. It should be formatted as follows\n - for an IMSI \"imsi-\", where should be formatted according to clause 2.2\n of 3GPP TS 23.003 that describes an IMSI.\n - for a network specific identifier \"nai-, where should be formatted\n according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.\n - for a GCI \"gci-\", where should be formatted according to clause 28.15.2\n of 3GPP TS 23.003.\n - for a GLI \"gli-\", where should be formatted according to clause 28.16.2 of\n 3GPP TS 23.003. To enable the value to be used as part of a URI, the string should\n only contain characters that are allowed according to the \"lower-with-hyphen\" naming convention defined in 3GPP TS 29.501.\n" }, "SupiRm":{ "type":"string", "pattern":"^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$", "nullable":true, "description":"This data type is defined in the same way as the 'Supi' data type, but with the OpenAPI as 'nullable: true' property. \n" }, "NfInstanceId":{ "type":"string", "format":"uuid", "description":"String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. \n" }, "AmfId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{6}$", "description":"String identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits), and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 6 hexadecimal characters (that is, 24 bits). \n" }, "AmfRegionId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{2}$", "description":"String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 3 hexadecimal characters where the first character has values between 0 to 3 (that is, 10 bits).\n" }, "AmfSetId":{ "type":"string", "pattern":"^[0-3][A-Fa-f0-9]{2}$", "description":"String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 3 hexadecimal characters where the first character has values between 0 to 3 (that is, 10 bits).\n" }, "RfspIndex":{ "type":"integer", "minimum":1, "maximum":256, "description":"Unsigned integer representing the \"Subscriber Profile ID for RAT/Frequency Priority\" as specified in 3GPP TS 36.413.\n" }, "RfspIndexRm":{ "type":"integer", "minimum":1, "maximum":256, "nullable":true, "description":"Unsigned integer representing the \"Subscriber Profile ID for RAT/Frequency Priority\" as specified in 3GPP TS 36.413 with the OpenAPI as 'nullable: true' property. \n" }, "NfGroupId":{ "type":"string", "description":"Identifier of a group of NFs." }, "MtcProviderInformation":{ "type":"string", "description":"String uniquely identifying MTC provider information." }, "CagId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{8}$", "description":"String containing a Closed Access Group Identifier." }, "SupiOrSuci":{ "type":"string", "pattern":"^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.*|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$", "description":"String identifying a SUPI or a SUCI." }, "NsacSai":{ "type":"string", "description":"String identifying the Network Slice Admission Control Service Area Identifier.\n" }, "Guami":{ "type":"object", "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnIdNid" }, "amfId":{ "$ref":"#/components/schemas/AmfId" } }, "required":[ "plmnId", "amfId" ], "description":"Globally Unique AMF Identifier constructed out of PLMN, Network, and AMF identity." }, "GuamiRm":{ "anyOf":[ { "$ref":"#/components/schemas/Guami" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'Guami' data type, but with the OpenAPI as 'nullable: true' property.\n" }, "NetworkId":{ "type":"object", "properties":{ "mnc":{ "$ref":"#/components/schemas/Mnc" }, "mcc":{ "$ref":"#/components/schemas/Mcc" } }, "description":"Contains PLMN and Network identity." }, "ApplicationId":{ "type":"string", "description":"String providing an application identifier." }, "ApplicationIdRm":{ "type":"string", "nullable":true, "description":"String providing an application identifier with OpenAPI as 'nullable: true' property.\n" }, "PduSessionId":{ "type":"integer", "minimum":0, "maximum":255, "description":"Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network. \n" }, "Mcc":{ "type":"string", "pattern":"^\\d{3}$", "description":"Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413. \n" }, "MccRm":{ "type":"string", "pattern":"^\\d{3}$", "nullable":true, "description":"Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413 with OpenAPI as 'nullable: true' property.\n" }, "Mnc":{ "type":"string", "pattern":"^\\d{2,3}$", "description":"Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413." }, "MncRm":{ "type":"string", "pattern":"^\\d{2,3}$", "nullable":true, "description":"Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413 with OpenAPI as 'nullable: true' property.\n" }, "Tac":{ "type":"string", "pattern":"(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)", "description":"2 or 3-octet string, identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TAC should appear first in the string, and the character representing the 4 least significant bit of the TAC should appear last in the string. \n" }, "TacRm":{ "type":"string", "pattern":"(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)", "nullable":true, "description":"This data type is defined in the same way as the 'Tac' data type, but with OpenAPI as 'nullable: true' property.\n" }, "EutraCellId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{7}$", "description":"28-bit string, identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string. \n" }, "EutraCellIdRm":{ "type":"string", "pattern":"^[A-Fa-f0-9]{7}$", "nullable":true, "description":"This data type is defined in the same way as the 'EutraCellId' data type, but with OpenAPI as 'nullable: true' property.\n" }, "NrCellId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{9}$", "description":"36-bit string, identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string. \n" }, "NrCellIdRm":{ "type":"string", "pattern":"^[A-Fa-f0-9]{9}$", "nullable":true, "description":"This data type is defined in the same way as the 'NrCellId' data type, but with OpenAPI as 'nullable: true' property.\n" }, "Dnai":{ "type":"string", "description":"DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501." }, "DnaiRm":{ "type":"string", "nullable":true, "description":"This data type is defined in the same way as the 'Dnai' data type, but with OpenAPI as 'nullable: true' property.\n" }, "5GMmCause":{ "$ref":"#/components/schemas/Uinteger" }, "AmfName":{ "$ref":"#/components/schemas/Fqdn" }, "AreaCode":{ "type":"string", "description":"Values are operator specific." }, "AreaCodeRm":{ "type":"string", "nullable":true, "description":"This data type is defined in the same way as the 'AreaCode' data type, but with OpenAPI as 'nullable: true' property.\n" }, "N3IwfId":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string. \n" }, "WAgfId":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID should appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID should appear last in the string. \n" }, "TngfId":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID should appear first in the string, and the character representing the 4 least significant bit of the TNGF ID should appear last in the string. \n" }, "NgeNbId":{ "type":"string", "pattern":"^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$", "description":"This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing padding 0, if required together with the 4 most significant bits of the ng-eNB ID should appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) should appear last in the string. \n", "example":"SMacroNGeNB-34B89" }, "Nid":{ "type":"string", "pattern":"^[A-Fa-f0-9]{11}$", "description":"This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1). \n" }, "NidRm":{ "type":"string", "pattern":"^[A-Fa-f0-9]{11}$", "nullable":true, "description":"This data type is defined in the same way as the 'Nid' data type, but with OpenAPI as 'nullable: true' property.\"\n" }, "NfSetId":{ "type":"string", "description":"NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string \"set.set.5gc.mnc.mcc\", or \"set.set.5gc.nid.mnc.mcc\" with encoded as defined in clause 5.4.2 (\"Mcc\" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. \n If there are only 2 significant digits in the MNC, one \"0\" digit should be inserted \n at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$'\n encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but \n with lower case characters encoded as a string of characters consisting of \n alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that \n should end with either an alphabetic character or a digit. \n" }, "NfServiceSetId":{ "type":"string", "description":"NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string \"set.sn.nfi.5gc.mnc.mcc\", or encoded as defined in clause 5.4.2 (\"Mcc\" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. \n If there are only 2 significant digits in the MNC, one \"0\" digit should be inserted \n at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$'\n encoded as defined in clause 5.4.2 (\"Nid\" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic \n characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end \n with either an alphabetic character or a digit.\n" }, "PlmnAssiUeRadioCapId":{ "$ref":"#/components/schemas/Bytes" }, "ManAssiUeRadioCapId":{ "$ref":"#/components/schemas/Bytes" }, "TypeAllocationCode":{ "type":"string", "pattern":"^[0-9]{8}$", "description":"Type Allocation Code (TAC) of the UE, comprising the initial eight-digit portion of the 15-digit IMEI and 16-digit IMEISV code. See clause 6.2 of 3GPP TS 23.003.\n" }, "HfcNId":{ "type":"string", "maxLength":6, "description":"This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.\n" }, "HfcNIdRm":{ "type":"string", "maxLength":6, "nullable":true, "description":"This data type is defined in the same way as the 'HfcNId' data type, but with OpenAPI as 'nullable: true' property.\n" }, "ENbId":{ "type":"string", "pattern":"^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$", "description":"This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string should be formatted with the following pattern '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from \"0\" to \"9\", \"a\" to \"f\" or \"A\" to \"F\" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing the padding 0, if required together with the 4 most significant bits of the eNB ID should appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) should appear last in the string.\n" }, "Gli":{ "$ref":"#/components/schemas/Bytes" }, "Gci":{ "type":"string", "description":"Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This should be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH.\n" }, "NsSrg":{ "type":"string", "description":"String providing a Network Slice Simultaneous Registration Group. See clause 5.15.12 of 3GPP TS 23.501\n" }, "NsSrgRm":{ "type":"string", "nullable":true, "description":"String providing a Network Slice Simultaneous Registration Group with OpenAPI as \"nullable true\" property. See clause 5.15.12 of 3GPP TS 23.501\n" }, "RelayServiceCode":{ "type":"integer", "minimum":0, "maximum":16777215, "description":"Relay Service Code to identify a connectivity service provided by the UE-to-Network relay.\n" }, "5GPrukId":{ "type":"string", "description":"A string carrying the CP-PRUK ID of the remote UE. The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003.\n", "pattern":"^rid[0-9]{1,4}\\.pid[0-9a-fA-F]+\\@prose-cp\\.5gc\\.mnc[0-9]{2,3}\\.mcc[0-9]{3}\\.3gppnetwork\\.org$" }, "NsagId":{ "type":"integer", "description":"The Network Slice AS Group ID, see 3GPP TS 38.413.\n" }, "NsagIdRm":{ "type":"integer", "nullable":true, "description":"This data type is defined in the same way as the \"NsagId\" data type, but with OpenAP as \"nullable: true\" property.\n" }, "AccessType":{ "type":"string", "enum":[ "3GPP_ACCESS", "NON_3GPP_ACCESS" ], "description":"Indicates whether the access is via 3GPP or via non-3GPP." }, "AccessTypeRm":{ "enum":[ "3GPP_ACCESS", "NON_3GPP_ACCESS", null ], "description":"Indicates whether the access is via 3GPP or via non-3GPP, but with OpenAPI as 'nullable: true' property.\"\n" }, "RatType":{ "type":"string", "enum":[ "NR", "EUTRA", "WLAN", "VIRTUAL", "NBIOT", "WIRELINE", "WIRELINE_CABLE", "WIRELINE_BBF", "LTE-M", "NR_U", "EUTRA_U", "TRUSTED_N3GA", "TRUSTED_WLAN", "UTRA", "GERA", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT", "NR_REDCAP", "WB_E_UTRAN_LEO", "WB_E_UTRAN_MEO", "WB_E_UTRAN_GEO", "WB_E_UTRAN_OTHERSAT", "NB_IOT_LEO", "NB_IOT_MEO", "NB_IOT_GEO", "NB_IOT_OTHERSAT", "LTE_M_LEO", "LTE_M_MEO", "LTE_M_GEO", "LTE_M_OTHERSAT" ], "description":"Indicates the radio access used." }, "RatTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/RatType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"Provides information about the radio access, but with OpenAPI as 'nullable: true' property. \n" }, "PduSessionType":{ "type":"string", "enum":[ "IPV4", "IPV6", "IPV4V6", "UNSTRUCTURED", "ETHERNET" ], "description":"PduSessionType indicates the type of a PDU session. It should comply with the provisions defined in table 5.4.3.3-1.\n" }, "PduSessionTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/PduSessionType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"PduSessionType indicates the type of a PDU session. It should comply with the provisions defined in table 5.4.3.3-1, but with OpenAPI as \"nullable: true\" property. \n" }, "UpIntegrity":{ "anyOf":[ { "type":"string", "enum":[ "REQUIRED", "PREFERRED", "NOT_NEEDED" ] }, { "type":"string" } ], "description":"Indicates whether UP integrity protection is required, preferred, or not needed for all the traffic on the PDU Session. It should comply with the provisions defined in table 5.4.3.4-1. \n" }, "UpIntegrityRm":{ "anyOf":[ { "$ref":"#/components/schemas/UpIntegrity" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"Indicates whether UP integrity protection is required, preferred, or not needed for all the traffic on the PDU Session. It should comply with the provisions defined in table 5.4.3.4-1. \n" }, "UpConfidentiality":{ "anyOf":[ { "type":"string", "enum":[ "REQUIRED", "PREFERRED", "NOT_NEEDED" ] }, { "type":"string" } ], "description":"Indicates whether UP confidentiality protection is required, preferred, or not needed for all the traffic on the PDU Session. It should comply with the provisions defined in table 5.4.3.5-1.\n" }, "UpConfidentialityRm":{ "anyOf":[ { "$ref":"#/components/schemas/UpConfidentiality" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"Indicates whether UP integrity protection is required, preferred, or not needed for all the traffic on the PDU Session. It should comply with the provisions defined in table 5.4.3.4-1, but with OpenAPI as 'nullable: true' property. \n" }, "SscMode":{ "type":"string", "enum":[ "SSC_MODE_1", "SSC_MODE_2", "SSC_MODE_3" ], "description":"Represents the service and session continuity mode. It should comply with the provisions defined in table 5.4.3.6-1.\n" }, "SscModeRm":{ "anyOf":[ { "$ref":"#/components/schemas/SscMode" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"Represents the service and session continuity mode. It should comply with the provisions defined in table 5.4.3.6-1 but with OpenAPI as 'nullable: true' property. \n" }, "DnaiChangeType":{ "anyOf":[ { "type":"string", "enum":[ "EARLY", "EARLY_LATE", "LATE" ] }, { "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. \n" } ], "description":"Possible values are:\n- EARLY: Early notification of UP path reconfiguration.\n- EARLY_LATE: Early and late notification of UP path reconfiguration. This value should\n only be present in the subscription to the DNAI change event.\n- LATE: Late notification of UP path reconfiguration. \n" }, "DnaiChangeTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/DnaiChangeType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"It can take the values as specified for DnaiChangeType, but with OpenAPI as 'nullable: true' property. \n" }, "RestrictionType":{ "type":"string", "enum":[ "ALLOWED_AREAS", "NOT_ALLOWED_AREAS" ], "description":"It contains the restriction type ALLOWED_AREAS or NOT_ALLOWED_AREAS." }, "RestrictionTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/RestrictionType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"It contains the restriction type ALLOWED_AREAS or NOT_ALLOWED_AREAS, but with OpenAPI as 'nullable: true' property. \n" }, "CoreNetworkType":{ "type":"string", "enum":[ "5GC", "EPC" ], "description":"It contains the Core Network type 5GC or EPC." }, "CoreNetworkTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/CoreNetworkType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"It contains the Core Network type 5GC or EPC, but with OpenAPI as 'nullable: true' property. \n" }, "PresenceState":{ "type":"string", "enum":[ "IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE" ], "description":"Possible values are:\n-IN_AREA: Indicates that the UE is inside or enters the presence reporting area.\n-OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area\n-UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not.\n-INACTIVE: Indicates that the presence reporting area is inactive in the serving node.\n" }, "StationaryIndication":{ "anyOf":[ { "type":"string", "enum":[ "STATIONARY", "MOBILE" ] }, { "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.\n" } ], "description":"Possible values are:\n- STATIONARY: Identifies that the UE is stationary.\n- MOBILE: Identifies that the UE is mobile.\n" }, "StationaryIndicationRm":{ "anyOf":[ { "$ref":"#/components/schemas/StationaryIndication" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'StationaryIndication' enumeration, but with OpenAPI as 'nullable: true' property.\n" }, "ScheduledCommunicationType":{ "anyOf":[ { "type":"string", "enum":[ "DOWNLINK_ONLY", "UPLINK_ONLY", "BIDIRECTIONAL" ] }, { "type":"string" } ], "description":"Possible values are:\n-DOWNLINK_ONLY: Downlink only.\n-UPLINK_ONLY: Uplink only.\n-BIDIRECTIONA: Bi-directional.\n" }, "ScheduledCommunicationTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/ScheduledCommunicationType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'ScheduledCommunicationTypen' enumeration, but with OpenAPI as 'nullable: true' property. \n" }, "TrafficProfile":{ "anyOf":[ { "type":"string", "enum":[ "SINGLE_TRANS_UL", "SINGLE_TRANS_DL", "DUAL_TRANS_UL_FIRST", "DUAL_TRANS_DL_FIRST", "MULTI_TRANS" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. \n" } ], "description":"Possible values are:\n- SINGLE_TRANS_UL: Uplink single packet transmission.\n- SINGLE_TRANS_DL: Downlink single packet transmission.\n- DUAL_TRANS_UL_FIRST: Dual packet transmission starting with the uplink packet transmission\n following the downlink packet transmission.\n- DUAL_TRANS_DL_FIRST: Dual packet transmission starting with the downlink packet transmission \n following the uplink packet transmission. \n" }, "TrafficProfileRm":{ "anyOf":[ { "$ref":"#/components/schemas/TrafficProfile" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'TrafficProfile' enumeration, but with OpenAPI as 'nullable: true' property. \n" }, "LcsServiceAuth":{ "anyOf":[ { "type":"string", "enum":[ "LOCATION_ALLOWED_WITH_NOTIFICATION", "LOCATION_ALLOWED_WITHOUT_NOTIFICATION", "LOCATION_ALLOWED_WITHOUT_RESPONSE", "LOCATION_RESTRICTED_WITHOUT_RESPONSE", "NOTIFICATION_ONLY", "NOTIFICATION_AND_VERIFICATION_ONLY" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are:\n- \"LOCATION_ALLOWED_WITH_NOTIFICATION\": Location allowed with notification.\n- \"LOCATION_ALLOWED_WITHOUT_NOTIFICATION\": Location allowed without notification.\n- \"LOCATION_ALLOWED_WITHOUT_RESPONSE\": Location with notification and privacy\n verification; location allowed in case of no response.\n- \"LOCATION_RESTRICTED_WITHOUT_RESPONSE\": Location with notification and privacy\n verification; location restricted in case of no response.\n- \"NOTIFICATION_ONLY\": Notification only.\n- \"NOTIFICATION_AND_VERIFICATION_ONLY\": Notification and privacy verification only.\n" }, "UeAuth":{ "anyOf":[ { "type":"string", "enum":[ "AUTHORIZED", "NOT_AUTHORIZED" ] }, { "type":"string" } ], "description":"Possible values are:\n- AUTHORIZED: Indicates that the UE is authorized.\n- NOT_AUTHORIZED: Indicates that the UE is not authorized.\n" }, "DlDataDeliveryStatus":{ "anyOf":[ { "type":"string", "enum":[ "BUFFERED", "TRANSMITTED", "DISCARDED" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are:\n- BUFFERED: The first downlink data is buffered with extended buffering, aligning with the\n source of the downlink traffic.\n- TRANSMITTED: The first downlink data aligning with the source of the downlink traffic is\n transmitted after previous buffering or discarding of corresponding packet(s) because\n the UE of the PDU Session becomes ACTIVE, and the buffered data can be delivered to the UE.\n- DISCARDED: The first downlink data aligning with the source of the downlink traffic is\n discarded because the extended buffering time, as determined by the SMF, expires or\n the amount of downlink data to be buffered is exceeded.\n" }, "DlDataDeliveryStatusRm":{ "anyOf":[ { "$ref":"#/components/schemas/DlDataDeliveryStatus" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'DlDataDeliveryStatus' data type, but with OpenAPI as 'nullable: true' property. \n" }, "AuthStatus":{ "anyOf":[ { "type":"string", "enum":[ "EAP_SUCCESS", "EAP_FAILURE", "PENDING" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. \n" } ], "description":"Possible values are:\n- \"EAP_SUCCESS\": The NSSAA status is EAP-Success.\n- \"EAP_FAILURE\": The NSSAA status is EAP-Failure.\n- \"PENDING\": The NSSAA status is Pending. \n" }, "LineType":{ "type":"string", "enum":[ "DSL", "PON" ], "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are:\n - DSL: Identifies a DSL line.\n - PON: Identifies a PON line.\n" }, "LineTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/LineType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'LineType' data type, but with OpenAPI as 'nullable: true' property. \n" }, "NotificationFlag":{ "anyOf":[ { "type":"string", "enum":[ "ACTIVATE", "DEACTIVATE", "RETRIEVAL" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. \n" } ], "description":"Possible values are:\n- ACTIVATE: The event notification is activated.\n- DEACTIVATE: The event notification is deactivated and should be muted. The available event \n (s) should be stored.\n- RETRIEVAL: The event notification should be sent to the NF service consumer(s) be muted \n again.\n" }, "TransportProtocol":{ "type":"string", "enum":[ "UDP", "TCP" ], "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are:\n - UDP: User Datagram Protocol.\n - TCP: Transmission Control Protocol.\n" }, "SatelliteBackhaulCategory":{ "anyOf":[ { "type":"string", "enum":[ "GEO", "MEO", "LEO", "OTHER_SAT", "NON_SATELLITE" ] }, { "type":"string" } ], "description":"Indicates the used satellite backhaul." }, "SatelliteBackhaulCategoryRm":{ "anyOf":[ { "$ref":"#/components/schemas/SatelliteBackhaulCategory" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"Provides information about the satellite backhaul, but with OpenAPI as 'nullable: true' property. \n" }, "SubscribedDefaultQos":{ "type":"object", "required":[ "5qi", "arp" ], "properties":{ "5qi":{ "$ref":"#/components/schemas/5Qi" }, "arp":{ "$ref":"#/components/schemas/Arp" }, "priorityLevel":{ "$ref":"#/components/schemas/5QiPriorityLevel" } }, "description":"Provides the subscribed 5QI and the ARP. It may also contain the priority level." }, "Snssai":{ "type":"object", "properties":{ "sst":{ "type":"integer", "minimum":0, "maximum":255, "description":"Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501. \n" }, "sd":{ "type":"string", "pattern":"^[A-Fa-f0-9]{6}$", "description":"3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.\n" } }, "description":"When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit \"sst\" optionally followed by \"-\" and 6 hexadecimal digit \"sd\".\n", "required":[ "sst" ] }, "PlmnId":{ "type":"object", "properties":{ "mcc":{ "$ref":"#/components/schemas/Mcc" }, "mnc":{ "$ref":"#/components/schemas/Mnc" } }, "description":"When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit \"mcc\" followed by \"-\" and two or three digit \"mnc\".\n", "required":[ "mcc", "mnc" ] }, "PlmnIdRm":{ "anyOf":[ { "$ref":"#/components/schemas/PlmnId" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'PlmnId' data type, but with OpenAPI as 'nullable: true' property. \n" }, "Tai":{ "description":"Contains the tracking area identity as described in 3GPP 23.003.", "type":"object", "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "tac":{ "$ref":"#/components/schemas/Tac" }, "nid":{ "$ref":"#/components/schemas/Nid" } }, "required":[ "plmnId", "tac" ] }, "TaiRm":{ "anyOf":[ { "$ref":"#/components/schemas/Tai" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'Tai' data type, but with OpenAPI as 'nullable: true' property. \n" }, "Ecgi":{ "description":"Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.", "type":"object", "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "eutraCellId":{ "$ref":"#/components/schemas/EutraCellId" }, "nid":{ "$ref":"#/components/schemas/Nid" } }, "required":[ "plmnId", "eutraCellId" ] }, "EcgiRm":{ "anyOf":[ { "$ref":"#/components/schemas/Ecgi" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'Ecgi' data type, but with OpenAPI as 'nullable: true' property.\n" }, "Ncgi":{ "description":"Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.", "type":"object", "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "nrCellId":{ "$ref":"#/components/schemas/NrCellId" }, "nid":{ "$ref":"#/components/schemas/Nid" } }, "required":[ "plmnId", "nrCellId" ] }, "NcgiRm":{ "anyOf":[ { "$ref":"#/components/schemas/Ncgi" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'Ncgi' data type, but with OpenAPI as 'nullable: true' property. \n" }, "UserLocation":{ "type":"object", "properties":{ "eutraLocation":{ "$ref":"#/components/schemas/EutraLocation" }, "nrLocation":{ "$ref":"#/components/schemas/NrLocation" }, "n3gaLocation":{ "$ref":"#/components/schemas/N3gaLocation" }, "utraLocation":{ "$ref":"#/components/schemas/UtraLocation" }, "geraLocation":{ "$ref":"#/components/schemas/GeraLocation" } }, "description":"At least one of eutraLocation, nrLocation, and n3gaLocation should be present, though multiple may be included.\n" }, "EutraLocation":{ "description":"Contains the E-UTRA user location.", "type":"object", "properties":{ "tai":{ "$ref":"#/components/schemas/Tai" }, "ignoreTai":{ "type":"boolean", "default":false }, "ecgi":{ "$ref":"#/components/schemas/Ecgi" }, "ignoreEcgi":{ "type":"boolean", "default":false, "description":"This flag should indicate that the Ecgi should be ignored. When present, it should be set as follows: - true: ecgi should be ignored. - false (default): ecgi should not be ignored.\n" }, "ageOfLocationInformation":{ "type":"integer", "minimum":0, "maximum":32767, "description":"The value represents the elapsed time in minutes since the last network contact of the mobile station. Value \"0\" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than \"0\" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.\n" }, "ueLocationTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "geographicalInformation":{ "type":"string", "pattern":"^[0-9A-F]{16}$", "description":"Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" }, "geodeticInformation":{ "type":"string", "pattern":"^[0-9A-F]{20}$", "description":"Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" }, "globalNgenbId":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "globalENbId":{ "$ref":"#/components/schemas/GlobalRanNodeId" } }, "required":[ "tai", "ecgi" ] }, "EutraLocationRm":{ "anyOf":[ { "$ref":"#/components/schemas/EutraLocation" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'EutraLocation' data type, but with OpenAPI as 'nullable: true' property. \n" }, "NrLocation":{ "description":"Contains the NR user location.", "type":"object", "properties":{ "tai":{ "$ref":"#/components/schemas/Tai" }, "ncgi":{ "$ref":"#/components/schemas/Ncgi" }, "ignoreNcgi":{ "type":"boolean", "default":false }, "ageOfLocationInformation":{ "type":"integer", "minimum":0, "maximum":32767, "description":"The value represents the elapsed time in minutes since the last network contact of the mobile station. Value \"0\" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than \"0\" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.\n" }, "ueLocationTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "geographicalInformation":{ "type":"string", "pattern":"^[0-9A-F]{16}$", "description":"Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" }, "geodeticInformation":{ "type":"string", "pattern":"^[0-9A-F]{20}$", "description":"Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" }, "globalGnbId":{ "$ref":"#/components/schemas/GlobalRanNodeId" } }, "required":[ "tai", "ncgi" ] }, "NrLocationRm":{ "anyOf":[ { "$ref":"#/components/schemas/NrLocation" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'NrLocation' data type, but with OpenAPI as 'nullable: true' property.\" \n" }, "N3gaLocation":{ "description":"Contains the Non-3GPP access user location.", "type":"object", "properties":{ "n3gppTai":{ "$ref":"#/components/schemas/Tai" }, "n3IwfId":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"This IE should contain the N3IWF identifier received over NGAP and should be encoded as a string of hexadecimal characters. Each character in the string should take a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string. \n" }, "ueIpv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ueIpv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "portNumber":{ "$ref":"#/components/schemas/Uinteger" }, "protocol":{ "$ref":"#/components/schemas/TransportProtocol" }, "tnapId":{ "$ref":"#/components/schemas/TnapId" }, "twapId":{ "$ref":"#/components/schemas/TwapId" }, "hfcNodeId":{ "$ref":"#/components/schemas/HfcNodeId" }, "gli":{ "$ref":"#/components/schemas/Gli" }, "w5gbanLineType":{ "$ref":"#/components/schemas/LineType" }, "gci":{ "$ref":"#/components/schemas/Gci" } } }, "UpSecurity":{ "description":"Contains Userplain security information.", "type":"object", "properties":{ "upIntegr":{ "$ref":"#/components/schemas/UpIntegrity" }, "upConfid":{ "$ref":"#/components/schemas/UpConfidentiality" } }, "required":[ "upIntegr", "upConfid" ] }, "UpSecurityRm":{ "anyOf":[ { "$ref":"#/components/schemas/UpSecurity" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'UpSecurity' data type, but with OpenAPI as 'nullable: true' property.\n" }, "NgApCause":{ "description":"Represents the NGAP cause.", "type":"object", "properties":{ "group":{ "$ref":"#/components/schemas/Uinteger" }, "value":{ "$ref":"#/components/schemas/Uinteger" } }, "required":[ "group", "value" ] }, "BackupAmfInfo":{ "description":"Provides details of the Backup AMF.", "type":"object", "properties":{ "backupAmf":{ "$ref":"#/components/schemas/AmfName" }, "guamiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Guami" }, "minItems":1, "description":"If present, this IE should contain the list of GUAMI(s) supported by the AMF to which the backupAmf IE applies.\n" } }, "required":[ "backupAmf" ] }, "RefToBinaryData":{ "description":"This parameter provides information about the referenced binary body data.", "type":"object", "properties":{ "contentId":{ "type":"string", "description":"This IE should contain the value of the Content-ID header of the referenced binary body part.\n" } }, "required":[ "contentId" ] }, "RefToBinaryDataRm":{ "anyOf":[ { "$ref":"#/components/schemas/RefToBinaryData" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'RefToBinaryData' data type, but with OpenAPI as 'nullable: true' property. \n" }, "RouteToLocation":{ "type":"object", "properties":{ "dnai":{ "$ref":"#/components/schemas/Dnai" }, "routeInfo":{ "$ref":"#/components/schemas/RouteInformation" }, "routeProfId":{ "type":"string", "nullable":true, "description":"Identifies the routing profile ID." } }, "required":[ "dnai" ], "anyOf":[ { "required":[ "routeInfo" ] }, { "required":[ "routeProfId" ] } ], "nullable":true, "description":"At least one of the \"routeInfo\" attribute and the \"routeProfId\" attribute should be included in the \"RouteToLocation\" data type.\n" }, "RouteInformation":{ "type":"object", "properties":{ "ipv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "portNumber":{ "$ref":"#/components/schemas/Uinteger" } }, "required":[ "portNumber" ], "nullable":true, "description":"At least one of the \"ipv4Addr\" attribute and the \"ipv6Addr\" attribute should be included in the \"RouteInformation\" data type. \n" }, "Area":{ "description":"Provides area information.", "type":"object", "oneOf":[ { "required":[ "tacs" ] }, { "required":[ "areaCode" ] } ], "properties":{ "tacs":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tac" }, "minItems":1 }, "areaCode":{ "$ref":"#/components/schemas/AreaCode" } } }, "ServiceAreaRestriction":{ "description":"Provides information about allowed or restricted areas.", "type":"object", "properties":{ "restrictionType":{ "$ref":"#/components/schemas/RestrictionType" }, "areas":{ "type":"array", "items":{ "$ref":"#/components/schemas/Area" } }, "maxNumOfTAs":{ "$ref":"#/components/schemas/Uinteger" }, "maxNumOfTAsForNotAllowedAreas":{ "$ref":"#/components/schemas/Uinteger" } }, "allOf":[ { "oneOf":[ { "not":{ "required":[ "restrictionType" ] } }, { "required":[ "areas" ] } ] }, { "anyOf":[ { "not":{ "required":[ "restrictionType" ], "properties":{ "restrictionType":{ "type":"string", "enum":[ "NOT_ALLOWED_AREAS" ] } } } }, { "not":{ "required":[ "maxNumOfTAs" ] } } ] }, { "anyOf":[ { "not":{ "required":[ "restrictionType" ], "properties":{ "restrictionType":{ "type":"string", "enum":[ "ALLOWED_AREAS" ] } } } }, { "not":{ "required":[ "maxNumOfTAsForNotAllowedAreas" ] } } ] } ] }, "PresenceInfo":{ "type":"object", "properties":{ "praId":{ "type":"string", "description":"Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges: 0 to 8 388 607 for UE-dedicated PRA. 8 388 608 to 16 777 215 for Core Network predefined PRA. Examples: PRA ID 123 is encoded as \"123\". PRA ID 11 238 660 is encoded as \"11238660\".\n" }, "additionalPraId":{ "type":"string", "description":"This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE. \n" }, "presenceState":{ "$ref":"#/components/schemas/PresenceState" }, "trackingAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tai" }, "minItems":1, "description":"Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI. \n" }, "ecgiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ecgi" }, "minItems":1, "description":"Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs. \n" }, "ncgiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ncgi" }, "minItems":1, "description":"Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs. \n" }, "globalRanNodeIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "minItems":1, "description":"Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers. \n" }, "globaleNbIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "minItems":1, "description":"Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.\n" } }, "description":"If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.\n" }, "PresenceInfoRm":{ "type":"object", "properties":{ "praId":{ "type":"string", "description":"Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges:\n- 0 to 8 388 607 for UE-dedicated PRA.\n- 8 388 608 to 16 777 215 for Core Network predefined PRA.\nExamples:\nPRA ID 123 is encoded as \"123\".\nPRA ID 11 238 660 is encoded as \"11238660\".\n" }, "additionalPraId":{ "type":"string", "description":"This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.\n" }, "presenceState":{ "$ref":"#/components/schemas/PresenceState" }, "trackingAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tai" }, "minItems":0, "description":"Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI should be the N3GPP TAI.\n" }, "ecgiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ecgi" }, "minItems":0, "description":"Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.\n" }, "ncgiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ncgi" }, "minItems":0, "description":"Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.\n" }, "globalRanNodeIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "description":"Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.\n" }, "globaleNbIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "minItems":1, "description":"Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.\n" } }, "nullable":true, "description":"This data type is defined in the same way as the 'PresenceInfo' data type, but with OpenAPI as 'nullable: true' property. If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE. \n" }, "GlobalRanNodeId":{ "type":"object", "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "n3IwfId":{ "$ref":"#/components/schemas/N3IwfId" }, "gNbId":{ "$ref":"#/components/schemas/GNbId" }, "ngeNbId":{ "$ref":"#/components/schemas/NgeNbId" }, "wagfId":{ "$ref":"#/components/schemas/WAgfId" }, "tngfId":{ "$ref":"#/components/schemas/TngfId" }, "nid":{ "$ref":"#/components/schemas/Nid" }, "eNbId":{ "$ref":"#/components/schemas/ENbId" } }, "oneOf":[ { "required":[ "n3IwfId" ] }, { "required":[ "gNbId" ] }, { "required":[ "ngeNbId" ] }, { "required":[ "wagfId" ] }, { "required":[ "tngfId" ] }, { "required":[ "eNbId" ] } ], "description":"One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.\n", "required":[ "plmnId" ] }, "GNbId":{ "description":"Provides the G-NB identifier.", "type":"object", "properties":{ "bitLength":{ "type":"integer", "minimum":22, "maximum":32, "description":"Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32.\n" }, "gNBValue":{ "type":"string", "pattern":"^[A-Fa-f0-9]{6,8}$", "description":"This represents the identifier of the gNB. The value of the gNB ID should be encoded in hexadecimal format. Each character in the string should take a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, with the most significant character representing the padding 0. If required together, the 4 most significant bits of the gNB ID should appear first in the string, and the character representing the 4 least significant bit of the gNB ID should appear last in the string.\n" } }, "required":[ "bitLength", "gNBValue" ] }, "AtsssCapability":{ "description":"Containes Capability to support procedures related to Access Traffic Steering, Switching, and Splitting.\n", "type":"object", "properties":{ "atsssLL":{ "type":"boolean", "default":false, "description":"Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported\n" }, "mptcp":{ "type":"boolean", "default":false, "description":"Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported\n" }, "rttWithoutPmf":{ "type":"boolean", "default":false, "description":"This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501). true: Supported false (default): Not Supported\n" } } }, "PlmnIdNid":{ "description":"Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.\n", "type":"object", "required":[ "mcc", "mnc" ], "properties":{ "mcc":{ "$ref":"#/components/schemas/Mcc" }, "mnc":{ "$ref":"#/components/schemas/Mnc" }, "nid":{ "$ref":"#/components/schemas/Nid" } } }, "PlmnIdNidRm":{ "anyOf":[ { "$ref":"#/components/schemas/PlmnIdNid" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'PlmnIdNid' data type, but with OpenAPI as 'nullable: true' property.\n" }, "SmallDataRateStatus":{ "description":"It indicates theSmall Data Rate Control Status.", "type":"object", "properties":{ "remainPacketsUl":{ "type":"integer", "minimum":0, "description":"When present, it should contain the number of packets that the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501).\n" }, "remainPacketsDl":{ "type":"integer", "minimum":0, "description":"When present, it should contain the number of packets that the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501).\n" }, "validityTime":{ "$ref":"#/components/schemas/DateTime" }, "remainExReportsUl":{ "type":"integer", "minimum":0, "description":"When present, it should indicate the number of additional exception reports that the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501).\n" }, "remainExReportsDl":{ "type":"integer", "minimum":0, "description":"When present, it should indicate the number of additional exception reports that the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 in 3GPP TS 23.501).\n" } } }, "HfcNodeId":{ "description":"Represents the HFC Node Identifer received over NGAP.", "type":"object", "required":[ "hfcNId" ], "properties":{ "hfcNId":{ "$ref":"#/components/schemas/HfcNId" } } }, "HfcNodeIdRm":{ "anyOf":[ { "$ref":"#/components/schemas/HfcNodeId" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'HfcNodeId' data type, but with OpenAPI as 'nullable: true' property.\n" }, "WirelineArea":{ "type":"object", "properties":{ "globalLineIds":{ "type":"array", "items":{ "$ref":"#/components/schemas/Gli" }, "minItems":1 }, "hfcNIds":{ "type":"array", "items":{ "$ref":"#/components/schemas/HfcNId" }, "minItems":1 }, "areaCodeB":{ "$ref":"#/components/schemas/AreaCode" }, "areaCodeC":{ "$ref":"#/components/schemas/AreaCode" } }, "description":"Exactly one of the \"globLineIds\", \"hfcNIds\", \"areaCodeB\", and \"areaCodeC\" attributes must be included in a WirelineArea data structure.\n" }, "WirelineServiceAreaRestriction":{ "type":"object", "properties":{ "restrictionType":{ "$ref":"#/components/schemas/RestrictionType" }, "areas":{ "type":"array", "items":{ "$ref":"#/components/schemas/WirelineArea" } } }, "description":"The \"restrictionType\" attribute and the \"areas\" attribute should either both be present or both be absent. The empty array of areas is used when the service is allowed or restricted nowhere.\n" }, "ApnRateStatus":{ "description":"Contains the APN rate control status, for example, of the AMF.", "type":"object", "properties":{ "remainPacketsUl":{ "type":"integer", "minimum":0, "description":"When present, it should contain the number of packets that the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN see clause 4.7.7.3 in 3GPP TS 23.401).\n" }, "remainPacketsDl":{ "type":"integer", "minimum":0, "description":"When present, it should contain the number of packets that the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN see clause 4.7.7.3 in 3GPP TS 23.401).\n" }, "validityTime":{ "$ref":"#/components/schemas/DateTime" }, "remainExReportsUl":{ "type":"integer", "minimum":0, "description":"When present, it should indicate the number of additional exception reports that the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN see clause 4.7.7.3 in 3GPP TS 23.401).\n" }, "remainExReportsDl":{ "type":"integer", "minimum":0, "description":"When present, it should indicate the number of additional exception reports that the AF is allowed to send downlink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401).\n" } } }, "ScheduledCommunicationTime":{ "description":"Identifies time and day of the week when the UE is available for communication.", "type":"object", "properties":{ "daysOfWeek":{ "type":"array", "items":{ "$ref":"#/components/schemas/DayOfWeek" }, "minItems":1, "maxItems":6, "description":"Identifies the day(s) of the week. If absent, it indicates every day of the week.\n" }, "timeOfDayStart":{ "$ref":"#/components/schemas/TimeOfDay" }, "timeOfDayEnd":{ "$ref":"#/components/schemas/TimeOfDay" } } }, "ScheduledCommunicationTimeRm":{ "anyOf":[ { "$ref":"#/components/schemas/ScheduledCommunicationTime" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'ScheduledCommunicationTime' data type, but with OpenAPI as 'nullable: true' property.\n" }, "BatteryIndication":{ "type":"object", "properties":{ "batteryInd":{ "type":"boolean", "description":"This IE should indicate whether the UE is battery powered or not. true: The UE is battery powered. false or absent: The UE is not battery powered.\n" }, "replaceableInd":{ "type":"boolean", "description":"This IE should indicate whether the battery of the UE is replaceable or not. true: The battery of the UE is replaceable. false or absent: The battery of the UE is not replaceable.\n" }, "rechargeableInd":{ "type":"boolean", "description":"This IE should indicate whether the battery of the UE is rechargeable or not. true: The battery of UE is rechargeable. false or absent: The battery of the UE is not rechargeable.\n" } }, "description":"The arameters \"replaceableInd\" and \"rechargeableInd\" are included only if the value of the parameter \"batteryInd\" is true.\n" }, "BatteryIndicationRm":{ "anyOf":[ { "$ref":"#/components/schemas/BatteryIndication" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'BatteryIndication' data type, but with OpenAPI as 'nullable: true' property.\n" }, "AcsInfo":{ "description":"The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369.", "type":"object", "properties":{ "acsUrl":{ "$ref":"#/components/schemas/Uri" }, "acsIpv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "acsIpv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" } } }, "AcsInfoRm":{ "anyOf":[ { "$ref":"#/components/schemas/AcsInfo" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'AcsInfo' data type, but with OpenAPI as 'nullable: true' property.\n" }, "NrV2xAuth":{ "description":"Contains NR V2X services authorized information.", "type":"object", "properties":{ "vehicleUeAuth":{ "$ref":"#/components/schemas/UeAuth" }, "pedestrianUeAuth":{ "$ref":"#/components/schemas/UeAuth" } } }, "LteV2xAuth":{ "description":"Contains LTE V2X services authorized information.", "type":"object", "properties":{ "vehicleUeAuth":{ "$ref":"#/components/schemas/UeAuth" }, "pedestrianUeAuth":{ "$ref":"#/components/schemas/UeAuth" } } }, "Pc5QoSPara":{ "description":"Contains policy data on the PC5 QoS parameters.", "type":"object", "required":[ "pc5QosFlowList" ], "properties":{ "pc5QosFlowList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Pc5QosFlowItem" } }, "pc5LinkAmbr":{ "$ref":"#/components/schemas/BitRate" } } }, "Pc5QosFlowItem":{ "description":"Contains a PC5 QOS flow.", "type":"object", "required":[ "pqi" ], "properties":{ "pqi":{ "$ref":"#/components/schemas/5Qi" }, "pc5FlowBitRates":{ "$ref":"#/components/schemas/Pc5FlowBitRates" }, "range":{ "$ref":"#/components/schemas/Uinteger" } } }, "Pc5FlowBitRates":{ "description":"It should represent the PC5 Flow Bit Rates.", "type":"object", "properties":{ "guaFbr":{ "$ref":"#/components/schemas/BitRate" }, "maxFbr":{ "$ref":"#/components/schemas/BitRate" } } }, "UtraLocation":{ "type":"object", "oneOf":[ { "required":[ "cgi" ] }, { "required":[ "sai" ] }, { "required":[ "lai" ] } ], "description":"Exactly one of \"cgi\", \"sai\", or \"lai\" should be present.", "properties":{ "cgi":{ "$ref":"#/components/schemas/CellGlobalId" }, "sai":{ "$ref":"#/components/schemas/ServiceAreaId" }, "lai":{ "$ref":"#/components/schemas/LocationAreaId" }, "rai":{ "$ref":"#/components/schemas/RoutingAreaId" }, "ageOfLocationInformation":{ "type":"integer", "minimum":0, "maximum":32767, "description":"The value represents the elapsed time in minutes since the last network contact of the mobile station. Value \"0\" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode\n or after a successful location reporting procedure when the UE is in connected mode. Any\nother value than \"0\" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.\n" }, "ueLocationTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "geographicalInformation":{ "type":"string", "pattern":"^[0-9A-F]{16}$", "description":"Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" }, "geodeticInformation":{ "type":"string", "pattern":"^[0-9A-F]{20}$", "description":"Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" } } }, "GeraLocation":{ "type":"object", "oneOf":[ { "required":[ "cgi" ] }, { "required":[ "sai" ] }, { "required":[ "lai" ] } ], "description":"Exactly one of \"cgi\", \"sai\", or \"lai\" should be present.", "properties":{ "locationNumber":{ "type":"string", "description":"Location number within the PLMN. See 3GPP TS 23.003, clause 4.5." }, "cgi":{ "$ref":"#/components/schemas/CellGlobalId" }, "sai":{ "$ref":"#/components/schemas/ServiceAreaId" }, "lai":{ "$ref":"#/components/schemas/LocationAreaId" }, "rai":{ "$ref":"#/components/schemas/RoutingAreaId" }, "vlrNumber":{ "type":"string", "description":"VLR number. See 3GPP TS 23.003 clause 5.1." }, "mscNumber":{ "type":"string", "description":"MSC number. See 3GPP TS 23.003 clause 5.1." }, "ageOfLocationInformation":{ "type":"integer", "minimum":0, "maximum":32767, "description":"The value represents the elapsed time in minutes since the last network contact of the mobile station. Value \"0\" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than \"0\" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.\n" }, "ueLocationTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "geographicalInformation":{ "type":"string", "pattern":"^[0-9A-F]{16}$", "description":"Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" }, "geodeticInformation":{ "type":"string", "pattern":"^[0-9A-F]{20}$", "description":"Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.\n" } } }, "CellGlobalId":{ "description":"Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.", "type":"object", "required":[ "plmnId", "lac", "cellId" ], "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "lac":{ "type":"string", "pattern":"^[A-Fa-f0-9]{4}$" }, "cellId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{4}$" } } }, "ServiceAreaId":{ "description":"Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.", "type":"object", "required":[ "plmnId", "lac", "sac" ], "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "lac":{ "type":"string", "pattern":"^[A-Fa-f0-9]{4}$", "description":"Location Area Code." }, "sac":{ "type":"string", "pattern":"^[A-Fa-f0-9]{4}$", "description":"Service Area Code." } } }, "LocationAreaId":{ "description":"Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.", "type":"object", "required":[ "plmnId", "lac" ], "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "lac":{ "type":"string", "pattern":"^[A-Fa-f0-9]{4}$", "description":"Location Area Code." } } }, "RoutingAreaId":{ "description":"Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.", "type":"object", "required":[ "plmnId", "lac", "rac" ], "properties":{ "plmnId":{ "$ref":"#/components/schemas/PlmnId" }, "lac":{ "type":"string", "pattern":"^[A-Fa-f0-9]{4}$", "description":"Location Area Code" }, "rac":{ "type":"string", "pattern":"^[A-Fa-f0-9]{2}$", "description":"Routing Area Code" } } }, "DddTrafficDescriptor":{ "description":"Contains a Traffic Descriptor.", "type":"object", "properties":{ "ipv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "portNumber":{ "$ref":"#/components/schemas/Uinteger" }, "macAddr":{ "$ref":"#/components/schemas/MacAddr48" } } }, "MoExpDataCounter":{ "description":"Contains the MO Exception Data Counter.", "type":"object", "required":[ "counter" ], "properties":{ "counter":{ "type":"integer", "description":"Unsigned integer identifying the MO Exception Data Counter, as specified in clause 5.31.14.3 of 3GPP TS 23.501.\n" }, "timeStamp":{ "$ref":"#/components/schemas/DateTime" } } }, "NssaaStatus":{ "description":"Contains the Subscribed S-NSSAI subject to NSSAA procedure and the status.", "type":"object", "required":[ "snssai", "status" ], "properties":{ "snssai":{ "$ref":"#/components/schemas/Snssai" }, "status":{ "$ref":"#/components/schemas/AuthStatus" } } }, "NssaaStatusRm":{ "anyOf":[ { "$ref":"#/components/schemas/NssaaStatus" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'NssaaStatus' data type, but with OpenAPI as 'nullable: true' property.\n" }, "TnapId":{ "description":"Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.", "type":"object", "properties":{ "ssId":{ "type":"string", "description":"This IE should be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012. \n" }, "bssId":{ "type":"string", "description":"When present, it should contain the BSSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012. \n" }, "civicAddress":{ "$ref":"#/components/schemas/Bytes" } } }, "TnapIdRm":{ "anyOf":[ { "$ref":"#/components/schemas/TnapId" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'TnapId' data type, but with OpenAPI as 'nullable: true' property. \n" }, "TwapId":{ "description":"Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.\n", "type":"object", "required":[ "ssId" ], "properties":{ "ssId":{ "type":"string", "description":"This IE should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012. \n" }, "bssId":{ "type":"string", "description":"When present, it should contain the BSSID of the access point to which the UE is attached for trusted WLAN access. See IEEE Std 802.11-2012. \n" }, "civicAddress":{ "$ref":"#/components/schemas/Bytes" } } }, "TwapIdRm":{ "anyOf":[ { "$ref":"#/components/schemas/TwapId" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'TwapId' data type, but with OpenAPI as 'nullable: true' property.\n" }, "SnssaiExtension":{ "description":"Extensions to the Snssai data type, sdRanges, and wildcardSd should not be present simultaneously.\n", "type":"object", "not":{ "required":[ "sdRanges", "wildcardSd" ] }, "properties":{ "sdRanges":{ "description":"When present, it should contain the range(s) of Slice Differentiator values supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type.\n", "type":"array", "items":{ "$ref":"#/components/schemas/SdRange" }, "minItems":1 }, "wildcardSd":{ "description":"When present, it should be set to true to indicate that all SD values are supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type.\n", "type":"boolean", "enum":[ true ] } } }, "SdRange":{ "description":"A range of SDs (Slice Differentiators).", "type":"object", "properties":{ "start":{ "type":"string", "pattern":"^[A-Fa-f0-9]{6}$", "description":"First value identifying the start of an SD range. This string should be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2.\n" }, "end":{ "type":"string", "pattern":"^[A-Fa-f0-9]{6}$", "description":"Last value identifying the end of an SD range. This string should be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2.\n" } } }, "ProseServiceAuth":{ "description":"Indicates if the UE is authorized to use ProSe related services.\n", "type":"object", "properties":{ "proseDirectDiscoveryAuth":{ "$ref":"#/components/schemas/UeAuth" }, "proseDirectCommunicationAuth":{ "$ref":"#/components/schemas/UeAuth" }, "proseL2RelayAuth":{ "$ref":"#/components/schemas/UeAuth" }, "proseL3RelayAuth":{ "$ref":"#/components/schemas/UeAuth" }, "proseL2RemoteAuth":{ "$ref":"#/components/schemas/UeAuth" }, "proseL3RemoteAuth":{ "$ref":"#/components/schemas/UeAuth" } } }, "EcsServerAddr":{ "description":"Contains the Edge Configuration Server Address Configuration Information as defined in clause 5.2.3.6.1 of 3GPP TS 23.502.\n", "type":"object", "properties":{ "ecsFqdnList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Fqdn" }, "minItems":1 }, "ecsIpAddressList":{ "type":"array", "items":{ "$ref":"#/components/schemas/IpAddr" }, "minItems":1 }, "ecsUriList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Uri" }, "minItems":1 }, "ecsProviderId":{ "type":"string" } } }, "EcsServerAddrRm":{ "anyOf":[ { "$ref":"#/components/schemas/EcsServerAddr" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the ' EcsServerAddr ' data type, but with OpenAPI as 'nullable: true' property.\n" }, "IpAddr":{ "description":"Contains an IP adresse.", "type":"object", "oneOf":[ { "required":[ "ipv4Addr" ] }, { "required":[ "ipv6Addr" ] }, { "required":[ "ipv6Prefix" ] } ], "properties":{ "ipv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "ipv6Prefix":{ "$ref":"#/components/schemas/Ipv6Prefix" } } }, "SACInfo":{ "description":"Represents threshold(s) to control the triggering of network slice reporting notifications or the information contained in the network slice reporting notification.\n", "type":"object", "properties":{ "numericValNumUes":{ "type":"integer" }, "numericValNumPduSess":{ "type":"integer" }, "percValueNumUes":{ "type":"integer", "minimum":0, "maximum":100 }, "percValueNumPduSess":{ "type":"integer", "minimum":0, "maximum":100 } } }, "SACEventStatus":{ "description":"Contains the network slice status information in terms of the current number of UEs registered with a network slice, the current number of PDU Sessions established on a network slice, or both.\n", "type":"object", "properties":{ "reachedNumUes":{ "$ref":"#/components/schemas/SACInfo" }, "reachedNumPduSess":{ "$ref":"#/components/schemas/SACInfo" } } }, "ServerAddressingInfo":{ "description":"Contains addressing information (IP addresses and/or FQDNs) of a server.", "type":"object", "anyOf":[ { "required":[ "ipv4Addresses" ] }, { "required":[ "ipv6Addresses" ] }, { "required":[ "fqdnList" ] } ], "properties":{ "ipv4Addresses":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ipv4Addr" }, "minItems":1 }, "ipv6Addresses":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ipv6Addr" }, "minItems":1 }, "fqdnList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Fqdn" }, "minItems":1 } } }, "PcfUeCallbackInfo":{ "description":"Contains the PCF for the UE information necessary for the PCF for the PDU session to send SM Policy Association Establishment and Termination events.\n", "type":"object", "properties":{ "callbackUri":{ "$ref":"#/components/schemas/Uri" }, "bindingInfo":{ "type":"string" } }, "nullable":true, "required":[ "callbackUri" ] }, "PduSessionInfo":{ "description":"Indicates the DNN and S-NSSAI combination of a PDU session.", "type":"object", "properties":{ "snssai":{ "$ref":"#/components/schemas/Snssai" }, "dnn":{ "$ref":"#/components/schemas/Dnn" } }, "required":[ "dnn", "snssai" ] }, "EasIpReplacementInfo":{ "description":"Contains EAS IP replacement information for a Source and a Target EAS.", "type":"object", "properties":{ "source":{ "$ref":"#/components/schemas/EasServerAddress" }, "target":{ "$ref":"#/components/schemas/EasServerAddress" } }, "required":[ "source", "target" ] }, "EasServerAddress":{ "description":"Represents the IP address and the port of an EAS server.", "type":"object", "properties":{ "ip":{ "$ref":"#/components/schemas/IpAddr" }, "port":{ "$ref":"#/components/schemas/Uinteger" } }, "required":[ "ip", "port" ] }, "RoamingRestrictions":{ "description":"Indicates if access is provided to a given serving network, for example, a PLMN (MCC, MNC), or a SNPN (MCC, MNC, NID).\n", "type":"object", "properties":{ "accessAllowed":{ "type":"boolean" } } }, "ExtSnssai":{ "allOf":[ { "$ref":"#/components/schemas/Snssai" }, { "$ref":"#/components/schemas/SnssaiExtension" } ], "description":"The \"sdRanges\" and \"wildcardSd\" attributes should be exclusive from each other. If one of these attributes is present, the sd attribute should also be present, and it should contain one Slice Differentiator value within the range of SD (if the \"sdRanges\" attribute is present) or with any value (if the \"wildcardSd\" attribute is present).\n" }, "Qfi":{ "type":"integer", "minimum":0, "maximum":63, "description":"Unsigned integer identifying a QoS flow within the range 0 to 63." }, "QfiRm":{ "type":"integer", "minimum":0, "maximum":63, "nullable":true, "description":"This data type is defined in the same way as the 'Qfi' data type, but with OpenAPI as 'nullable: true' property.\n" }, "5Qi":{ "type":"integer", "minimum":0, "maximum":255, "description":"Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.\n" }, "5QiRm":{ "type":"integer", "minimum":0, "maximum":255, "nullable":true, "description":"This data type is defined in the same way as the '5QiPriorityLevel' data type, but OpenAPI as 'nullable: true' property. \"\n" }, "BitRate":{ "type":"string", "pattern":"^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$", "description":"String representing a bit rate. The prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that the prefix \"K\" is used to represent the standard symbol \"k\".\n" }, "BitRateRm":{ "type":"string", "pattern":"^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$", "nullable":true, "description":"This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.\n" }, "ArpPriorityLevelRm":{ "type":"integer", "minimum":1, "maximum":15, "nullable":true, "description":"This data type is defined in the same way as the 'ArpPriorityLevel' data type, but OpenAPI as 'nullable: true' property.\n" }, "ArpPriorityLevel":{ "type":"integer", "minimum":1, "maximum":15, "nullable":true, "description":"\"nullable: true\" should not be used for this attribute. Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501) within the range 1 to 15. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 15 as the lowest priority. \n" }, "5QiPriorityLevel":{ "type":"integer", "minimum":1, "maximum":127, "description":"Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority. \n" }, "5QiPriorityLevelRm":{ "type":"integer", "minimum":1, "maximum":127, "nullable":true, "description":"This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.\n" }, "PacketDelBudget":{ "type":"integer", "minimum":1, "description":"Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.\n" }, "PacketDelBudgetRm":{ "type":"integer", "minimum":1, "nullable":true, "description":"This data type is defined in the same way as the 'PacketDelBudget' data type, but OpenAPI as 'nullable: true' property.\n" }, "PacketErrRate":{ "type":"string", "pattern":"^([0-9]E-[0-9])$", "description":"String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a \"scalar x 10-k\", where the scalar and the exponent k are encoded as one decimal digit.\n" }, "PacketErrRateRm":{ "type":"string", "pattern":"^([0-9]E-[0-9])$", "nullable":true, "description":"This data type is defined in the same way as the 'PacketErrRate' data type, but with OpenAPI as 'nullable: true' property.\n" }, "PacketLossRate":{ "type":"integer", "minimum":0, "maximum":1000, "description":"Unsigned integer indicating Packet Loss Rate (see clauses 5.7.2.8 and 5.7.4 of 3GPP TS 23.501) expressed in tenth of percent.\n" }, "PacketLossRateRm":{ "type":"integer", "minimum":0, "maximum":1000, "nullable":true, "description":"This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.\n" }, "AverWindow":{ "type":"integer", "minimum":1, "maximum":4095, "default":2000, "description":"Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds." }, "AverWindowRm":{ "type":"integer", "maximum":4095, "default":2000, "minimum":1, "nullable":true, "description":"This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.\n" }, "MaxDataBurstVol":{ "type":"integer", "minimum":1, "maximum":4095, "description":"Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes. \n" }, "MaxDataBurstVolRm":{ "type":"integer", "minimum":1, "maximum":4095, "nullable":true, "description":"This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.\n" }, "SamplingRatio":{ "type":"integer", "minimum":1, "maximum":100, "description":"Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502) expressed in percent. \n" }, "SamplingRatioRm":{ "type":"integer", "minimum":1, "maximum":100, "nullable":true, "description":"This data type is defined in the same way as the 'SamplingRatio' data type, but with OpenAPI as 'nullable: true' property. \n" }, "RgWirelineCharacteristics":{ "$ref":"#/components/schemas/Bytes" }, "RgWirelineCharacteristicsRm":{ "anyOf":[ { "$ref":"#/components/schemas/RgWirelineCharacteristics" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'RgWirelineCharacteristics' data type, but with OpenAPI as 'nullable: true' property.\n" }, "ExtMaxDataBurstVol":{ "type":"integer", "minimum":4096, "maximum":2000000, "description":"Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes. \n" }, "ExtMaxDataBurstVolRm":{ "type":"integer", "minimum":4096, "maximum":2000000, "nullable":true, "description":"This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.\n" }, "ExtPacketDelBudget":{ "type":"integer", "minimum":1, "description":"Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8]) expressed in 0.01 milliseconds.\n" }, "ExtPacketDelBudgetRm":{ "type":"integer", "minimum":1, "nullable":true, "description":"This data type is defined in the same way as the 'ExtPacketDelBudget' data type, but with OpenAPI as 'nullable: true' property.\n" }, "PreemptionCapability":{ "type":"string", "enum":[ "NOT_PREEMPT", "MAY_PREEMPT" ], "description":"The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.1-1.\n" }, "PreemptionCapabilityRm":{ "anyOf":[ { "$ref":"#/components/schemas/PreemptionCapability" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'PreemptionCapability' enumeration, but with OpenAPI as 'nullable: true' property.\n" }, "PreemptionVulnerability":{ "type":"string", "enum":[ "NOT_PREEMPTABLE", "PREEMPTABLE" ], "description":"The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.2-1.\n" }, "PreemptionVulnerabilityRm":{ "anyOf":[ { "$ref":"#/components/schemas/PreemptionVulnerability" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'PreemptionVulnerability' enumeration, but with OpenAPI as 'nullable: true' property.\" \n" }, "ReflectiveQoSAttribute":{ "anyOf":[ { "type":"string", "enum":[ "RQOS", "NO_RQOS" ] }, { "type":"string" } ], "description":"The enumeration ReflectiveQosAttribute indicates whether certain traffic of the QoS flow may be subject to Reflective QoS (see clause 5.7.2.3 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.3-1. \n" }, "ReflectiveQoSAttributeRm":{ "anyOf":[ { "$ref":"#/components/schemas/ReflectiveQoSAttribute" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'ReflectiveQosAttribute' enumeration, but with OpenAPI as 'nullable: true' property. \"\n" }, "NotificationControl":{ "anyOf":[ { "type":"string", "enum":[ "REQUESTED", "NOT_REQUESTED" ] }, { "type":"string" } ], "description":"The enumeration NotificationControl indicates if the notifications are requested from the RAN when the GFBR can no longer (or again) be fulfilled for a QoS Flow during the lifetime of the QoS Flow (see clause 5.7.2.4 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.5-1. \n" }, "NotificationControlRm":{ "anyOf":[ { "$ref":"#/components/schemas/NotificationControl" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'NotificationControl' enumeration, but with OpenAPI as 'nullable: true' property.\n" }, "QosResourceType":{ "type":"string", "enum":[ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ], "description":"The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.6-1.\n" }, "QosResourceTypeRm":{ "anyOf":[ { "$ref":"#/components/schemas/QosResourceType" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'QosResourceType' enumeration, but with OpenAPI as 'nullable: true' property. \"\n" }, "AdditionalQosFlowInfo":{ "anyOf":[ { "anyOf":[ { "type":"string", "enum":[ "MORE_LIKELY" ] }, { "type":"string" } ] }, { "$ref":"#/components/schemas/NullValue" } ], "description":"The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause 9.3.1.12 3GPP TS 38.413 [11]). It should comply with the provisions defined in table 5.5.3.12-1.\n" }, "PartitioningCriteria":{ "anyOf":[ { "type":"string", "enum":[ "TAC", "SUBPLMN", "GEOAREA", "SNSSAI", "DNN" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are:\n- \"TAC\": Type Allocation Code\n- \"SUBPLMN\": Subscriber PLMN ID\n- \"GEOAREA\": Geographical area, i.e. list(s) of TAI(s)\n- \"SNSSAI\": S-NSSAI\n- \"DNN\": DNN\n" }, "PartitioningCriteriaRm":{ "anyOf":[ { "$ref":"#/components/schemas/PartitioningCriteria" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'PartitioningCriteria' data type, but with OpenAPI as 'nullable: true' property.\n" }, "Arp":{ "description":"Contains Allocation and Retention Priority information.", "type":"object", "properties":{ "priorityLevel":{ "$ref":"#/components/schemas/ArpPriorityLevel" }, "preemptCap":{ "$ref":"#/components/schemas/PreemptionCapability" }, "preemptVuln":{ "$ref":"#/components/schemas/PreemptionVulnerability" } }, "required":[ "priorityLevel", "preemptCap", "preemptVuln" ] }, "Ambr":{ "description":"Contains the maximum aggregated uplink and downlink bit rates.", "type":"object", "properties":{ "uplink":{ "$ref":"#/components/schemas/BitRate" }, "downlink":{ "$ref":"#/components/schemas/BitRate" } }, "required":[ "uplink", "downlink" ] }, "Dynamic5Qi":{ "description":"It indicates the QoS Characteristics for a Non-standardised or not pre-configured 5QI for downlink and uplink.\n", "type":"object", "properties":{ "resourceType":{ "$ref":"#/components/schemas/QosResourceType" }, "priorityLevel":{ "$ref":"#/components/schemas/5QiPriorityLevel" }, "packetDelayBudget":{ "$ref":"#/components/schemas/PacketDelBudget" }, "packetErrRate":{ "$ref":"#/components/schemas/PacketErrRate" }, "averWindow":{ "$ref":"#/components/schemas/AverWindow" }, "maxDataBurstVol":{ "$ref":"#/components/schemas/MaxDataBurstVol" }, "extMaxDataBurstVol":{ "$ref":"#/components/schemas/ExtMaxDataBurstVol" }, "extPacketDelBudget":{ "$ref":"#/components/schemas/ExtPacketDelBudget" }, "cnPacketDelayBudgetDl":{ "$ref":"#/components/schemas/ExtPacketDelBudget" }, "cnPacketDelayBudgetUl":{ "$ref":"#/components/schemas/ExtPacketDelBudget" } }, "required":[ "resourceType", "priorityLevel", "packetDelayBudget", "packetErrRate" ] }, "NonDynamic5Qi":{ "description":"It indicates the QoS Characteristics for a standardized or pre-configured 5QI for downlink and uplink.\n", "type":"object", "properties":{ "priorityLevel":{ "$ref":"#/components/schemas/5QiPriorityLevel" }, "averWindow":{ "$ref":"#/components/schemas/AverWindow" }, "maxDataBurstVol":{ "$ref":"#/components/schemas/MaxDataBurstVol" }, "extMaxDataBurstVol":{ "$ref":"#/components/schemas/ExtMaxDataBurstVol" }, "cnPacketDelayBudgetDl":{ "$ref":"#/components/schemas/ExtPacketDelBudget" }, "cnPacketDelayBudgetUl":{ "$ref":"#/components/schemas/ExtPacketDelBudget" } }, "minProperties":0 }, "ArpRm":{ "anyOf":[ { "$ref":"#/components/schemas/Arp" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'Arp' data type, but with OpenAPI as 'nullable: true' property.\n" }, "AmbrRm":{ "anyOf":[ { "$ref":"#/components/schemas/Ambr" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This data type is defined in the same way as the 'Ambr' data type, but with OpenAPI as 'nullable: true' property.\n" }, "SliceMbr":{ "description":"MBR related to slice.", "type":"object", "properties":{ "uplink":{ "$ref":"#/components/schemas/BitRate" }, "downlink":{ "$ref":"#/components/schemas/BitRate" } }, "required":[ "uplink", "downlink" ] }, "SliceMbrRm":{ "description":"SliceMbr with 'nullable:true'.", "anyOf":[ { "$ref":"#/components/schemas/SliceMbr" }, { "$ref":"#/components/schemas/NullValue" } ] }, "PhysCellId":{ "type":"integer", "minimum":0, "maximum":1007, "description":"Integer value identifying the physical cell identity (PCI) as definition of \"PhysCellId\" IE in clause 6.3.2 of 3GPP TS 38.331.\n" }, "ArfcnValueNR":{ "type":"integer", "minimum":0, "maximum":3279165, "description":"Integer value indicating the ARFCN applicable for a downlink, uplink, or bi-directional (TDD) NR global frequency raster as definition of \"ARFCN-ValueNR\" IE in clause 6.3.2 of 3GPP TS 38.331.\n" }, "TraceDepth":{ "anyOf":[ { "type":"string", "enum":[ "MINIMUM", "MEDIUM", "MAXIMUM", "MINIMUM_WO_VENDOR_EXTENSION", "MEDIUM_WO_VENDOR_EXTENSION", "MAXIMUM_WO_VENDOR_EXTENSION" ] }, { "type":"string" } ], "description":"The enumeration TraceDepth defines how detailed information should be recorded in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.1-1\n" }, "TraceDepthRm":{ "anyOf":[ { "$ref":"#/components/schemas/TraceDepth" }, { "$ref":"#/components/schemas/NullValue" } ], "description":"This enumeration is defined in the same way as the 'TraceDepth' enumeration, but with OpenAPI as 'nullable: true' property.\n" }, "JobType":{ "anyOf":[ { "type":"string", "enum":[ "IMMEDIATE_MDT_ONLY", "LOGGED_MDT_ONLY", "TRACE_ONLY", "IMMEDIATE_MDT_AND_TRACE", "RLF_REPORTS_ONLY", "RCEF_REPORTS_ONLY", "LOGGED_MBSFN_MDT" ] }, { "type":"string" } ], "description":"The enumeration JobType defines Job Type in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.3-1.\n" }, "ReportTypeMdt":{ "anyOf":[ { "type":"string", "enum":[ "PERIODICAL", "EVENT_TRIGGED" ] }, { "type":"string" } ], "description":"The enumeration ReportTypeMdt defines Report Type for logged MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.4-1.\n" }, "MeasurementLteForMdt":{ "anyOf":[ { "type":"string", "enum":[ "M1", "M2", "M3", "M4_DL", "M4_UL", "M5_DL", "M5_UL", "M6_DL", "M6_UL", "M7_DL", "M7_UL", "M8", "M9" ] }, { "type":"string" } ], "description":"The enumeration MeasurementLteForMdt defines Measurements used for MDT in LTE in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.5-1.\n" }, "MeasurementNrForMdt":{ "anyOf":[ { "type":"string", "enum":[ "M1", "M2", "M3", "M4_DL", "M4_UL", "M5_DL", "M5_UL", "M6_DL", "M6_UL", "M7_DL", "M7_UL", "M8", "M9" ] }, { "type":"string" } ], "description":"The enumeration MeasurementNrForMdt defines Measurements used for MDT in NR in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.6-1.\n" }, "SensorMeasurement":{ "anyOf":[ { "type":"string", "enum":[ "BAROMETRIC_PRESSURE", "UE_SPEED", "UE_ORIENTATION" ] }, { "type":"string" } ], "description":"The enumeration SensorMeasurement defines sensor measurement type for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.7-1.\n" }, "ReportingTrigger":{ "anyOf":[ { "type":"string", "enum":[ "PERIODICAL", "EVENT_A2", "EVENT_A2_PERIODIC", "ALL_RRM_EVENT_TRIGGERS" ] }, { "type":"string" } ], "description":"The enumeration ReportingTrigger defines Reporting Triggers for MDT in the trace. See 3GPP TS 32.42 for further description of the values. It should comply with the provisions defined in table 5.6.3.8-1.\n" }, "ReportIntervalMdt":{ "anyOf":[ { "type":"string", "enum":[ 120, 240, 480, 640, 1024, 2048, 5120, 10240, 60000, 360000, 720000, 1800000, 3600000 ] }, { "type":"string" } ], "description":"The enumeration ReportIntervalMdt defines Report Interval for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.9-1.\n" }, "ReportAmountMdt":{ "anyOf":[ { "type":"string", "enum":[ 1, 2, 4, 8, 16, 32, 64, "infinity" ] }, { "type":"string" } ], "description":"The enumeration ReportAmountMdt defines Report Amount for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.10-1.\n" }, "EventForMdt":{ "anyOf":[ { "type":"string", "enum":[ "OUT_OF_COVERAG", "A2_EVENT" ] }, { "type":"string" } ], "description":"The enumeration EventForMdt defines events triggered measurement for logged MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.11-1.\n" }, "LoggingIntervalMdt":{ "anyOf":[ { "type":"string", "enum":[ 128, 256, 512, 1024, 2048, 3072, 4096, 6144 ] }, { "type":"string" } ], "description":"The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.12-1.\n" }, "LoggingDurationMdt":{ "anyOf":[ { "type":"string", "enum":[ 600, 1200, 2400, 3600, 5400, 7200 ] }, { "type":"string" } ], "description":"The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.12-1.\n" }, "PositioningMethodMdt":{ "anyOf":[ { "type":"string", "enum":[ "GNSS", "E_CELL_ID" ] }, { "type":"string" } ], "description":"The enumeration LoggingDurationMdt defines Logging Duration for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.13-1.\n" }, "CollectionPeriodRmmLteMdt":{ "anyOf":[ { "type":"string", "enum":[ 1024, 1280, 2048, 2560, 5120, 10240, 60000 ] }, { "type":"string" } ], "description":"Defines the Collection period for RRM measurements LTE for MDT in the trace. Refer to 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.15-1.\n" }, "MeasurementPeriodLteMdt":{ "anyOf":[ { "type":"string", "enum":[ 1024, 1280, 2048, 2560, 5120, 10240, 60000 ] }, { "type":"string" } ], "description":"Defines Measurement period LTE for MDT in the trace. Refer to 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.16-1.\n" }, "ReportIntervalNrMdt":{ "anyOf":[ { "type":"string", "enum":[ 120, 240, 480, 640, 1024, 2048, 5120, 10240, 20480, 40960, 60000, 360000, 720000, 1800000, 3600000 ] }, { "type":"string" } ], "description":"Defines Report Interval in NR for MDT in the trace. Refer to 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.17-1.\n" }, "LoggingIntervalNrMdt":{ "anyOf":[ { "type":"string", "enum":[ 128, 256, 512, 1024, 2048, 3072, 4096, 6144, 320, 640, "infinity" ] }, { "type":"string" } ], "description":"Defines Logging Interval in NR for MDT in the trace. Refer to 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.18-1.\n" }, "CollectionPeriodRmmNrMdt":{ "anyOf":[ { "type":"string", "enum":[ 1024, 2048, 5120, 10240, 60000 ] }, { "type":"string" } ], "description":"Defines Collection period for RRM measurements NR for MDT in the trace. Refer to 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.19-1\n" }, "LoggingDurationNrMdt":{ "anyOf":[ { "type":"string", "enum":[ 600, 1200, 2400, 3600, 5400, 7200 ] }, { "type":"string" } ], "description":"Defines Logging Duration in NR for MDT in the trace. Refer to 3GPP TS 32.422 for further description of the values. It should comply with the provisions defined in table 5.6.3.20-1.\n" }, "TraceData":{ "description":"Contains trace control and configuration parameters.", "type":"object", "nullable":true, "properties":{ "traceRef":{ "type":"string", "pattern":"^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$", "description":"Trace Reference (Refer 3GPP TS 32.422). It should be encoded as the concatenation of MCC, MNC and Trace ID as follows: - The Trace ID is encoded as a 3 octet string in hexadecimal format. Each character in the Trace ID string takes a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and represents 4 bits. The most significant character represent the 4 most significant bits of the Trace ID appear first in the string, and the character representing the 4 least significant bits of the Trace ID appears last in the string.\n" }, "traceDepth":{ "$ref":"#/components/schemas/TraceDepth" }, "neTypeList":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"List of NE Types (Refer 3GPP TS 32.422). It should be encoded as an octet string in hexadecimal format. Each character in the string takes a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and represents 4 bits. The most significant character representing the 4 most significant bits appear first in the string, and the character representing the 4 least significant bits appear last in the string. Octets should be coded according to 3GPP TS 32.422.\n" }, "eventList":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"Triggering events (Refer 3GPP TS 32.422). It should be encoded as an octet string in hexadecimal representation. Each character in the string takes a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and represents 4 bits. The most significant character representing the 4 most significant bits should appear first in the string, and the character representing the 4 least significant bits should appear last in the string. Octets should be coded according to 3GPP TS 32.422.\n" }, "collectionEntityIpv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "collectionEntityIpv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "traceReportingConsumerUri":{ "$ref":"#/components/schemas/Uri" }, "interfaceList":{ "type":"string", "pattern":"^[A-Fa-f0-9]+$", "description":"List of Interfaces (Refer 3GPP TS 32.422). It should be encoded as an octet string in hexadecimal format. Each character in the string takes a value from \"0\" to \"9\", from \"a\" to \"f\", or from \"A\" to \"F\" and represents 4 bits. The most significant character representing the 4 most significant bits should appear first in the string, and the character representing the 4 least significant bits should appear last in the string. Octets should be coded according to 3GPP TS 32.422. If this attribute is absent, all the interfaces applicable to the list of NE types indicated in the neTypeList attribute should be traced.\n" } }, "required":[ "traceRef", "traceDepth", "neTypeList", "eventList" ] }, "MdtConfiguration":{ "description":"Contains MDT configuration data.", "type":"object", "required":[ "jobType" ], "properties":{ "jobType":{ "$ref":"#/components/schemas/JobType" }, "reportType":{ "$ref":"#/components/schemas/ReportTypeMdt" }, "areaScope":{ "$ref":"#/components/schemas/AreaScope" }, "measurementLteList":{ "type":"array", "items":{ "$ref":"#/components/schemas/MeasurementLteForMdt" } }, "measurementNrList":{ "type":"array", "items":{ "$ref":"#/components/schemas/MeasurementNrForMdt" }, "minItems":1 }, "sensorMeasurementList":{ "type":"array", "items":{ "$ref":"#/components/schemas/SensorMeasurement" }, "minItems":1 }, "reportingTriggerList":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportingTrigger" }, "minItems":1 }, "reportInterval":{ "$ref":"#/components/schemas/ReportIntervalMdt" }, "reportIntervalNr":{ "$ref":"#/components/schemas/ReportIntervalNrMdt" }, "reportAmount":{ "$ref":"#/components/schemas/ReportAmountMdt" }, "eventThresholdRsrp":{ "type":"integer", "minimum":0, "maximum":97, "description":"This IE should be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting. The job type parameter should be configured for Immediate MDT or combined Immediate MDT and Trace in LTE. When present, the IE should indicate the Event Threshold for RSRP, and the value should be between 0-97.\n" }, "eventThresholdRsrpNr":{ "type":"integer", "minimum":0, "maximum":127, "description":"This IE should be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting. The job type parameter should be configured for Immediate MDT or combined Immediate MDT and Trace in NR. When present, the IE should indicate the Event Threshold for RSRP, and the value should be between 0-127.\n" }, "eventThresholdRsrq":{ "type":"integer", "minimum":0, "maximum":34, "description":"This IE should be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting. The job type parameter should be configured for Immediate MDT or combined Immediate MDT and Trace in LTE. When present, the IE should indicate the Event Threshold for RSRQ, and the value should be between 0-34.\n" }, "eventThresholdRsrqNr":{ "type":"integer", "minimum":0, "maximum":127, "description":"This IE should be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting. The job type parameter is configured for Immediate MDT or combined Immediate MDT and Trace in NR. When present, this IE should indicate the Event Threshold for RSRQ, and the value should be between 0-127.\n" }, "eventList":{ "type":"array", "items":{ "$ref":"#/components/schemas/EventForMdt" }, "minItems":1 }, "loggingInterval":{ "$ref":"#/components/schemas/LoggingIntervalMdt" }, "loggingIntervalNr":{ "$ref":"#/components/schemas/LoggingIntervalNrMdt" }, "loggingDuration":{ "$ref":"#/components/schemas/LoggingDurationMdt" }, "loggingDurationNr":{ "$ref":"#/components/schemas/LoggingDurationNrMdt" }, "positioningMethod":{ "$ref":"#/components/schemas/PositioningMethodMdt" }, "addPositioningMethodList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PositioningMethodMdt" }, "minItems":1 }, "collectionPeriodRmmLte":{ "$ref":"#/components/schemas/CollectionPeriodRmmLteMdt" }, "collectionPeriodRmmNr":{ "$ref":"#/components/schemas/CollectionPeriodRmmNrMdt" }, "measurementPeriodLte":{ "$ref":"#/components/schemas/MeasurementPeriodLteMdt" }, "mdtAllowedPlmnIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlmnId" }, "minItems":1, "maxItems":16 }, "mbsfnAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/MbsfnArea" }, "minItems":1, "maxItems":8 }, "interFreqTargetList":{ "type":"array", "items":{ "$ref":"#/components/schemas/InterFreqTargetInfo" }, "minItems":1, "maxItems":8 } } }, "AreaScope":{ "description":"Contains the area based on cells or tracking areas.", "type":"object", "properties":{ "eutraCellIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/EutraCellId" }, "minItems":1 }, "nrCellIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/NrCellId" }, "minItems":1 }, "tacList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tac" }, "minItems":1 }, "tacInfoPerPlmn":{ "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/TacInfo" }, "minProperties":1, "description":"A map (list of key-value pairs) where PlmnId converted to a string serves as key.\n" } } }, "TacInfo":{ "description":"Contains tracking area information (tracking area codes).", "type":"object", "required":[ "tacList" ], "properties":{ "tacList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tac" }, "minItems":1 } } }, "MbsfnArea":{ "description":"Contains an MBSFN area information.", "type":"object", "properties":{ "mbsfnAreaId":{ "type":"integer", "minimum":0, "maximum":255, "description":"This IE should contain the MBSFN Area ID." }, "carrierFrequency":{ "type":"integer", "minimum":0, "maximum":262143, "description":"When present, this IE should contain the Carrier Frequency (EARFCN)." } } }, "InterFreqTargetInfo":{ "description":"Indicates the inter frequency target information.", "required":[ "dlCarrierFreq" ], "type":"object", "properties":{ "dlCarrierFreq":{ "$ref":"#/components/schemas/ArfcnValueNR" }, "cellIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysCellId" }, "minItems":1, "maxItems":32, "description":"When present, this IE should contain a list of the physical cell identities where the UE is requested to perform measurement logging for the indicated frequency.\n" } } }, "RoamingOdb":{ "anyOf":[ { "type":"string", "enum":[ "OUTSIDE_HOME_PLMN", "OUTSIDE_HOME_PLMN_COUNTRY" ] }, { "type":"string" } ], "description":"Defines the Barring of Roaming as. Refer to 3GPP TS 23.015 for further description. It should comply with the provisions defined in table 5.7.3.1-1.\n" }, "OdbPacketServices":{ "anyOf":[ { "anyOf":[ { "type":"string", "enum":[ "ALL_PACKET_SERVICES", "ROAMER_ACCESS_HPLMN_AP", "ROAMER_ACCESS_VPLMN_AP" ] }, { "type":"string" } ] }, { "$ref":"#/components/schemas/NullValue" } ], "description":"Defines the Barring of Packet Oriented Services. Refer to 3GPP TS 23.015 for further description. It should comply with the provisions defined in table 5.7.3.2-1\n" }, "OdbData":{ "description":"Contains information regarding operater determined barring.", "type":"object", "properties":{ "roamingOdb":{ "$ref":"#/components/schemas/RoamingOdb" } } }, "ChargingId":{ "deprecated":true, "type":"integer", "minimum":0, "maximum":"4294967295", "description":"Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.\n" }, "ApplicationChargingId":{ "type":"string", "description":"Application provided charging identifier that allows correlation of charging information." }, "RatingGroup":{ "$ref":"#/components/schemas/Uint32" }, "ServiceId":{ "$ref":"#/components/schemas/Uint32" }, "SecondaryRatUsageReport":{ "description":"Secondary RAT Usage Report that reports usage data for a secondary RAT for QoS flows.", "type":"object", "properties":{ "secondaryRatType":{ "$ref":"#/components/schemas/RatType" }, "qosFlowsUsageData":{ "type":"array", "items":{ "$ref":"#/components/schemas/QosFlowUsageReport" }, "minItems":1 } }, "required":[ "secondaryRatType", "qosFlowsUsageData" ] }, "QosFlowUsageReport":{ "description":"Contains QoS flow usage data information.", "type":"object", "properties":{ "qfi":{ "$ref":"#/components/schemas/Qfi" }, "startTimeStamp":{ "$ref":"#/components/schemas/DateTime" }, "endTimeStamp":{ "$ref":"#/components/schemas/DateTime" }, "downlinkVolume":{ "$ref":"#/components/schemas/Int64" }, "uplinkVolume":{ "$ref":"#/components/schemas/Int64" } }, "required":[ "qfi", "startTimeStamp", "endTimeStamp", "downlinkVolume", "uplinkVolume" ] }, "SecondaryRatUsageInfo":{ "description":"Secondary RAT Usage Information that reports usage data for a secondary RAT for QoS flows and/or the whole PDU session.\n", "type":"object", "properties":{ "secondaryRatType":{ "$ref":"#/components/schemas/RatType" }, "qosFlowsUsageData":{ "type":"array", "items":{ "$ref":"#/components/schemas/QosFlowUsageReport" }, "minItems":1 }, "pduSessionUsageData":{ "type":"array", "items":{ "$ref":"#/components/schemas/VolumeTimedReport" }, "minItems":1 } }, "required":[ "secondaryRatType" ] }, "VolumeTimedReport":{ "description":"Contains usage data information.", "type":"object", "properties":{ "startTimeStamp":{ "$ref":"#/components/schemas/DateTime" }, "endTimeStamp":{ "$ref":"#/components/schemas/DateTime" }, "downlinkVolume":{ "$ref":"#/components/schemas/Int64" }, "uplinkVolume":{ "$ref":"#/components/schemas/Int64" } }, "required":[ "startTimeStamp", "endTimeStamp", "downlinkVolume", "uplinkVolume" ] }, "AreaSessionId":{ "$ref":"#/components/schemas/Uint16" }, "AreaSessionPolicyId":{ "$ref":"#/components/schemas/Uint16" }, "MbsFsaId":{ "description":"MBS Frequency Selection Area Identifier", "type":"string", "pattern":"^[A-Fa-f0-9]{6}$" }, "MbsServiceType":{ "description":"Indicates the MBS service type of an MBS session.", "anyOf":[ { "type":"string", "enum":[ "MULTICAST", "BROADCAST" ] }, { "type":"string" } ] }, "MbsSessionActivityStatus":{ "description":"Indicates the MBS session's activity status.", "anyOf":[ { "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, { "type":"string" } ] }, "MbsSessionEventType":{ "description":"Indicates the MBS Session Event Type.", "anyOf":[ { "type":"string", "enum":[ "MBS_REL_TMGI_EXPIRY", "BROADCAST_DELIVERY_STATUS", "INGRESS_TUNNEL_ADD_CHANGE" ] }, { "type":"string" } ] }, "BroadcastDeliveryStatus":{ "description":"Indicates the Broadcast MBS Session's Delivery Status.", "anyOf":[ { "type":"string", "enum":[ "STARTED", "TERMINATED" ] }, { "type":"string" } ] }, "MbsSessionId":{ "description":"Indicates the MBS Session Identifier.", "type":"object", "properties":{ "tmgi":{ "$ref":"#/components/schemas/Tmgi" }, "ssm":{ "$ref":"#/components/schemas/Ssm" }, "nid":{ "$ref":"#/components/schemas/Nid" } }, "anyOf":[ { "required":[ "tmgi" ] }, { "required":[ "ssm" ] } ] }, "Tmgi":{ "description":"Indicates the Temporary Mobile Group Identity.", "type":"object", "properties":{ "mbsServiceId":{ "type":"string", "pattern":"^[A-Fa-f0-9]{6}$", "description":"MBS Service ID" }, "plmnId":{ "$ref":"#/components/schemas/PlmnId" } }, "required":[ "mbsServiceId", "plmnId" ] }, "Ssm":{ "description":"Indicates the Source specific IP multicast address.", "type":"object", "properties":{ "sourceIpAddr":{ "$ref":"#/components/schemas/IpAddr" }, "destIpAddr":{ "$ref":"#/components/schemas/IpAddr" } }, "required":[ "sourceIpAddr", "destIpAddr" ] }, "MbsServiceArea":{ "description":"Indicates the MBS Service Area.", "type":"object", "properties":{ "ncgiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/NcgiTai" }, "minItems":1, "description":"List of NR cell Ids" }, "taiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tai" }, "minItems":1, "description":"List of tracking area Ids" } }, "anyOf":[ { "required":[ "ncgiList" ] }, { "required":[ "taiList" ] } ] }, "NcgiTai":{ "description":"Lists NR cell ids, with their pertaining TAIs", "type":"object", "properties":{ "tai":{ "$ref":"#/components/schemas/Tai" }, "cellList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Ncgi" }, "minItems":1, "description":"List of NR cell ids" } }, "required":[ "tai", "cellList" ] }, "MbsSessionSubscription":{ "description":"Indicates MBS session subscription", "type":"object", "properties":{ "mbsSessionId":{ "$ref":"#/components/schemas/MbsSessionId" }, "areaSessionId":{ "$ref":"#/components/schemas/AreaSessionId" }, "eventList":{ "type":"array", "items":{ "$ref":"#/components/schemas/MbsSessionEvent" }, "minItems":1 }, "notifyUri":{ "$ref":"#/components/schemas/Uri" }, "notifyCorrelationId":{ "type":"string" }, "expiryTime":{ "$ref":"#/components/schemas/DateTime" }, "nfcInstanceId":{ "$ref":"#/components/schemas/NfInstanceId" }, "mbsSessionSubscUri":{ "$ref":"#/components/schemas/Uri", "readOnly":true } }, "required":[ "eventList", "notifyUri" ] }, "MbsSessionEventReportList":{ "description":"MBS session event report list", "type":"object", "properties":{ "eventReportList":{ "type":"array", "items":{ "$ref":"#/components/schemas/MbsSessionEventReport" }, "minItems":1 }, "notifyCorrelationId":{ "type":"string" } }, "required":[ "eventReportList" ] }, "MbsSessionEvent":{ "description":"MBS session event", "type":"object", "properties":{ "eventType":{ "$ref":"#/components/schemas/MbsSessionEventType" } }, "required":[ "eventType" ] }, "MbsSessionEventReport":{ "description":"Indicates MBS session event report", "type":"object", "properties":{ "eventType":{ "$ref":"#/components/schemas/MbsSessionEventType" }, "timeStamp":{ "$ref":"#/components/schemas/DateTime" }, "ingressTunAddrInfo":{ "$ref":"#/components/schemas/IngressTunAddrInfo" }, "broadcastDelStatus":{ "$ref":"#/components/schemas/BroadcastDeliveryStatus" } }, "required":[ "eventType" ] }, "MbsSecurityContext":{ "type":"object", "properties":{ "keyList":{ "description":"A map (list of key-value pairs) where a (unique) valid JSON string serves as a key of MbsSecurityContext", "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/MbsKeyInfo" }, "minProperties":1 } }, "required":[ "keyList" ] }, "MbsKeyInfo":{ "description":"Indicates MBS Security Key Data Structure.", "type":"object", "properties":{ "keyDomainId":{ "$ref":"#/components/schemas/Bytes" }, "mskId":{ "$ref":"#/components/schemas/Bytes" }, "msk":{ "$ref":"#/components/schemas/Bytes" }, "mskLifetime":{ "$ref":"#/components/schemas/DateTime" }, "mtkId":{ "$ref":"#/components/schemas/Bytes" }, "mtk":{ "$ref":"#/components/schemas/Bytes" } }, "required":[ "keyDomainId", "mskId" ] }, "IngressTunAddrInfo":{ "description":"Indicates Ingress Tunnel Address Information.", "type":"object", "properties":{ "ingressTunAddr":{ "type":"array", "items":{ "$ref":"#/components/schemas/TunnelAddress" }, "minItems":1 } }, "required":[ "ingressTunAddr" ] }, "MbsServiceAreaInfo":{ "description":"Indicates MBS Service Area Information for locations dependent on MBS sessions.", "type":"object", "properties":{ "areaSessionId":{ "$ref":"#/components/schemas/AreaSessionId" }, "mbsServiceArea":{ "$ref":"#/components/schemas/MbsServiceArea" } }, "required":[ "areaSessionId", "mbsServiceArea" ] }, "MbsQoSReq":{ "description":"Represents MBS QoS requirements.", "type":"object", "properties":{ "5qi":{ "$ref":"#/components/schemas/5Qi" }, "guarBitRate":{ "$ref":"#/components/schemas/BitRate" }, "maxBitRate":{ "$ref":"#/components/schemas/BitRate" }, "averWindow":{ "$ref":"#/components/schemas/AverWindow" }, "reqMbsArp":{ "$ref":"#/components/schemas/Arp" } }, "required":[ "5qi" ] }, "SessionRule":{ "description":"Contains session level policy information.", "type":"object", "properties":{ "authSessAmbr":{ "$ref":"#/components/schemas/Ambr" }, "authDefQos":{ "$ref":"#/components/schemas/AuthorizedDefaultQos" }, "sessRuleId":{ "type":"string", "description":"Identifies the session rule within a PDU session." }, "refUmData":{ "type":"string", "description":"A reference to the UsageMonitoringData policy decision type. It is the umId described in clause 5.6.2.12.", "nullable":true }, "refUmN3gData":{ "type":"string", "description":"A reference to the UsageMonitoringData policy decision type to apply for Non-3GPP access. It is the umId described in clause 5.6.2.12.", "nullable":true }, "refCondData":{ "type":"string", "description":"A reference to the condition data. It is the condId described in clause 5.6.2.9.", "nullable":true } }, "required":[ "sessRuleId" ], "nullable":true }, "QosData":{ "description":"Contains the QoS parameters.", "type":"object", "properties":{ "qosId":{ "type":"string", "description":"Identifies the QoS control policy data within a PDU session." }, "5qi":{ "$ref":"#/components/schemas/5Qi" }, "maxbrUl":{ "$ref":"#/components/schemas/BitRateRm" }, "maxbrDl":{ "$ref":"#/components/schemas/BitRateRm" }, "gbrUl":{ "$ref":"#/components/schemas/BitRateRm" }, "gbrDl":{ "$ref":"#/components/schemas/BitRateRm" }, "arp":{ "$ref":"#/components/schemas/Arp" }, "qnc":{ "type":"boolean", "description":"Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.\n" }, "priorityLevel":{ "$ref":"#/components/schemas/5QiPriorityLevelRm" }, "averWindow":{ "$ref":"#/components/schemas/AverWindowRm" }, "maxDataBurstVol":{ "$ref":"#/components/schemas/MaxDataBurstVolRm" }, "reflectiveQos":{ "type":"boolean", "description":"Indicates whether the QoS information is reflective for the corresponding service data flow." }, "sharingKeyDl":{ "type":"string", "description":"Indicates which PCC rules may share resources in the downlink direction, by containing the same value." }, "sharingKeyUl":{ "type":"string", "description":"Indicates which PCC rules may share resources in the uplink direction, by containing the same value." }, "maxPacketLossRateDl":{ "$ref":"#/components/schemas/PacketLossRateRm" }, "maxPacketLossRateUl":{ "$ref":"#/components/schemas/PacketLossRateRm" }, "defQosFlowIndication":{ "type":"boolean", "description":"Indicates that the dynamic PCC rule should always have its binding with the QoS Flow associated with the default QoS rule" }, "extMaxDataBurstVol":{ "$ref":"#/components/schemas/ExtMaxDataBurstVolRm" }, "packetDelayBudget":{ "$ref":"#/components/schemas/PacketDelBudget" }, "packetErrorRate":{ "$ref":"#/components/schemas/PacketErrRate" } }, "required":[ "qosId" ], "nullable":true }, "ConditionData":{ "description":"Contains conditions of applicability for a rule.", "type":"object", "properties":{ "condId":{ "type":"string", "description":"Uniquely identifies the condition data within a PDU session." }, "activationTime":{ "$ref":"#/components/schemas/DateTimeRm" }, "deactivationTime":{ "$ref":"#/components/schemas/DateTimeRm" }, "accessType":{ "$ref":"#/components/schemas/AccessType" }, "ratType":{ "$ref":"#/components/schemas/RatType" } }, "required":[ "condId" ], "nullable":true }, "ChargingData":{ "description":"Contains charging related parameters.", "type":"object", "properties":{ "chgId":{ "type":"string", "description":"Identifies the charging control policy data within a PDU session." }, "meteringMethod":{ "$ref":"#/components/schemas/MeteringMethod" }, "offline":{ "type":"boolean", "description":"Indicates that offline charging is applicable to the PCC rule when it is included and set to true." }, "online":{ "type":"boolean", "description":"Indicates that online charging is applicable to the PCC rule when it is included and set to true." }, "sdfHandl":{ "type":"boolean", "description":"Indicates whether the service data flow is allowed to start while the SMF is waiting for the response to the credit request." }, "ratingGroup":{ "$ref":"#/components/schemas/RatingGroup" }, "reportingLevel":{ "$ref":"#/components/schemas/ReportingLevel" }, "serviceId":{ "$ref":"#/components/schemas/ServiceId" }, "sponsorId":{ "type":"string", "description":"Indicates the sponsor identity." }, "appSvcProvId":{ "type":"string", "description":"Indicates the application service provider identity." }, "afChargingIdentifier":{ "$ref":"#/components/schemas/ChargingId" }, "afChargId":{ "$ref":"#/components/schemas/ApplicationChargingId" } }, "required":[ "chgId" ], "nullable":true }, "RedirectInformation":{ "description":"Contains the redirect information.", "type":"object", "properties":{ "redirectEnabled":{ "type":"boolean", "description":"Indicates that redirect is enabled." }, "redirectAddressType":{ "$ref":"#/components/schemas/RedirectAddressType" }, "redirectServerAddress":{ "type":"string", "description":"Indicates the address of the redirect server. If \"redirectAddressType\" attribute indicates the IPV4_ADDR, the encoding is the same as the Ipv4Addr data type defined in 3GPP TS 29.571.If \"redirectAddressType\" attribute indicates the IPV6_ADDR, the encoding is the same as the Ipv6Addr data type defined in 3GPP TS 29.571.If \"redirectAddressType\" attribute indicates the URL or SIP_URI, the encoding is the same as the Uri data type defined in 3GPP TS 29.571.\n" } } }, "QosCharacteristics":{ "description":"Contains QoS characteristics for a non-standardized or a non-configured 5QI.", "type":"object", "properties":{ "5qi":{ "$ref":"#/components/schemas/5Qi" }, "resourceType":{ "$ref":"#/components/schemas/QosResourceType" }, "priorityLevel":{ "$ref":"#/components/schemas/5QiPriorityLevel" }, "packetDelayBudget":{ "$ref":"#/components/schemas/PacketDelBudget" }, "packetErrorRate":{ "$ref":"#/components/schemas/PacketErrRate" }, "averagingWindow":{ "$ref":"#/components/schemas/AverWindow" }, "maxDataBurstVol":{ "$ref":"#/components/schemas/MaxDataBurstVol" }, "extMaxDataBurstVol":{ "$ref":"#/components/schemas/ExtMaxDataBurstVol" } }, "required":[ "5qi", "resourceType", "priorityLevel", "packetDelayBudget", "packetErrorRate" ] }, "ChargingInformation":{ "description":"Contains the addresses of the charging functions.", "type":"object", "properties":{ "primaryChfAddress":{ "$ref":"#/components/schemas/Uri" }, "secondaryChfAddress":{ "$ref":"#/components/schemas/Uri" }, "primaryChfSetId":{ "$ref":"#/components/schemas/NfSetId" }, "primaryChfInstanceId":{ "$ref":"#/components/schemas/NfInstanceId" }, "secondaryChfSetId":{ "$ref":"#/components/schemas/NfSetId" }, "secondaryChfInstanceId":{ "$ref":"#/components/schemas/NfInstanceId" } }, "required":[ "primaryChfAddress" ] }, "UpPathChgEvent":{ "description":"Contains the UP path change event subscription from the AF.", "type":"object", "properties":{ "notificationUri":{ "$ref":"#/components/schemas/Uri" }, "notifCorreId":{ "type":"string", "description":"It is used to set the value of Notification Correlation ID in the notification sent by the SMF." }, "dnaiChgType":{ "$ref":"#/components/schemas/DnaiChangeType" }, "afAckInd":{ "type":"boolean" } }, "required":[ "notificationUri", "notifCorreId", "dnaiChgType" ], "nullable":true }, "TerminationNotification":{ "description":"Represents a termination notification.", "type":"object", "properties":{ "resourceUri":{ "$ref":"#/components/schemas/Uri" }, "cause":{ "$ref":"#/components/schemas/SmPolicyAssociationReleaseCause" } }, "required":[ "resourceUri", "cause" ] }, "AccNetChId":{ "description":"Contains the access network charging identifier for the PCC rule(s) or for the whole PDU session.", "type":"object", "properties":{ "accNetChaIdValue":{ "$ref":"#/components/schemas/ChargingId" }, "accNetChargId":{ "type":"string", "description":"A character string containing the access network charging id." }, "refPccRuleIds":{ "type":"array", "items":{ "type":"string" }, "minItems":1, "description":"Contains the identifier of the PCC rule(s) associated to the provided Access Network Charging Identifier." }, "sessionChScope":{ "type":"boolean", "description":"When included and set to true, indicates the Access Network Charging Identifier that applies to the whole PDU Session" } }, "oneOf":[ { "required":[ "accNetChaIdValue" ] }, { "required":[ "accNetChargId" ] } ] }, "AccNetChargingAddress":{ "description":"Describes the network entity within the access network performing charging", "type":"object", "anyOf":[ { "required":[ "anChargIpv4Addr" ] }, { "required":[ "anChargIpv6Addr" ] } ], "properties":{ "anChargIpv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "anChargIpv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" } } }, "RequestedRuleData":{ "description":"Contains rule data requested by the PCF to receive information associated with PCC rule(s).", "type":"object", "properties":{ "refPccRuleIds":{ "type":"array", "items":{ "type":"string" }, "minItems":1, "description":"An array of PCC rule id references to the PCC rules associated with the control data." }, "reqData":{ "type":"array", "items":{ "$ref":"#/components/schemas/RequestedRuleDataType" }, "minItems":1, "description":"Array of requested rule data type elements indicating what type of rule data is requested for the corresponding referenced PCC rules." } }, "required":[ "refPccRuleIds", "reqData" ] }, "RequestedUsageData":{ "description":"Contains usage data requested by the PCF requesting usage reports for the corresponding usage monitoring data instances.", "type":"object", "properties":{ "refUmIds":{ "type":"array", "items":{ "type":"string" }, "minItems":1, "description":"An array of usage monitoring data id references to the usage monitoring data instances for which the PCF is requesting a usage report. This attribute is provided only when allUmIds is not set to true.\n" }, "allUmIds":{ "type":"boolean", "description":"Indicates whether requested usage data applies to all usage monitoring data instances. When it's not included, it means requested usage data shall only apply to the usage monitoring data instances referenced by the refUmIds attribute.\n" } } }, "UeInitiatedResourceRequest":{ "description":"Indicates that a UE requests specific QoS handling for the selected SDF.", "type":"object", "properties":{ "pccRuleId":{ "type":"string" }, "ruleOp":{ "$ref":"#/components/schemas/RuleOperation" }, "precedence":{ "type":"integer" }, "packFiltInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/PacketFilterInfo" }, "minItems":1 }, "reqQos":{ "$ref":"#/components/schemas/RequestedQos" } }, "required":[ "ruleOp", "packFiltInfo" ] }, "PacketFilterInfo":{ "description":"Contains the information from a single packet filter sent from the SMF to the PCF.", "type":"object", "properties":{ "packFiltId":{ "type":"string", "description":"An identifier of packet filter." }, "packFiltCont":{ "$ref":"#/components/schemas/PacketFilterContent" }, "tosTrafficClass":{ "type":"string", "description":"Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field." }, "spi":{ "type":"string", "description":"The security parameter index of the IPSec packet." }, "flowLabel":{ "type":"string", "description":"The Ipv6 flow label header field." }, "flowDirection":{ "$ref":"#/components/schemas/FlowDirection" } } }, "RequestedQos":{ "description":"Contains the QoS information requested by the UE.", "type":"object", "properties":{ "5qi":{ "$ref":"#/components/schemas/5Qi" }, "gbrUl":{ "$ref":"#/components/schemas/BitRate" }, "gbrDl":{ "$ref":"#/components/schemas/BitRate" } }, "required":[ "5qi" ] }, "AuthorizedDefaultQos":{ "description":"Represents the Authorized Default QoS.", "type":"object", "properties":{ "5qi":{ "$ref":"#/components/schemas/5Qi" }, "arp":{ "$ref":"#/components/schemas/Arp" }, "priorityLevel":{ "$ref":"#/components/schemas/5QiPriorityLevelRm" }, "averWindow":{ "$ref":"#/components/schemas/AverWindowRm" }, "maxDataBurstVol":{ "$ref":"#/components/schemas/MaxDataBurstVolRm" }, "maxbrUl":{ "$ref":"#/components/schemas/BitRateRm" }, "maxbrDl":{ "$ref":"#/components/schemas/BitRateRm" }, "gbrUl":{ "$ref":"#/components/schemas/BitRateRm" }, "gbrDl":{ "$ref":"#/components/schemas/BitRateRm" }, "extMaxDataBurstVol":{ "$ref":"#/components/schemas/ExtMaxDataBurstVolRm" } } }, "SessionRuleReport":{ "description":"Represents reporting of the status of a session rule.", "type":"object", "properties":{ "ruleIds":{ "type":"array", "items":{ "type":"string" }, "minItems":1, "description":"Contains the identifier of the affected session rule(s)." }, "ruleStatus":{ "$ref":"#/components/schemas/RuleStatus" }, "sessRuleFailureCode":{ "$ref":"#/components/schemas/SessionRuleFailureCode" }, "policyDecFailureReports":{ "type":"array", "items":{ "$ref":"#/components/schemas/PolicyDecisionFailureCode" }, "minItems":1, "description":"Contains the type(s) of failed policy decision and/or condition data." } }, "required":[ "ruleIds", "ruleStatus" ] }, "SteeringMode":{ "description":"Contains the steering mode value and parameters determined by the PCF.", "type":"object", "properties":{ "steerModeValue":{ "$ref":"#/components/schemas/SteerModeValue" }, "active":{ "$ref":"#/components/schemas/AccessType" }, "standby":{ "$ref":"#/components/schemas/AccessTypeRm" }, "3gLoad":{ "$ref":"#/components/schemas/Uinteger" }, "prioAcc":{ "$ref":"#/components/schemas/AccessType" }, "thresValue":{ "$ref":"#/components/schemas/ThresholdValue" }, "steerModeInd":{ "$ref":"#/components/schemas/SteerModeIndicator" } }, "required":[ "steerModeValue" ] }, "AdditionalAccessInfo":{ "description":"Indicates the combination of additional Access Type and RAT Type for a MA PDU session.", "type":"object", "properties":{ "accessType":{ "$ref":"#/components/schemas/AccessType" }, "ratType":{ "$ref":"#/components/schemas/RatType" } }, "required":[ "accessType" ] }, "QosMonitoringData":{ "description":"Contains QoS monitoring related control information.", "type":"object", "properties":{ "qmId":{ "type":"string", "description":"Identifies the QoS monitoring policy data within a PDU session." }, "reqQosMonParams":{ "type":"array", "items":{ "$ref":"#/components/schemas/RequestedQosMonitoringParameter" }, "minItems":1, "description":"Indicates the UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF. It is to be monitored when the QoS Monitoring for URLLC is enabled for the service data flow.\n" }, "repFreqs":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportingFrequency" }, "minItems":1 }, "repThreshDl":{ "type":"integer", "description":"Indicates the period of time in units of miliiseconds for DL packet delay.", "nullable":true }, "repThreshUl":{ "type":"integer", "description":"Indicates the period of time in units of miliiseconds for UL packet delay.", "nullable":true }, "repThreshRp":{ "type":"integer", "description":"Indicates the period of time in units of miliiseconds for round trip packet delay.", "nullable":true }, "waitTime":{ "$ref":"#/components/schemas/DurationSecRm" }, "repPeriod":{ "$ref":"#/components/schemas/DurationSecRm" }, "notifyUri":{ "$ref":"#/components/schemas/UriRm" }, "notifyCorreId":{ "type":"string", "nullable":true }, "directNotifInd":{ "type":"boolean", "description":"Indicates that the direct event notification sent by UPF to the Local NEF or AF is requested if it is included and set to true." } }, "required":[ "qmId", "reqQosMonParams", "repFreqs" ], "nullable":true }, "QosMonitoringReport":{ "description":"Contains reporting information on QoS monitoring.", "type":"object", "properties":{ "refPccRuleIds":{ "type":"array", "items":{ "type":"string" }, "minItems":1, "description":"An array of PCC rule id references to the PCC rules associated with the QoS monitoring report." }, "ulDelays":{ "type":"array", "items":{ "type":"integer" }, "minItems":1 }, "dlDelays":{ "type":"array", "items":{ "type":"integer" }, "minItems":1 }, "rtDelays":{ "type":"array", "items":{ "type":"integer" }, "minItems":1 }, "pdmf":{ "type":"boolean", "description":"Represents the packet delay measurement failure indicator." } }, "required":[ "refPccRuleIds" ] }, "TsnBridgeInfo":{ "description":"Contains parameters that describe and identify the TSC user plane node.", "type":"object", "properties":{ "bridgeId":{ "$ref":"#/components/schemas/Uint64" }, "dsttAddr":{ "$ref":"#/components/schemas/MacAddr48" }, "dsttPortNum":{ "$ref":"#/components/schemas/TsnPortNumber" }, "dsttResidTime":{ "$ref":"#/components/schemas/Uinteger" } } }, "PortManagementContainer":{ "description":"Contains the port management information container for a port.", "type":"object", "properties":{ "portManCont":{ "$ref":"#/components/schemas/Bytes" }, "portNum":{ "$ref":"#/components/schemas/TsnPortNumber" } }, "required":[ "portManCont", "portNum" ] }, "BridgeManagementContainer":{ "description":"Contains the UMIC.", "type":"object", "properties":{ "bridgeManCont":{ "$ref":"#/components/schemas/Bytes" } }, "required":[ "bridgeManCont" ] }, "IpMulticastAddressInfo":{ "description":"Contains the IP multicast addressing information.", "type":"object", "properties":{ "srcIpv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv4MulAddr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "srcIpv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "ipv6MulAddr":{ "$ref":"#/components/schemas/Ipv6Addr" } } }, "DownlinkDataNotificationControl":{ "description":"Contains the downlink data notification control information.", "type":"object", "properties":{ "notifCtrlInds":{ "type":"array", "items":{ "$ref":"#/components/schemas/NotificationControlIndication" }, "minItems":1 }, "typesOfNotif":{ "type":"array", "items":{ "$ref":"#/components/schemas/DlDataDeliveryStatus" }, "minItems":1 } } }, "DownlinkDataNotificationControlRm":{ "description":"Defined in the same way as the DownlinkDataNotificationControl data type, but with the nullable:true property.", "type":"object", "properties":{ "notifCtrlInds":{ "type":"array", "items":{ "$ref":"#/components/schemas/NotificationControlIndication" }, "minItems":1, "nullable":true }, "typesOfNotif":{ "type":"array", "items":{ "$ref":"#/components/schemas/DlDataDeliveryStatus" }, "minItems":1, "nullable":true } }, "nullable":true }, "ThresholdValue":{ "description":"Indicates the threshold value(s) for RTT and/or Packet Loss Rate.", "type":"object", "properties":{ "rttThres":{ "$ref":"#/components/schemas/UintegerRm" }, "plrThres":{ "$ref":"#/components/schemas/PacketLossRateRm" } }, "nullable":true }, "PacketFilterContent":{ "type":"string", "description":"Defines a packet filter for an IP flow." }, "FlowDescription":{ "type":"string", "description":"Defines a packet filter for an IP flow." }, "TsnPortNumber":{ "$ref":"#/components/schemas/Uinteger" }, "ApplicationDescriptor":{ "$ref":"#/components/schemas/Bytes" }, "FlowDirection":{ "anyOf":[ { "type":"string", "enum":[ "DOWNLINK", "UPLINK", "BIDIRECTIONAL", "UNSPECIFIED" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- DOWNLINK: The corresponding filter applies for traffic to the UE.\n- UPLINK: The corresponding filter applies for traffic from the UE.\n- BIDIRECTIONAL: The corresponding filter applies for traffic both to and from the UE.\n- UNSPECIFIED: The corresponding filter applies for traffic to the UE (downlink), but has no specific direction declared. The service data flow detection should apply the filter for uplink traffic as if the filter was bidirectional. The PCF should not use the value UNSPECIFIED in filters created by the network in NW-initiated procedures. The PCF should only include the value UNSPECIFIED in filters in UE-initiated procedures if the same value is received from the SMF.\n" }, "FlowDirectionRm":{ "description":"Defined in the same way as the \"FlowDirection\" data type, with the only difference that it allows null value.", "anyOf":[ { "$ref":"#/components/schemas/FlowDirection" }, { "$ref":"#/components/schemas/NullValue" } ] }, "ReportingLevel":{ "anyOf":[ { "type":"string", "enum":[ "SER_ID_LEVEL", "RAT_GR_LEVEL", "SPON_CON_LEVEL" ] }, { "$ref":"#/components/schemas/NullValue" }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- SER_ID_LEVEL: Indicates that the usage should be reported on service id and rating group combination level.\n- RAT_GR_LEVEL: Indicates that the usage should be reported on rating group level.\n- SPON_CON_LEVEL: Indicates that the usage should be reported on sponsor identity and rating group combination level.\n" }, "MeteringMethod":{ "anyOf":[ { "type":"string", "enum":[ "DURATION", "VOLUME", "DURATION_VOLUME", "EVENT" ] }, { "$ref":"#/components/schemas/NullValue" }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration.Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- DURATION: Indicates that the duration of the service data flow traffic should be metered.\n- VOLUME: Indicates that volume of the service data flow traffic should be metered.\n- DURATION_VOLUME: Indicates that the duration and the volume of the service data flow traffic should be metered.\n- EVENT: Indicates that events of the service data flow traffic should be metered.\n" }, "PolicyControlRequestTrigger":{ "anyOf":[ { "type":"string", "enum":[ "PLMN_CH", "RES_MO_RE", "AC_TY_CH", "UE_IP_CH", "UE_MAC_CH", "AN_CH_COR", "US_RE", "APP_STA", "APP_STO", "AN_INFO", "CM_SES_FAIL", "PS_DA_OFF", "DEF_QOS_CH", "SE_AMBR_CH", "QOS_NOTIF", "NO_CREDIT", "REALLO_OF_CREDIT", "PRA_CH", "SAREA_CH", "SCNN_CH", "RE_TIMEOUT", "RES_RELEASE", "SUCC_RES_ALLO", "RAI_CH", "RAT_TY_CH", "REF_QOS_IND_CH", "NUM_OF_PACKET_FILTER", "UE_STATUS_RESUME", "UE_TZ_CH", "AUTH_PROF_CH", "QOS_MONITORING", "SCELL_CH", "USER_LOCATION_CH", "EPS_FALLBACK", "MA_PDU", "TSN_BRIDGE_INFO", "5G_RG_JOIN", "5G_RG_LEAVE", "DDN_FAILURE", "DDN_DELIVERY_STATUS", "GROUP_ID_LIST_CHG", "DDN_FAILURE_CANCELLATION", "DDN_DELIVERY_STATUS_CANCELLATION", "VPLMN_QOS_CH", "SUCC_QOS_UPDATE", "SAT_CATEGORY_CHG", "PCF_UE_NOTIF_IND", "NWDAF_DATA_CHG" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- PLMN_CH: PLMN Change\n- RES_MO_RE: A request for resource modification has been received by the SMF. The SMF always reports to the PCF.\n- AC_TY_CH: Access Type Change\n- UE_IP_CH: UE IP address change. The SMF always reports to the PCF.\n- UE_MAC_CH: A new UE MAC address is detected or a used UE MAC address is inactive for a specific period\n- AN_CH_COR: Access Network Charging Correlation Information\n- US_RE: The PDU Session or the Monitoring key specific resources consumed by a UE either reached the threshold or needs to be reported for other reasons.\n- APP_STA: The start of application traffic has been detected.\n- APP_STO: The stop of application traffic has been detected.\n- AN_INFO: Access Network Information report\n- CM_SES_FAIL: Credit management session failure\n- PS_DA_OFF: The SMF reports when the 3GPP PS Data Off status changes. The SMF always reports to the PCF.\n- DEF_QOS_CH: Default QoS Change. The SMF always reports to the PCF.\n- SE_AMBR_CH: Session-AMBR Change. The SMF always reports to the PCF.\n- QOS_NOTIF: The SMF notify the PCF when receiving notification from RAN that QoS targets of the QoS Flow cannot be guranteed or gurateed again.\n- NO_CREDIT: Out of credit\n- REALLO_OF_CREDIT: Reallocation of credit\n- PRA_CH: Change of UE presence in Presence Reporting Area\n- SAREA_CH: Location Change with respect to the Serving Area\n- SCNN_CH: Location Change with respect to the Serving CN node\n- RE_TIMEOUT: Indicates that the SMF generated the request because there has been a PCC revalidation timeout\n- RES_RELEASE: Indicates that the SMF can inform the PCF of the outcome of the release of resources for those rules that require so.\n- SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource allocation.\n- RAI_CH: Location Change with respect to the RAI of GERAN and UTRAN.\n- RAT_TY_CH: RAT Type Change.\n- REF_QOS_IND_CH: Reflective QoS indication Change\n- NUM_OF_PACKET_FILTER: Indicates that the SMF shall report the number of supported packet filter for signalled QoS rules\n- UE_STATUS_RESUME: Indicates that the UE's status is resumed.\n- UE_TZ_CH: UE Time Zone Change\n- AUTH_PROF_CH: The DN-AAA authorization profile index has changed\n- QOS_MONITORING: Indicate that the SMF notifies the PCF of the QoS Monitoring information.\n- SCELL_CH: Location Change with respect to the Serving Cell.\n- USER_LOCATION_CH: Indicate that user location has been changed, applicable to serving area change and serving cell change.\n- EPS_FALLBACK: EPS Fallback report is enabled in the SMF.\n- MA_PDU: UE Indicates that the SMF notifies the PCF of the MA PDU session request\n- TSN_BRIDGE_INFO: TSC user plane node information available\n- 5G_RG_JOIN: The 5G-RG has joined to an IP Multicast Group.\n- 5G_RG_LEAVE: The 5G-RG has left an IP Multicast Group.\n- DDN_FAILURE: Event subscription for DDN Failure event received.\n- DDN_DELIVERY_STATUS: Event subscription for DDN Delivery Status received.\n- GROUP_ID_LIST_CHG: UE Internal Group Identifier(s) has changed: the SMF reports that UDM provided list of group Ids has changed.\n- DDN_FAILURE_CANCELLATION: The event subscription for DDN Failure event is cancelled.\n- DDN_DELIVERY_STATUS_CANCELLATION: The event subscription for DDD STATUS is cancelled.\n- VPLMN_QOS_CH: Change of the QoS supported in the VPLMN.\n- SUCC_QOS_UPDATE: Indicates that the requested MPS Action is successful.\n- SAT_CATEGORY_CHG: Indicates that the SMF has detected a change between different satellite backhaul categories, or between a satellite backhaul and a non-satellite backhaul.\n- PCF_UE_NOTIF_IND: Indicates the SMF has detected the AMF forwarded the PCF for the UE indication to receive/stop receiving notifications of SM Policy association established/terminated events.\n- NWDAF_DATA_CHG: Indicates that the NWDAF instance IDs used for the PDU session and/or associated Analytics IDs used for the PDU session and available in the SMF have changed.\n" }, "RequestedRuleDataType":{ "anyOf":[ { "type":"string", "enum":[ "CH_ID", "MS_TIME_ZONE", "USER_LOC_INFO", "RES_RELEASE", "SUCC_RES_ALLO", "EPS_FALLBACK" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- CH_ID: Indicates that the requested rule data is the charging identifier. \n- MS_TIME_ZONE: Indicates that the requested access network info type is the UE's timezone.\n- USER_LOC_INFO: Indicates that the requested access network info type is the UE's location.\n- RES_RELEASE: Indicates that the requested rule data is the result of the release of resource.\n- SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource allocation.\n- EPS_FALLBACK: Indicates that the requested rule data is the report of QoS flow rejection due to EPS fallback.\n" }, "RuleStatus":{ "anyOf":[ { "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- ACTIVE: Indicates that the PCC rule(s) are successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF), or the session rule(s) are successfully installed \n- INACTIVE: Indicates that the PCC rule(s) are removed (for those provisioned from PCF) or inactive (for those pre-defined in SMF) or the session rule(s) are removed.\n" }, "FailureCode":{ "anyOf":[ { "type":"string", "enum":[ "UNK_RULE_ID", "RA_GR_ERR", "SER_ID_ERR", "NF_MAL", "RES_LIM", "MAX_NR_QoS_FLOW", "MISS_FLOW_INFO", "RES_ALLO_FAIL", "UNSUCC_QOS_VAL", "INCOR_FLOW_INFO", "PS_TO_CS_HAN", "APP_ID_ERR", "NO_QOS_FLOW_BOUND", "FILTER_RES", "MISS_REDI_SER_ADDR", "CM_END_USER_SER_DENIED", "CM_CREDIT_CON_NOT_APP", "CM_AUTH_REJ", "CM_USER_UNK", "CM_RAT_FAILED", "UE_STA_SUSP", "UNKNOWN_REF_ID", "INCORRECT_COND_DATA", "REF_ID_COLLISION", "TRAFFIC_STEERING_ERROR", "DNAI_STEERING_ERROR", "AN_GW_FAILE", "MAX_NR_PACKET_FILTERS_EXCEEDED", "PACKET_FILTER_TFT_ALLOCATION_EXCEEDED", "MUTE_CHG_NOT_ALLOWED" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- UNK_RULE_ID: Indicates that the pre-provisioned PCC rule could not be successfully activated because the PCC rule identifier is unknown to the SMF.\n- RA_GR_ERR: Indicate that the PCC rule could not be successfully installed or enforced because the Rating Group specified within the Charging Data policy decision which the PCC rule refers to is unknown or, invalid.\n- SER_ID_ERR: Indicate that the PCC rule could not be successfully installed or enforced because the Service Identifier specified within the Charging Data policy decision which the PCC rule refers to is invalid, unknown, or not applicable to the service being charged.\n- NF_MAL: Indicate that the PCC rule could not be successfully installed (for those provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to SMF/UPF malfunction.\n- RES_LIM: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF.\n- MAX_NR_QoS_FLOW: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to the fact that the maximum number of QoS flows has been reached for the PDU session.\n- MISS_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or enforced because neither the \"flowInfos\" attribute nor the \"appId\" attribute is specified within the PccRule data structure by the PCF during the first install request of the PCC rule.\n- RES_ALLO_FAIL: Indicate that the PCC rule could not be successfully installed or maintained since the QoS flow establishment/modification failed, or the QoS flow was released.\n- UNSUCC_QOS_VAL: indicate that the QoS validation has failed or when Guaranteed Bandwidth > Max-Requested-Bandwidth.\n- INCOR_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or modified at the SMF because the provided flow information is not supported by the network (e.g. the provided IP address(es) or Ipv6 prefix(es) do not correspond to an IP version applicable for the PDU session).\n- PS_TO_CS_HAN: Indicate that the PCC rule could not be maintained because of PS to CS handover.\n- APP_ID_ERR: Indicate that the rule could not be successfully installed or enforced because the Application Identifier is invalid, unknown, or not applicable to the application required for detection.\n- NO_QOS_FLOW_BOUND: Indicate that there is no QoS flow which the SMF can bind the PCC rule(s) to.\n- FILTER_RES: Indicate that the Flow Information within the \"flowInfos\" attribute cannot be handled by the SMF because any of the restrictions defined in clause 5.4.2 of 3GPP TS 29.212 was not met.\n- MISS_REDI_SER_ADDR: Indicate that the PCC rule could not be successfully installed or enforced at the SMF because there is no valid Redirect Server Address within the Traffic Control Data policy decision which the PCC rule refers to provided by the PCF and no preconfigured redirection address for this PCC rule at the SMF.\n- CM_END_USER_SER_DENIED: Indicate that the charging system denied the service request due to service restrictions (e.g. terminate rating group) or limitations related to the end-user, for example the end-user's account could not cover the requested service.\n- CM_CREDIT_CON_NOT_APP: Indicate that the charging system determined that the service can be granted to the end user but no further credit control is needed for the service (e.g. service is free of charge or is treated for offline charging).\n - CM_AUTH_REJ: Indicate that the charging system denied the service request in order to terminate the service for which credit is requested.\n- CM_USER_UNK: Indicate that the specified end user could not be found in the charging system.\n- CM_RAT_FAILED: Indicate that the charging system cannot rate the service request due to insufficient rating input, incorrect AVP combination or due to an attribute or an attribute value that is not recognized or supported in the rating.\n- UE_STA_SUSP: Indicates that the UE is in suspend state.\n- UNKNOWN_REF_ID: Indicates that the PCC rule could not be successfully installed/modified because the referenced identifier to a Policy Decision Data or to a Condition Data is unknown to the SMF.\n- INCORRECT_COND_DATA: Indicates that the PCC rule could not be successfully installed/modified because the referenced Condition data are incorrect.\n- REF_ID_COLLISION: Indicates that PCC rule could not be successfully installed/modified because the same Policy Decision is referenced by a session rule (e.g. the session rule and the PCC rule refer to the same Usage Monitoring decision data).\n- TRAFFIC_STEERING_ERROR: Indicates that enforcement of the steering of traffic to the N6-LAN or 5G-LAN failed; or the dynamic PCC rule could not be successfully installed or modified at the NF service consumer because there are invalid traffic steering policy identifier(s) within the provided Traffic Control Data policy decision to which the PCC rule refers.\n- DNAI_STEERING_ERROR: Indicates that the enforcement of the steering of traffic to the indicated DNAI failed; or the dynamic PCC rule could not be successfully installed or modified at the NF service consumer because there is invalid route information for a DNAI(s) (e.g. routing profile id is not configured) within the provided Traffic Control Data policy decision to which the PCC rule refers.\n- AN_GW_FAILED: This value is used to indicate that the AN-Gateway has failed and that the PCF should refrain from sending policy decisions to the SMF until it is informed that the S-GW has been recovered. This value shall not be used if the SM Policy association modification procedure is initiated for PCC rule removal only.\n- MAX_NR_PACKET_FILTERS_EXCEEDED: This value is used to indicate that the PCC rule could not be successfully installed, modified or enforced at the NF service consumer because the number of supported packet filters for signalled QoS rules for the PDU session has been reached.\n- PACKET_FILTER_TFT_ALLOCATION_EXCEEDED: This value is used to indicate that the PCC rule is removed at 5GS to EPS mobility because TFT allocation was not possible since the number of active packet filters in the EPC bearer is exceeded.\n- MUTE_CHG_NOT_ALLOWED: Indicates that the PCC rule could not be successfully modified because the mute condition for application detection report cannot be changed. Applicable when the functionality introduced with the ADC feature applies.\n" }, "AfSigProtocol":{ "anyOf":[ { "type":"string", "enum":[ "NO_INFORMATION", "SIP" ] }, { "$ref":"#/components/schemas/NullValue" }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- NO_INFORMATION: Indicates that no information about the AF signalling protocol is being provided. \n- SIP: Indicates that the signalling protocol is Session Initiation Protocol.\n" }, "RuleOperation":{ "anyOf":[ { "type":"string", "enum":[ "CREATE_PCC_RULE", "DELETE_PCC_RULE", "MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS", "MODIFY_ PCC_RULE_AND_REPLACE_PACKET_FILTERS", "MODIFY_ PCC_RULE_AND_DELETE_PACKET_FILTERS", "MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- CREATE_PCC_RULE: Indicater to create a new PCC rule to reserve the resource requested by the UE. \n- DELETE_PCC_RULE: Indicater to delete a PCC rule corresponding to reserve the resource requested by the UE.\n- MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS: Indicater to modify the PCC rule by adding new packet filter(s).\n- MODIFY_ PCC_RULE_AND_REPLACE_PACKET_FILTERS: Indicater to modify the PCC rule by replacing the existing packet filter(s).\n- MODIFY_ PCC_RULE_AND_DELETE_PACKET_FILTERS: Indicater to modify the PCC rule by deleting the existing packet filter(s).\n- MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS: Indicater to modify the PCC rule by modifying the QoS of the PCC rule.\n" }, "RedirectAddressType":{ "anyOf":[ { "type":"string", "enum":[ "IPV4_ADDR", "IPV6_ADDR", "URL", "SIP_URI" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- IPV4_ADDR: Indicates that the address type is in the form of \"dotted-decimal\" IPv4 address.\n- IPV6_ADDR: Indicates that the address type is in the form of IPv6 address.\n- URL: Indicates that the address type is in the form of Uniform Resource Locator.\n- SIP_URI: Indicates that the address type is in the form of SIP Uniform Resource Identifier.\n" }, "QosFlowUsage":{ "anyOf":[ { "type":"string", "enum":[ "GENERAL", "IMS_SIG" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- GENERAL: Indicates that no specific QoS flow usage information is available. \n- IMS_SIG: Indicates that the QoS flow is used for IMS signalling only.\n" }, "FailureCause":{ "description":"Indicates that the cause of the failure in a Partial Success Report.", "anyOf":[ { "type":"string", "enum":[ "PCC_RULE_EVENT", "PCC_QOS_FLOW_EVENT", "RULE_PERMANENT_ERROR", "RULE_TEMPORARY_ERROR", "POL_DEC_ERROR" ] }, { "type":"string" } ] }, "CreditManagementStatus":{ "description":"Indicates that the reason of the credit management session failure.", "anyOf":[ { "type":"string", "enum":[ "END_USER_SER_DENIED", "CREDIT_CTRL_NOT_APP", "AUTH_REJECTED", "USER_UNKNOWN", "RATING_FAILED" ] }, { "type":"string" } ] }, "SessionRuleFailureCode":{ "anyOf":[ { "type":"string", "enum":[ "NF_MAL", "RES_LIM", "SESSION_RESOURCE_ALLOCATION_FAILURE", "UNSUCC_QOS_VAL", "INCORRECT_UM", "UE_STA_SUSP", "UNKNOWN_REF_ID", "INCORRECT_COND_DATA", "REF_ID_COLLISION", "AN_GW_FAILED" ] }, { "type":"string", "description":"Provides forward-compatibility with future extensions to the enumeratio. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- NF_MAL: Indicates that the PCC rule could not be successfully installed (for those provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to SMF/UPF malfunction.\n- RES_LIM: Indicates that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF.\n- SESSION_RESOURCE_ALLOCATION_FAILURE: Indicates the session rule could not be successfully enforced due to failure during the allocation of resources for the PDU session in the UE, RAN or AMF.\n- UNSUCC_QOS_VAL: indicates that the QoS validation has failed.\n- INCORRECT_UM: The usage monitoring data of the enforced session rule is not the same for all the provisioned session rule(s).\n- UE_STA_SUSP: Indicates that the UE is in suspend state.\n- UNKNOWN_REF_ID: Indicates that the session rule could not be successfully installed/modified because the referenced identifier to a Policy Decision Data or to a Condition Data is unknown to the SMF.\n- INCORRECT_COND_DATA: Indicates that the session rule could not be successfully installed/modified because the referenced Condition data are incorrect.\n- REF_ID_COLLISION: Indicates that the session rule could not be successfully installed/modified because the same Policy Decision is referenced by a PCC rule (e.g. the session rule and the PCC rule refer to the same Usage Monitoring decision data).\n- AN_GW_FAILED: Indicates that the AN-Gateway has failed and that the PCF should refrain from sending policy decisions to the SMF until it is informed that the S-GW has been recovered. This value shall not be used if the SM Policy association modification procedure is initiated for session rule removal only.\n" }, "SteeringFunctionality":{ "type":"string", "enum":[ "MPTCP", "ATSSS_LL" ], "description":"Provides forward-compatibility with future extensions to the enumeration. Not used to encode content defined in the present version of this API. Possible values are\n - MPTCP: Indicates that PCF authorizes the MPTCP functionality to support traffic steering, switching and splitting.\n - ATSSS_LL: Indicates that PCF authorizes the ATSSS-LL functionality to support traffic steering, switching and splitting.\n" }, "SteerModeValue":{ "description":"Indicates that the steering mode value determined by the PCF.", "type":"string", "enum":[ "ACTIVE_STANDBY", "LOAD_BALANCING", "SMALLEST_DELAY", "PRIORITY_BASED" ] }, "MulticastAccessControl":{ "description":"Indicates whether the service data flow, corresponding to the service data flow template, is allowed or not allowed.", "anyOf":[ { "type":"string", "enum":[ "ALLOWED", "NOT_ALLOWED" ] }, { "type":"string" } ] }, "RequestedQosMonitoringParameter":{ "description":"Indicates the requested QoS monitoring parameters to be measured.", "anyOf":[ { "type":"string", "enum":[ "DOWNLINK", "UPLINK", "ROUND_TRIP" ] }, { "type":"string" } ] }, "ReportingFrequency":{ "description":"Indicates the frequency for reporting.", "anyOf":[ { "type":"string", "enum":[ "EVENT_TRIGGERED", "PERIODIC" ] }, { "type":"string" } ] }, "SgsnAddress":{ "description":"Describes the address of the SGSN", "type":"object", "anyOf":[ { "required":[ "sgsnIpv4Addr" ] }, { "required":[ "sgsnIpv6Addr" ] } ], "properties":{ "sgsnIpv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "sgsnIpv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" } } }, "SmPolicyAssociationReleaseCause":{ "description":"Represents the cause due to which the PCF requests the termination of the SM policy association.", "anyOf":[ { "type":"string", "enum":[ "UNSPECIFIED", "UE_SUBSCRIPTION", "INSUFFICIENT_RES", "VALIDATION_CONDITION_NOT_MET", "REACTIVATION_REQUESTED" ] }, { "type":"string" } ] }, "PduSessionRelCause":{ "description":"Contains the SMF PDU Session release cause.", "anyOf":[ { "type":"string", "enum":[ "PS_TO_CS_HO", "RULE_ERROR" ] }, { "type":"string" } ] }, "NetLocAccessSupport":{ "anyOf":[ { "type":"string", "enum":[ "ANR_NOT_SUPPORTED", "TZR_NOT_SUPPORTED", "LOC_NOT_SUPPORTED" ] }, { "type":"string", "description":"This string provides forward-compatibility with future extensions to the enumeratio. Not used to encode content defined in the present version of this API.\n" } ], "description":"Possible values are\n- ANR_NOT_SUPPORTED: Indicates that the access network does not support the report of access network information.\n- TZR_NOT_SUPPORTED: Indicates that the access network does not support the report of UE time zone.\n- LOC_NOT_SUPPORTED: Indicates that the access network does not support the report of UE Location (or PLMN Id).\n" }, "PolicyDecisionFailureCode":{ "description":"Indicates the type of the failed policy decision and/or condition data.", "anyOf":[ { "type":"string", "enum":[ "TRA_CTRL_DECS_ERR", "QOS_DECS_ERR", "CHG_DECS_ERR", "USA_MON_DECS_ERR", "QOS_MON_DECS_ERR", "CON_DATA_ERR", "POLICY_PARAM_ERR" ] }, { "type":"string" } ] }, "NotificationControlIndication":{ "description":"Indicates that the notification of DDD Status is requested and/or that the notification of DDN Failure is requested.", "anyOf":[ { "type":"string", "enum":[ "DDN_FAILURE", "DDD_STATUS" ] }, { "type":"string" } ] }, "SteerModeIndicator":{ "description":"Contains Autonomous load-balance indicator or UE-assistance indicator.", "anyOf":[ { "type":"string", "enum":[ "AUTO_LOAD_BALANCE", "UE_ASSISTANCE" ] }, { "type":"string" } ] }, "BucketRefOrValue":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the bucket." }, "href":{ "type":"string", "description":"The hyperlink reference to the bucket resource." }, "description":{ "type":"string", "description":"A description of the bucket's contents." }, "isShared":{ "type":"boolean", "description":"Whether the bucket is shared between several devices or users (true) or not (false)." }, "name":{ "type":"string", "description":"The friendly name for the bucket." }, "remainingValueName":{ "type":"string", "description":"The bucket's remaining amount, in a formatted string. For example, 1.9 Gb. This formatted string could be used for display." }, "status":{ "type":"string", "description":"The bucket's status, such as active, expired, or suspended." }, "usageType":{ "type":"string", "description":"The type of balance, such as data, voice, or a currency." }, "bucketCounter":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConsumptionSummary" } }, "bucketRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/BucketRelationship" } }, "logicalResource":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsageConsumptionLogicalResourceRef" } }, "partyAccount":{ "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsageConsumptionProductRef" } }, "relatedParty":{ "type":"array", "description":"Information about an entity related to the balance. For example, to define a customer hierarchy for the balance, such as customerId or userId.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "remainingValue":{ "$ref":"#/components/schemas/Quantity" }, "reserveBalance":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReserveBalanceRef" } }, "reservedValue":{ "$ref":"#/components/schemas/Quantity" }, "service":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceRef" } }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes. and relationships", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." } }, "description":"A bucket (called UsageVolumProduct in the SID Model), which represents and tracks a quantity of remaining or consumed usage. It could be either a quantity or an amount in a currency. It can represent a fixed number of SMS, MMS, call minutes, quantity of data, and so on." }, "BucketRelationship":{ "required":[ "bucketRefOrValue", "relationshipType" ], "type":"object", "properties":{ "relationshipType":{ "type":"string", "description":"The type of bucket relationship, such as isAggregated if the bucket is a part of another bucker or aggregator if the bucket holds other buckets." }, "bucketRefOrValue":{ "$ref":"#/components/schemas/BucketRefOrValue" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." } }, "description":"A linked bucket." }, "ConsumptionSummary":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the summary usage consumption report." }, "href":{ "type":"string", "description":"The hyperlink reference to the summary usage consumption report.", "format":"uri" }, "counterType":{ "type":"string", "description":"The type of consumption counter. For example: counterType=used or counterType=outOfBucket." }, "level":{ "type":"string", "description":"The counter level. The counter can be provided for the bucket globally across all users, detailed by user, or detailed by network product." }, "valueName":{ "type":"string", "description":"The value of the counter, in a formatted string used for display." }, "consumptionPeriod":{ "$ref":"#/components/schemas/TimePeriod" }, "user":{ "$ref":"#/components/schemas/RelatedParty" }, "value":{ "$ref":"#/components/schemas/Quantity" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." } }, "description":"Details about a consumption counter (called ConsumptionSummary in the SID model)." }, "PartyAccountRef":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the party account." }, "href":{ "type":"string", "description":"A reference to the party account." }, "description":{ "type":"string", "description":"A detailed description of the party account." }, "name":{ "type":"string", "description":"The name of the party account." }, "status":{ "type":"string", "description":"The condition of the account, such as due, paid, or in arrears." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." }, "@referredType":{ "type":"string", "description":"The actual type of target instance when needed for disambiguation." } }, "description":"A party account reference, which is an arrangement that a party has with an enterprise that provides products to the party." }, "Quantity":{ "type":"object", "properties":{ "amount":{ "type":"number", "description":"The numeric value for a specified unit.", "format":"float", "default":1 }, "units":{ "type":"string", "description":"The unit." } }, "description":"An amount in a specified unit." }, "QueryUsageConsumption":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the usage consumption object." }, "href":{ "type":"string", "description":"A hyperlink reference.", "format":"uri" }, "queryUsageConsumptionDate":{ "type":"string", "description":"The date when the request was submitted.", "format":"date-time" }, "partyAccount":{ "type":"array", "description":"A reference to the account that owns the bucket.", "items":{ "$ref":"#/components/schemas/PartyAccountRef" } }, "relatedParty":{ "type":"array", "description":"The reference and role of the related parties for which the usage consumption is requested.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "searchCriteria":{ "$ref":"#/components/schemas/UsageConsumption" }, "usageConsumption":{ "type":"array", "description":"A usage consumption report with the current counters and balances.", "items":{ "$ref":"#/components/schemas/UsageConsumption" } }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." } }, "description":"A usage consumption request." }, "QueryUsageConsumption_Create":{ "required":[ "searchCriteria" ], "type":"object", "properties":{ "queryUsageConsumptionDate":{ "type":"string", "description":"The date when the usage consumption query was submitted.", "format":"date-time" }, "partyAccount":{ "type":"array", "description":"A reference to the account that owns the bucket.", "items":{ "$ref":"#/components/schemas/PartyAccountRef" } }, "relatedParty":{ "type":"array", "description":"The reference and role of the related parties for which usage consumption is requested.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "searchCriteria":{ "$ref":"#/components/schemas/UsageConsumption" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." } }, "description":"A usage consumption request." }, "RelatedParty":{ "required":[ "@referredType", "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the related party." }, "href":{ "type":"string", "description":"The hyperlink reference.", "format":"uri" }, "name":{ "type":"string", "description":"The name of the related entity." }, "role":{ "type":"string", "description":"The role played by the related party." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-schema file that defines additional attributes. and relationships", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." }, "@referredType":{ "type":"string", "description":"The target instance's actual type (when needed for disambiguation)." } }, "description":"A related party, which defines the party or party role linked to a specific entity." }, "ReserveBalanceRef":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the reserve balance resource." }, "href":{ "type":"string", "description":"The reserve balance resource's hyperlink reference.", "format":"uri" }, "name":{ "type":"string", "description":"The name of the reserve balance resource." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super class." }, "@schemaLocation":{ "type":"string", "description":"The URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." }, "@referredType":{ "type":"string", "description":"The target instance's actual type (when needed for disambiguation)." } }, "description":"A reserve balance resource, which allows adjustments to be made to the original balance topup." }, "ServiceRef":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the service." }, "href":{ "type":"string", "description":"The service's hyperlink reference.", "format":"uri" }, "name":{ "type":"string", "description":"The name of the service." }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super class." }, "@schemaLocation":{ "type":"string", "description":"The URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." }, "@referredType":{ "type":"string", "description":"The target instance's actual type (when needed for disambiguation)." } }, "description":"A service reference." }, "TaskStateType":{ "type":"string", "description":"The task state.", "enum":[ "accepted", "terminatedWithError", "inProgress", "done" ] }, "TimePeriod":{ "type":"object", "properties":{ "endDateTime":{ "type":"string", "description":"The end of the time period, using IETC-RFC-3339 format.", "format":"date-time", "example":"1985-04-12T23:20:50.520Z" }, "startDateTime":{ "type":"string", "description":"The start of the time period, using IETC-RFC-3339 format.", "format":"date-time", "example":"1985-04-12T23:20:50.520Z" } }, "description":"A time period, as an end time, a start time, or both." }, "UsageConsumption":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the usage consumption object." }, "href":{ "type":"string", "description":"The usage consumption object's hyperlink reference.", "format":"uri" }, "creationDate":{ "type":"string", "description":"The date and time that the usage consumption object was created.", "format":"date-time" }, "description":{ "type":"string", "description":"A brief description of the usage consumption object." }, "lastUpdate":{ "type":"string", "description":"The date and time when the object's status was last changed.", "format":"date-time" }, "name":{ "type":"string", "description":"The name of the usage consumption object." }, "bucketRefOrValue":{ "type":"array", "description":"The buckets included in the subscribed offer.", "items":{ "$ref":"#/components/schemas/BucketRefOrValue" } }, "logicalResource":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsageConsumptionLogicalResourceRef" } }, "partyAccount":{ "type":"array", "description":"The account that owns the bucket.", "items":{ "$ref":"#/components/schemas/PartyAccountRef" } }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsageConsumptionProductRef" } }, "relatedParty":{ "type":"array", "description":"The reference and role of the related parties for which the usage consumption is requested.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "service":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceRef" } }, "state":{ "$ref":"#/components/schemas/TaskStateType" }, "validPeriod":{ "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super class." }, "@schemaLocation":{ "type":"string", "description":"The URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." } }, "description":"A usage consumption object, which contains the current balance and consumption counters for a subscriber's service type, such as SMS, Voice, and Data. The balance and consumption counters can be calculated for a device identified by a public key (such as an MSISDN number for a mobile device, or a PSTN or VOIP number for a fixed device)." }, "UsageConsumptionLogicalResourceRef":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the usage consumption logical resource." }, "href":{ "type":"string", "description":"The usage consumption logical resource's href.", "format":"uri" }, "name":{ "type":"string", "description":"The name of the consumption logical resource's hyperlink reference." }, "consumptionSummary":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConsumptionSummary" } }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super class." }, "@schemaLocation":{ "type":"string", "description":"The URI to the JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance (when needed for disambiguation)." } }, "description":"A logical resource." }, "UsageConsumptionProductRef":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"The ID of the usage consumption product." }, "href":{ "type":"string", "description":"The usage consumption product's hyperlink reference.", "format":"uri" }, "name":{ "type":"string", "description":"The name of the usage consumption product." }, "consumptionSummary":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConsumptionSummary" } }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super class." }, "@schemaLocation":{ "type":"string", "description":"The URI to the JSON-schema file that defines additional attributes.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class extension name." }, "@referredType":{ "type":"string", "description":"The target instance's actual type (when needed for disambiguation)." } } }, "Error":{ "required":[ "code", "reason" ], "type":"object", "properties":{ "code":{ "type":"string", "description":"The error code, which contains application-relevant detail." }, "reason":{ "type":"string", "description":"The reason for the error that can be shown to a client user." }, "message":{ "type":"string", "description":"Additional details about the error as well as possible corrective actions." }, "status":{ "type":"string", "description":"The HTTP error code extension." }, "referenceError":{ "type":"string", "description":"The URI to the documentation describing the error.", "format":"uri" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super class." }, "@schemaLocation":{ "type":"string", "description":"The URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class entity name." } }, "description":"An error." }, "SpendingLimitContext":{ "description":"Represents the subscription data structure required for an individual CHF spending limit subscription.\n", "type":"object", "properties":{ "supi":{ "$ref":"#/components/schemas/Supi" }, "gpsi":{ "$ref":"#/components/schemas/Gpsi" }, "policyCounterIds":{ "type":"array", "items":{ "$ref":"#/components/schemas/PolicyCounterId" }, "minItems":1, "description":"Refers to a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.\n" }, "notifUri":{ "$ref":"#/components/schemas/Uri" }, "expiry":{ "$ref":"#/components/schemas/DateTime" }, "supportedFeatures":{ "$ref":"#/components/schemas/SupportedFeatures" }, "notifId":{ "type":"string" } } }, "SpendingLimitStatus":{ "description":"Represents the data structure presenting the statuses of policy counters.\n", "type":"object", "properties":{ "supi":{ "$ref":"#/components/schemas/Supi" }, "notifId":{ "type":"string" }, "statusInfos":{ "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/PolicyCounterInfo" }, "minProperties":1, "description":"Refers to the status of the requested policy counters. The key of the map is the attribute \"policyCounterId\".\n" }, "expiry":{ "$ref":"#/components/schemas/DateTime" }, "supportedFeatures":{ "$ref":"#/components/schemas/SupportedFeatures" } } }, "PolicyCounterInfo":{ "description":"Represents the data structure presenting the policy counter status.", "type":"object", "properties":{ "policyCounterId":{ "$ref":"#/components/schemas/PolicyCounterId" }, "currentStatus":{ "type":"string", "description":"Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.\n" }, "penPolCounterStatuses":{ "description":"Provides the pending policy counter status.", "type":"array", "items":{ "$ref":"#/components/schemas/PendingPolicyCounterStatus" }, "minItems":1 } }, "required":[ "policyCounterId", "currentStatus" ] }, "PendingPolicyCounterStatus":{ "description":"Represents the data structure presenting the pending policy counter status.\n", "type":"object", "properties":{ "policyCounterStatus":{ "type":"string", "description":"Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.\n" }, "activationTime":{ "$ref":"#/components/schemas/DateTime" } }, "required":[ "policyCounterStatus", "activationTime" ] }, "PolicyCounterId":{ "type":"string", "description":"Identifies a policy counter." }, "SubscriptionTerminationInfo":{ "description":"Represents the data structure presenting the indication of the termination of the subscription.\n", "type":"object", "properties":{ "supi":{ "$ref":"#/components/schemas/Supi" }, "notifId":{ "type":"string" }, "termCause":{ "$ref":"#/components/schemas/TerminationCause" } }, "required":[ "supi" ] }, "TerminationCause":{ "description":"Represents the cause for requesting the termination of the subscription to policy counter status changes.\n", "type":"string", "enum":[ "REMOVED_SUBSCRIBER" ] }, "SpatialValidityCond":{ "description":"Contains the spatial validity condition.", "type":"object", "properties":{ "trackingAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tai" }, "minItems":1 }, "countries":{ "type":"array", "items":{ "$ref":"#/components/schemas/Mcc" }, "minItems":1 }, "geographicalServiceArea":{ "$ref":"#/components/schemas/GeoServiceArea" } } }, "SpatialValidityCondRm":{ "description":"Contains the spatial validity condition or the null value.", "anyOf":[ { "$ref":"#/components/schemas/SpatialValidityCond" }, { "$ref":"#/components/schemas/NullValue" } ] }, "GeoServiceArea":{ "description":"List of geographic areas or a list of civic addresses.", "type":"object", "properties":{ "geographicAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicArea" }, "minItems":1 }, "civicAddressList":{ "type":"array", "items":{ "$ref":"#/components/schemas/CivicAddress" }, "minItems":1 } } }, "ExternalMbsServiceArea":{ "description":"Refers to a list of geographic areas or a list of civic address information for MBS Service Areas.", "type":"object", "properties":{ "geographicAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicArea" }, "minItems":1 }, "civicAddressList":{ "type":"array", "items":{ "$ref":"#/components/schemas/CivicAddress" }, "minItems":1 } }, "oneOf":[ { "required":[ "geographicAreaList" ] }, { "required":[ "civicAddressList" ] } ] }, "GeographicArea":{ "description":"Refers to a geographic area specified by different shapes.", "anyOf":[ { "$ref":"#/components/schemas/Point" }, { "$ref":"#/components/schemas/PointUncertaintyCircle" }, { "$ref":"#/components/schemas/PointUncertaintyEllipse" }, { "$ref":"#/components/schemas/Polygon" }, { "$ref":"#/components/schemas/PointAltitude" }, { "$ref":"#/components/schemas/PointAltitudeUncertainty" }, { "$ref":"#/components/schemas/EllipsoidArc" } ] }, "GADShape":{ "description":"Refers to a common base type for GAD shapes.", "type":"object", "required":[ "shape" ], "properties":{ "shape":{ "$ref":"#/components/schemas/SupportedGADShapes" } }, "discriminator":{ "propertyName":"shape", "mapping":{ "POINT":"#/components/schemas/Point", "POINT_UNCERTAINTY_CIRCLE":"#/components/schemas/PointUncertaintyCircle", "POINT_UNCERTAINTY_ELLIPSE":"#/components/schemas/PointUncertaintyEllipse", "POLYGON":"#/components/schemas/Polygon", "POINT_ALTITUDE":"#/components/schemas/PointAltitude", "POINT_ALTITUDE_UNCERTAINTY":"#/components/schemas/PointAltitudeUncertainty", "ELLIPSOID_ARC":"#/components/schemas/EllipsoidArc", "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE":"#/components/schemas/Local2dPointUncertaintyEllipse", "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID":"#/components/schemas/Local3dPointUncertaintyEllipsoid" } } }, "Point":{ "description":"Refers to the ellipsoid point.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "point" ], "properties":{ "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" } } } ] }, "PointUncertaintyCircle":{ "description":"Refers the an ellipsoid point with uncertainty circle.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "point", "uncertainty" ], "properties":{ "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "uncertainty":{ "$ref":"#/components/schemas/Uncertainty" } } } ] }, "PointUncertaintyEllipse":{ "description":"Refers to an ellipsoid point with uncertainty ellipse.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "point", "uncertaintyEllipse", "confidence" ], "properties":{ "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "uncertaintyEllipse":{ "$ref":"#/components/schemas/UncertaintyEllipse" }, "confidence":{ "$ref":"#/components/schemas/Confidence" } } } ] }, "Polygon":{ "description":"Refers to a polygon.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "pointList" ], "properties":{ "pointList":{ "$ref":"#/components/schemas/PointList" } } } ] }, "PointAltitude":{ "description":"Refers to an ellipsoid point with altitude.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "point", "altitude" ], "properties":{ "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "altitude":{ "$ref":"#/components/schemas/Altitude" } } } ] }, "PointAltitudeUncertainty":{ "description":"Refers to an ellipsoid point with altitude and uncertainty ellipsoid.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "point", "altitude", "uncertaintyEllipse", "uncertaintyAltitude", "confidence" ], "properties":{ "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "altitude":{ "$ref":"#/components/schemas/Altitude" }, "uncertaintyEllipse":{ "$ref":"#/components/schemas/UncertaintyEllipse" }, "uncertaintyAltitude":{ "$ref":"#/components/schemas/Uncertainty" }, "confidence":{ "$ref":"#/components/schemas/Confidence" }, "vConfidence":{ "$ref":"#/components/schemas/Confidence" } } } ] }, "EllipsoidArc":{ "description":"Refers to an ellipsoid arc.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "point", "innerRadius", "uncertaintyRadius", "offsetAngle", "includedAngle", "confidence" ], "properties":{ "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "innerRadius":{ "$ref":"#/components/schemas/InnerRadius" }, "uncertaintyRadius":{ "$ref":"#/components/schemas/Uncertainty" }, "offsetAngle":{ "$ref":"#/components/schemas/Angle" }, "includedAngle":{ "$ref":"#/components/schemas/Angle" }, "confidence":{ "$ref":"#/components/schemas/Confidence" } } } ] }, "LocalOrigin":{ "description":"Indicates a local origin in a reference system.", "type":"object", "properties":{ "coordinateId":{ "type":"string" }, "point":{ "$ref":"#/components/schemas/GeographicalCoordinates" } } }, "RelativeCartesianLocation":{ "description":"Refers to the relative cartesian location.", "type":"object", "required":[ "x", "y" ], "properties":{ "x":{ "$ref":"#/components/schemas/Float" }, "y":{ "$ref":"#/components/schemas/Float" }, "z":{ "$ref":"#/components/schemas/Float" } } }, "LocalArea":{ "description":"Refers to a local area specified by a different shape.", "oneOf":[ { "$ref":"#/components/schemas/Local2dPointUncertaintyEllipse" }, { "$ref":"#/components/schemas/Local3dPointUncertaintyEllipsoid" } ] }, "UeAreaIndication":{ "description":"Indicates area (country, area in a country or international area) where the UE is located.", "type":"object", "oneOf":[ { "required":[ "country" ] }, { "required":[ "internationalAreaInd" ] } ], "properties":{ "country":{ "description":"Indicates the country or area in a country where UE is located.", "type":"string" }, "internationalAreaInd":{ "description":"Refers to the international area indication if the UE is located in an international area.", "type":"boolean", "default":false } } }, "Local2dPointUncertaintyEllipse":{ "description":"Refers the a local 2D point with uncertainty ellipse.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "localOrigin", "point", "uncertaintyEllipse", "confidence" ], "properties":{ "localOrigin":{ "$ref":"#/components/schemas/LocalOrigin" }, "point":{ "$ref":"#/components/schemas/RelativeCartesianLocation" }, "uncertaintyEllipse":{ "$ref":"#/components/schemas/UncertaintyEllipse" }, "confidence":{ "$ref":"#/components/schemas/Confidence" } } } ] }, "Local3dPointUncertaintyEllipsoid":{ "description":"Refers to the local 3D point with uncertainty ellipsoid.", "allOf":[ { "$ref":"#/components/schemas/GADShape" }, { "type":"object", "required":[ "localOrigin", "point", "uncertaintyEllipsoid", "confidence" ], "properties":{ "localOrigin":{ "$ref":"#/components/schemas/LocalOrigin" }, "point":{ "$ref":"#/components/schemas/RelativeCartesianLocation" }, "uncertaintyEllipsoid":{ "$ref":"#/components/schemas/UncertaintyEllipsoid" }, "confidence":{ "$ref":"#/components/schemas/Confidence" }, "vConfidence":{ "$ref":"#/components/schemas/Confidence" } } } ] }, "GeographicalCoordinates":{ "description":"Indicates the geographical coordinates.", "type":"object", "required":[ "lon", "lat" ], "properties":{ "lon":{ "type":"number", "format":"double", "minimum":-180, "maximum":180 }, "lat":{ "type":"number", "format":"double", "minimum":-90, "maximum":90 } } }, "UncertaintyEllipse":{ "description":"Refers to an ellipse with uncertainty.", "type":"object", "required":[ "semiMajor", "semiMinor", "orientationMajor" ], "properties":{ "semiMajor":{ "$ref":"#/components/schemas/Uncertainty" }, "semiMinor":{ "$ref":"#/components/schemas/Uncertainty" }, "orientationMajor":{ "$ref":"#/components/schemas/Orientation" } } }, "UncertaintyEllipsoid":{ "description":"Refers to an ellipsoid with uncertainty.", "type":"object", "required":[ "semiMajor", "semiMinor", "vertical", "orientationMajor" ], "properties":{ "semiMajor":{ "$ref":"#/components/schemas/Uncertainty" }, "semiMinor":{ "$ref":"#/components/schemas/Uncertainty" }, "vertical":{ "$ref":"#/components/schemas/Uncertainty" }, "orientationMajor":{ "$ref":"#/components/schemas/Orientation" } } }, "PointList":{ "description":"Refers to a list of points.", "type":"array", "items":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "minItems":3, "maxItems":15 }, "LocationQoS":{ "description":"Refers to the QoS of the location request.", "type":"object", "properties":{ "hAccuracy":{ "$ref":"#/components/schemas/Accuracy" }, "vAccuracy":{ "$ref":"#/components/schemas/Accuracy" }, "verticalRequested":{ "type":"boolean" }, "responseTime":{ "$ref":"#/components/schemas/ResponseTime" }, "minorLocQoses":{ "type":"array", "items":{ "$ref":"#/components/schemas/MinorLocationQoS" }, "minItems":1, "maxItems":2 }, "lcsQosClass":{ "$ref":"#/components/schemas/LcsQosClass" } } }, "PositioningMethodAndUsage":{ "description":"Indicates the usage of a positioning method.", "type":"object", "required":[ "method", "mode", "usage" ], "properties":{ "method":{ "$ref":"#/components/schemas/PositioningMethod" }, "mode":{ "$ref":"#/components/schemas/PositioningMode" }, "usage":{ "$ref":"#/components/schemas/Usage" }, "methodCode":{ "type":"integer", "minimum":16, "maximum":31 } } }, "GnssPositioningMethodAndUsage":{ "description":"Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method.", "type":"object", "required":[ "mode", "gnss", "usage" ], "properties":{ "mode":{ "$ref":"#/components/schemas/PositioningMode" }, "gnss":{ "$ref":"#/components/schemas/GnssId" }, "usage":{ "$ref":"#/components/schemas/Usage" } } }, "CivicAddress":{ "description":"Indicates a civic address.", "type":"object", "properties":{ "country":{ "type":"string" }, "A1":{ "type":"string" }, "A2":{ "type":"string" }, "A3":{ "type":"string" }, "A4":{ "type":"string" }, "A5":{ "type":"string" }, "A6":{ "type":"string" }, "PRD":{ "type":"string" }, "POD":{ "type":"string" }, "STS":{ "type":"string" }, "HNO":{ "type":"string" }, "HNS":{ "type":"string" }, "LMK":{ "type":"string" }, "LOC":{ "type":"string" }, "NAM":{ "type":"string" }, "PC":{ "type":"string" }, "BLD":{ "type":"string" }, "UNIT":{ "type":"string" }, "FLR":{ "type":"string" }, "ROOM":{ "type":"string" }, "PLC":{ "type":"string" }, "PCN":{ "type":"string" }, "POBOX":{ "type":"string" }, "ADDCODE":{ "type":"string" }, "SEAT":{ "type":"string" }, "RD":{ "type":"string" }, "RDSEC":{ "type":"string" }, "RDBR":{ "type":"string" }, "RDSUBBR":{ "type":"string" }, "PRM":{ "type":"string" }, "POM":{ "type":"string" }, "usageRules":{ "type":"string" }, "method":{ "type":"string" }, "providedBy":{ "type":"string" } } }, "VelocityEstimate":{ "description":"Refers to the velocity estimate.", "anyOf":[ { "$ref":"#/components/schemas/HorizontalVelocity" }, { "$ref":"#/components/schemas/HorizontalWithVerticalVelocity" }, { "$ref":"#/components/schemas/HorizontalVelocityWithUncertainty" }, { "$ref":"#/components/schemas/HorizontalWithVerticalVelocityAndUncertainty" } ] }, "HorizontalVelocity":{ "description":"Refers to the horizontal velocity.", "type":"object", "required":[ "hSpeed", "bearing" ], "properties":{ "hSpeed":{ "$ref":"#/components/schemas/HorizontalSpeed" }, "bearing":{ "$ref":"#/components/schemas/Angle" } } }, "HorizontalWithVerticalVelocity":{ "description":"Refers to the horizontal and vertical velocity.", "type":"object", "required":[ "hSpeed", "bearing", "vSpeed", "vDirection" ], "properties":{ "hSpeed":{ "$ref":"#/components/schemas/HorizontalSpeed" }, "bearing":{ "$ref":"#/components/schemas/Angle" }, "vSpeed":{ "$ref":"#/components/schemas/VerticalSpeed" }, "vDirection":{ "$ref":"#/components/schemas/VerticalDirection" } } }, "HorizontalVelocityWithUncertainty":{ "description":"Refers to the horizontal velocity with speed uncertainty.", "type":"object", "required":[ "hSpeed", "bearing", "hUncertainty" ], "properties":{ "hSpeed":{ "$ref":"#/components/schemas/HorizontalSpeed" }, "bearing":{ "$ref":"#/components/schemas/Angle" }, "hUncertainty":{ "$ref":"#/components/schemas/SpeedUncertainty" } } }, "HorizontalWithVerticalVelocityAndUncertainty":{ "description":"Refers to the horizontal and vertical velocity with speed uncertainty.", "type":"object", "required":[ "hSpeed", "bearing", "vSpeed", "vDirection", "hUncertainty", "vUncertainty" ], "properties":{ "hSpeed":{ "$ref":"#/components/schemas/HorizontalSpeed" }, "bearing":{ "$ref":"#/components/schemas/Angle" }, "vSpeed":{ "$ref":"#/components/schemas/VerticalSpeed" }, "vDirection":{ "$ref":"#/components/schemas/VerticalDirection" }, "hUncertainty":{ "$ref":"#/components/schemas/SpeedUncertainty" }, "vUncertainty":{ "$ref":"#/components/schemas/SpeedUncertainty" } } }, "UeLcsCapability":{ "description":"Indicates the LCS capability supported by the UE.", "type":"object", "properties":{ "lppSupport":{ "type":"boolean", "default":true }, "ciotOptimisation":{ "type":"boolean", "default":false } } }, "PeriodicEventInfo":{ "description":"Indicates the information of periodic event reporting.", "type":"object", "required":[ "reportingAmount", "reportingInterval" ], "properties":{ "reportingAmount":{ "$ref":"#/components/schemas/ReportingAmount" }, "reportingInterval":{ "$ref":"#/components/schemas/ReportingInterval" }, "reportingInfiniteInd":{ "type":"boolean", "enum":[ true ] }, "reportingIntervalMs":{ "$ref":"#/components/schemas/ReportingIntervalMs" } } }, "AreaEventInfo":{ "description":"Indicates the information of area based event reporting.", "type":"object", "required":[ "areaDefinition" ], "properties":{ "areaDefinition":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReportingArea" }, "minItems":1, "maxItems":250 }, "occurrenceInfo":{ "$ref":"#/components/schemas/OccurrenceInfo" }, "minimumInterval":{ "$ref":"#/components/schemas/MinimumInterval" }, "maximumInterval":{ "$ref":"#/components/schemas/MaximumInterval" }, "samplingInterval":{ "$ref":"#/components/schemas/SamplingInterval" }, "reportingDuration":{ "$ref":"#/components/schemas/ReportingDuration" }, "reportingLocationReq":{ "type":"boolean", "default":true } } }, "ReportingArea":{ "description":"Indicates an area for event reporting.", "type":"object", "required":[ "areaType" ], "properties":{ "areaType":{ "$ref":"#/components/schemas/ReportingAreaType" }, "tai":{ "$ref":"#/components/schemas/Tai" }, "ecgi":{ "$ref":"#/components/schemas/Ecgi" }, "ncgi":{ "$ref":"#/components/schemas/Ncgi" } } }, "MotionEventInfo":{ "description":"Indicates the information of motion based event reporting.", "type":"object", "required":[ "linearDistance" ], "properties":{ "linearDistance":{ "$ref":"#/components/schemas/LinearDistance" }, "occurrenceInfo":{ "$ref":"#/components/schemas/OccurrenceInfo" }, "minimumInterval":{ "$ref":"#/components/schemas/MinimumInterval" }, "maximumInterval":{ "$ref":"#/components/schemas/MaximumInterval" }, "samplingInterval":{ "$ref":"#/components/schemas/SamplingInterval" }, "reportingDuration":{ "$ref":"#/components/schemas/ReportingDuration" }, "reportingLocationReq":{ "type":"boolean", "default":true } } }, "CancelLocData":{ "description":"Refers to the information within cancel location request.", "type":"object", "required":[ "hgmlcCallBackURI", "ldrReference" ], "properties":{ "hgmlcCallBackURI":{ "$ref":"#/components/schemas/Uri" }, "ldrReference":{ "$ref":"#/components/schemas/LdrReference" }, "supportedFeatures":{ "$ref":"#/components/schemas/SupportedFeatures" } } }, "LocContextData":{ "description":"Refers to the information within transfer location context request.", "type":"object", "required":[ "amfId", "ldrType", "hgmlcCallBackURI", "ldrReference", "eventReportMessage" ], "properties":{ "amfId":{ "$ref":"#/components/schemas/NfInstanceId" }, "locationQoS":{ "$ref":"#/components/schemas/LocationQoS" }, "supportedGADShapes":{ "type":"array", "items":{ "$ref":"#/components/schemas/SupportedGADShapes" }, "minItems":1 }, "supi":{ "$ref":"#/components/schemas/Supi" }, "gpsi":{ "$ref":"#/components/schemas/Gpsi" }, "ldrType":{ "$ref":"#/components/schemas/LdrType" }, "hgmlcCallBackURI":{ "$ref":"#/components/schemas/Uri" }, "ldrReference":{ "$ref":"#/components/schemas/LdrReference" }, "periodicEventInfo":{ "$ref":"#/components/schemas/PeriodicEventInfo" }, "areaEventInfo":{ "$ref":"#/components/schemas/AreaEventInfo" }, "motionEventInfo":{ "$ref":"#/components/schemas/MotionEventInfo" }, "eventReportMessage":{ "$ref":"#/components/schemas/EventReportMessage" }, "eventReportingStatus":{ "$ref":"#/components/schemas/EventReportingStatus" }, "ueLocationInfo":{ "$ref":"#/components/schemas/UELocationInfo" }, "cIoT5GSOptimisation":{ "type":"boolean", "default":false }, "ecgi":{ "$ref":"#/components/schemas/Ecgi" }, "ncgi":{ "$ref":"#/components/schemas/Ncgi" }, "guami":{ "$ref":"#/components/schemas/Guami" }, "supportedFeatures":{ "$ref":"#/components/schemas/SupportedFeatures" }, "uePositioningCap":{ "$ref":"#/components/schemas/UePositioningCapabilities" }, "scheduledLocTime":{ "$ref":"#/components/schemas/DateTime" } } }, "EventReportMessage":{ "description":"Indicates an event report message.", "type":"object", "required":[ "eventClass", "eventContent" ], "properties":{ "eventClass":{ "$ref":"#/components/schemas/EventClass" }, "eventContent":{ "$ref":"#/components/schemas/RefToBinaryData" } } }, "EventReportingStatus":{ "description":"Indicates the status of event reporting.", "type":"object", "properties":{ "eventReportCounter":{ "$ref":"#/components/schemas/EventReportCounter" }, "eventReportDuration":{ "$ref":"#/components/schemas/EventReportDuration" } } }, "UELocationInfo":{ "description":"Indicates the location information of a UE.", "type":"object", "properties":{ "locationEstimate":{ "$ref":"#/components/schemas/GeographicArea" }, "ageOfLocationEstimate":{ "$ref":"#/components/schemas/AgeOfLocationEstimate" }, "timestampOfLocationEstimate":{ "$ref":"#/components/schemas/DateTime" }, "velocityEstimate":{ "$ref":"#/components/schemas/VelocityEstimate" }, "ageOfVelocityEstimate":{ "$ref":"#/components/schemas/AgeOfLocationEstimate" }, "timestampOfVelocityEstimate":{ "$ref":"#/components/schemas/DateTime" } } }, "MinorLocationQoS":{ "description":"Contains the minor location QoS.", "type":"object", "properties":{ "hAccuracy":{ "$ref":"#/components/schemas/Accuracy" }, "vAccuracy":{ "$ref":"#/components/schemas/Accuracy" } } }, "HighAccuracyGnssMetrics":{ "description":"Refers to the high accuracy GNSS positioning metrics.", "type":"object", "properties":{ "nrOfUsedSatellites":{ "type":"integer", "minimum":0, "maximum":64 }, "hdopi":{ "type":"integer", "minimum":1, "maximum":256 }, "pdopi":{ "type":"integer", "minimum":1, "maximum":256 }, "age":{ "type":"integer", "minimum":0, "maximum":99 }, "fixType":{ "$ref":"#/components/schemas/FixType" } } }, "Altitude":{ "description":"Indicates the value of the altitude.", "type":"number", "format":"double", "minimum":-32767, "maximum":32767 }, "Angle":{ "description":"Indicates the value of the angle.", "type":"integer", "minimum":0, "maximum":360 }, "Uncertainty":{ "description":"Indicates the value of uncertainty.", "type":"number", "format":"float", "minimum":0 }, "Orientation":{ "description":"Indicates the value of the orientation angle.", "type":"integer", "minimum":0, "maximum":180 }, "Confidence":{ "description":"Indicates the value of confidence.", "type":"integer", "minimum":0, "maximum":100 }, "Accuracy":{ "description":"Indicates the value of accuracy.", "type":"number", "format":"float", "minimum":0 }, "InnerRadius":{ "description":"Indicates the value of the inner radius.", "type":"integer", "format":"int32", "minimum":0, "maximum":327675 }, "CorrelationID":{ "description":"LCS Correlation ID.", "type":"string", "minLength":1, "maxLength":255 }, "AgeOfLocationEstimate":{ "description":"Indicatesthe value of the age of the location estimate.", "type":"integer", "minimum":0, "maximum":32767 }, "HorizontalSpeed":{ "description":"Indicates the value of horizontal speed.", "type":"number", "format":"float", "minimum":0, "maximum":2047 }, "VerticalSpeed":{ "description":"Indicates the value of vertical speed.", "type":"number", "format":"float", "minimum":0, "maximum":255 }, "SpeedUncertainty":{ "description":"Indicates the value of speed uncertainty.", "type":"number", "format":"float", "minimum":0, "maximum":255 }, "BarometricPressure":{ "description":"Specifies the measured uncompensated atmospheric pressure.", "type":"integer", "minimum":30000, "maximum":115000 }, "LcsServiceType":{ "description":"Refers to the LCS service type.", "type":"integer", "minimum":0, "maximum":127 }, "LdrReference":{ "description":"Refers to the LDR Reference.", "type":"string", "minLength":2, "maxLength":510 }, "ReportingAmount":{ "description":"Refers to the number of required periodic event reports.", "type":"integer", "minimum":1, "maximum":8639999 }, "ReportingInterval":{ "description":"Refers to the cvent reporting periodic interval (in seconds).", "type":"integer", "minimum":1, "maximum":8639999 }, "ReportingIntervalMs":{ "description":"Refers to the event reporting periodic interval (in milliseconds).", "type":"integer", "minimum":1, "maximum":999 }, "MinimumInterval":{ "description":"Refers to the minimum interval between event reports.", "type":"integer", "minimum":1, "maximum":32767 }, "MaximumInterval":{ "description":"Refers to the maximum interval between event reports.", "type":"integer", "minimum":1, "maximum":86400 }, "SamplingInterval":{ "description":"Refers to the maximum time interval between consecutive evaluations by a UE of a trigger event.", "type":"integer", "minimum":1, "maximum":3600 }, "ReportingDuration":{ "description":"Refers to the maximum duration of event reporting.", "type":"integer", "minimum":1, "maximum":8640000 }, "LinearDistance":{ "description":"Refers to the minimum straight line distance moved by a UE to trigger a motion event report.", "type":"integer", "minimum":1, "maximum":10000 }, "LMFIdentification":{ "description":"Refers to the LMF identification.", "type":"string" }, "EventReportCounter":{ "description":"Refers to the number of event reports received from the target UE.", "type":"integer", "minimum":1, "maximum":8640000 }, "EventReportDuration":{ "description":"Refers to the duration of event reporting.", "type":"integer", "minimum":1, "maximum":8640000 }, "UePositioningCapabilities":{ "description":"Refers to the positioning capabilities supported by the UE. A string encoding the \"ProvideCapabilities-r9-IEs\" IE as specified in clause 6.3 of 3GPP TS 37.355 (start from octet 1).", "type":"string", "format":"byte" }, "ExternalClientType":{ "description":"Indicates types of External Clients.", "type":"string", "enum":[ "EMERGENCY_SERVICES", "VALUE_ADDED_SERVICES", "PLMN_OPERATOR_SERVICES", "LAWFUL_INTERCEPT_SERVICES", "PLMN_OPERATOR_BROADCAST_SERVICES", "PLMN_OPERATOR_OM", "PLMN_OPERATOR_ANONYMOUS_STATISTICS", "PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT" ] }, "SupportedGADShapes":{ "description":"Indicates supported GAD shapes.", "anyOf":[ { "type":"string", "enum":[ "POINT", "POINT_UNCERTAINTY_CIRCLE", "POINT_UNCERTAINTY_ELLIPSE", "POLYGON", "POINT_ALTITUDE", "POINT_ALTITUDE_UNCERTAINTY", "ELLIPSOID_ARC", "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE", "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID" ] }, { "type":"string" } ] }, "ResponseTime":{ "description":"Indicates acceptable delay of location request.", "anyOf":[ { "type":"string", "enum":[ "LOW_DELAY", "DELAY_TOLERANT", "NO_DELAY" ] }, { "type":"string" } ] }, "PositioningMethod":{ "description":"Indicates supported positioning methods.", "anyOf":[ { "type":"string", "enum":[ "CELLID", "ECID", "OTDOA", "BAROMETRIC_PRESSURE", "WLAN", "BLUETOOTH", "MBS", "MOTION_SENSOR", "DL_TDOA", "DL_AOD", "MULTI-RTT", "NR_ECID", "UL_TDOA", "UL_AOA", "NETWORK_SPECIFIC" ] }, { "type":"string" } ] }, "PositioningMode":{ "description":"Indicates supported modes used for positioning method.", "anyOf":[ { "type":"string", "enum":[ "UE_BASED", "UE_ASSISTED", "CONVENTIONAL" ] }, { "type":"string" } ] }, "GnssId":{ "description":"Refers to the Global Navigation Satellite System (GNSS) ID.", "anyOf":[ { "type":"string", "enum":[ "GPS", "GALILEO", "SBAS", "MODERNIZED_GPS", "QZSS", "GLONASS", "BDS", "NAVIC" ] }, { "type":"string" } ] }, "Usage":{ "description":"Indicates usage made of the location measurement.", "anyOf":[ { "type":"string", "enum":[ "UNSUCCESS", "SUCCESS_RESULTS_NOT_USED", "SUCCESS_RESULTS_USED_TO_VERIFY_LOCATION", "SUCCESS_RESULTS_USED_TO_GENERATE_LOCATION", "SUCCESS_METHOD_NOT_DETERMINED" ] }, { "type":"string" } ] }, "LcsPriority":{ "description":"Indicates the priority of the LCS client.", "anyOf":[ { "type":"string", "enum":[ "HIGHEST_PRIORITY", "NORMAL_PRIORITY" ] }, { "type":"string" } ] }, "VelocityRequested":{ "description":"Indicates the velocity requirement.", "anyOf":[ { "type":"string", "enum":[ "VELOCITY_IS_NOT_REQUESTED", "VELOCITY_IS_REQUESTED" ] }, { "type":"string" } ] }, "AccuracyFulfilmentIndicator":{ "description":"Indicates the fulfilment of requested accuracy.", "anyOf":[ { "type":"string", "enum":[ "REQUESTED_ACCURACY_FULFILLED", "REQUESTED_ACCURACY_NOT_FULFILLED" ] }, { "type":"string" } ] }, "VerticalDirection":{ "description":"Indicates the direction of vertical speed.", "type":"string", "enum":[ "UPWARD", "DOWNWARD" ] }, "LdrType":{ "description":"Indicates LDR types.", "anyOf":[ { "type":"string", "enum":[ "UE_AVAILABLE", "PERIODIC", "ENTERING_INTO_AREA", "LEAVING_FROM_AREA", "BEING_INSIDE_AREA", "MOTION" ] }, { "type":"string" } ] }, "ReportingAreaType":{ "description":"Indicates the type of event reporting area.", "anyOf":[ { "type":"string", "enum":[ "EPS_TRACKING_AREA_IDENTITY", "E-UTRAN_CELL_GLOBAL_IDENTIFICATION", "5GS_TRACKING_AREA_IDENTITY", "NR_CELL_GLOBAL_IDENTITY" ] }, { "type":"string" } ] }, "OccurrenceInfo":{ "description":"Specifies the occurrence of event reporting.", "anyOf":[ { "type":"string", "enum":[ "ONE_TIME_EVENT", "MULTIPLE_TIME_EVENT" ] }, { "type":"string" } ] }, "ReportingAccessType":{ "description":"Specifies access types of event reporting.", "anyOf":[ { "type":"string", "enum":[ "NR", "EUTRA_CONNECTED_TO_5GC", "NON_3GPP_CONNECTED_TO_5GC", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT" ] }, { "type":"string" } ] }, "EventClass":{ "description":"Specifies event classes.", "anyOf":[ { "type":"string", "enum":[ "SUPPLEMENTARY_SERVICES" ] }, { "type":"string" } ] }, "ReportedEventType":{ "description":"Specifies the type of event reporting.", "anyOf":[ { "type":"string", "enum":[ "PERIODIC_EVENT", "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT", "BEING_INSIDE_AREA_EVENT", "MOTION_EVENT", "MAXIMUM_INTERVAL_EXPIRATION_EVENT", "LOCATION_CANCELLATION_EVENT" ] }, { "type":"string" } ] }, "LcsQosClass":{ "description":"Specifies the LCS QoS class.", "anyOf":[ { "type":"string", "enum":[ "BEST_EFFORT", "ASSURED", "MULTIPLE_QOS" ] }, { "type":"string" } ] }, "UeLocationServiceInd":{ "description":"Specifies location service types requested by UE.", "anyOf":[ { "type":"string", "enum":[ "LOCATION_ESTIMATE", "LOCATION_ASSISTANCE_DATA" ] }, { "type":"string" } ] }, "FixType":{ "description":"Specifies the positioning fix type.", "anyOf":[ { "type":"string", "enum":[ "CARRIER_PHASE_FLOAT", "CARRIER_PHASE_FIX" ] }, { "type":"string" } ] }, "ChargingNotifyRequest":{ "type":"object", "description":"A notification request.", "properties":{ "notificationType":{ "$ref":"#/components/schemas/NotificationType" }, "reauthorizationDetails":{ "description":"Reauthorization data that specifies the quota or usage reporting to update.", "type":"array", "items":{ "$ref":"#/components/schemas/ReauthorizationDetails" }, "minItems":0 } }, "required":[ "notificationType" ] }, "ChargingNotifyResponse":{ "type":"object", "properties":{ "invocationResult":{ "$ref":"#/components/schemas/InvocationResult" } } }, "MultipleUnitInformation":{ "type":"object", "properties":{ "resultCode":{ "$ref":"#/components/schemas/ResultCode" }, "ratingGroup":{ "$ref":"#/components/schemas/RatingGroup" }, "grantedUnit":{ "$ref":"#/components/schemas/GrantedUnit" }, "triggers":{ "type":"array", "items":{ "$ref":"#/components/schemas/Trigger" }, "minItems":0 }, "validityTime":{ "$ref":"#/components/schemas/DurationSec" }, "quotaHoldingTime":{ "$ref":"#/components/schemas/DurationSec" }, "finalUnitIndication":{ "$ref":"#/components/schemas/FinalUnitIndication" }, "timeQuotaThreshold":{ "type":"integer" }, "volumeQuotaThreshold":{ "$ref":"#/components/schemas/Uint64" }, "unitQuotaThreshold":{ "type":"integer" }, "uPFID":{ "$ref":"#/components/schemas/NfInstanceId" }, "announcementInformation":{ "$ref":"#/components/schemas/AnnouncementInformation" } }, "required":[ "ratingGroup" ] }, "RequestedUnit":{ "type":"object", "properties":{ "time":{ "$ref":"#/components/schemas/Uint32" }, "totalVolume":{ "$ref":"#/components/schemas/Uint64" }, "uplinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "downlinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "serviceSpecificUnits":{ "$ref":"#/components/schemas/Uint64" } } }, "GrantedUnit":{ "type":"object", "properties":{ "tariffTimeChange":{ "$ref":"#/components/schemas/DateTime" }, "time":{ "$ref":"#/components/schemas/Uint32" }, "totalVolume":{ "$ref":"#/components/schemas/Uint64" }, "uplinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "downlinkVolume":{ "$ref":"#/components/schemas/Uint64" }, "serviceSpecificUnits":{ "$ref":"#/components/schemas/Uint64" } } }, "FinalUnitIndication":{ "type":"object", "properties":{ "finalUnitAction":{ "$ref":"#/components/schemas/FinalUnitAction" }, "restrictionFilterRule":{ "$ref":"#/components/schemas/IPFilterRule" }, "restrictionFilterRuleList":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPFilterRule" }, "minItems":1 }, "filterId":{ "type":"string" }, "filterIdList":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "redirectServer":{ "$ref":"#/components/schemas/RedirectServer" } }, "required":[ "finalUnitAction" ] }, "RedirectServer":{ "type":"object", "properties":{ "redirectAddressType":{ "$ref":"#/components/schemas/RedirectAddressType" }, "redirectServerAddress":{ "type":"string" } }, "required":[ "redirectAddressType", "redirectServerAddress" ] }, "ReauthorizationDetails":{ "description":"Reauthorization data that specifies the quota or usage reporting to update.", "type":"object", "properties":{ "serviceId":{ "$ref":"#/components/schemas/ServiceId" }, "ratingGroup":{ "$ref":"#/components/schemas/RatingGroup" }, "quotaManagementIndicator":{ "$ref":"#/components/schemas/QuotaManagementIndicator" } } }, "NSPAContainerInformation":{ "type":"object", "properties":{ "latency":{ "type":"integer" }, "uplinkLatency":{ "type":"integer" }, "downlinkLatency":{ "type":"integer" }, "throughput":{ "$ref":"#/components/schemas/Throughput" }, "uplinkThroughput":{ "$ref":"#/components/schemas/Throughput" }, "downlinkThroughput":{ "$ref":"#/components/schemas/Throughput" }, "maximumPacketLossRate":{ "type":"string" }, "maximumPacketLossRateUL":{ "type":"integer" }, "maximumPacketLossRateDL":{ "type":"integer" }, "serviceExperienceStatisticsData":{ "$ref":"#/components/schemas/ServiceExperienceInfo" }, "theNumberOfPDUSessions":{ "type":"integer" }, "theNumberOfRegisteredSubscribers":{ "type":"integer" }, "loadLevel":{ "$ref":"#/components/schemas/NsiLoadLevelInfo" } } }, "NSPAChargingInformation":{ "type":"object", "description":"The network slice information, which is reported to the CHF.", "properties":{ "singleNSSAI":{ "$ref":"#/components/schemas/Snssai" } }, "required":[ "singleNSSAI" ] }, "SMSChargingInformation":{ "type":"object", "description":"SMS-specific information.", "properties":{ "originatorInfo":{ "$ref":"#/components/schemas/OriginatorInfo" }, "recipientInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/RecipientInfo" }, "minItems":0 }, "userEquipmentInfo":{ "$ref":"#/components/schemas/Pei" }, "roamerInOut":{ "$ref":"#/components/schemas/RoamerInOut" }, "userLocationinfo":{ "$ref":"#/components/schemas/UserLocation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "rATType":{ "$ref":"#/components/schemas/RatType" }, "sMSCAddress":{ "type":"string" }, "sMDataCodingScheme":{ "type":"integer" }, "sMMessageType":{ "$ref":"#/components/schemas/SMMessageType" }, "sMReplyPathRequested":{ "$ref":"#/components/schemas/ReplyPathRequested" }, "sMUserDataHeader":{ "type":"string" }, "sMStatus":{ "type":"string", "pattern":"^[0-7]?[0-9a-fA-F]$" }, "sMDischargeTime":{ "$ref":"#/components/schemas/DateTime" }, "numberofMessagesSent":{ "$ref":"#/components/schemas/Uint32" }, "sMServiceType":{ "$ref":"#/components/schemas/SMServiceType" }, "sMSequenceNumber":{ "$ref":"#/components/schemas/Uint32" }, "sMSresult":{ "$ref":"#/components/schemas/Uint32" }, "submissionTime":{ "$ref":"#/components/schemas/DateTime" }, "sMPriority":{ "$ref":"#/components/schemas/SMPriority" }, "messageReference":{ "type":"string" }, "messageSize":{ "$ref":"#/components/schemas/Uint32" }, "messageClass":{ "$ref":"#/components/schemas/MessageClass" }, "deliveryReportRequested":{ "$ref":"#/components/schemas/DeliveryReportRequested" } } }, "OriginatorInfo":{ "type":"object", "properties":{ "originatorSUPI":{ "$ref":"#/components/schemas/Supi" }, "originatorGPSI":{ "$ref":"#/components/schemas/Gpsi" }, "originatorOtherAddress":{ "$ref":"#/components/schemas/SMAddressInfo" }, "originatorReceivedAddress":{ "$ref":"#/components/schemas/SMAddressInfo" }, "originatorSCCPAddress":{ "type":"string" }, "sMOriginatorInterface":{ "$ref":"#/components/schemas/SMInterface" }, "sMOriginatorProtocolId":{ "type":"string" } } }, "RecipientInfo":{ "type":"object", "properties":{ "recipientSUPI":{ "$ref":"#/components/schemas/Supi" }, "recipientGPSI":{ "$ref":"#/components/schemas/Gpsi" }, "recipientOtherAddress":{ "$ref":"#/components/schemas/SMAddressInfo" }, "recipientReceivedAddress":{ "$ref":"#/components/schemas/SMAddressInfo" }, "recipientSCCPAddress":{ "type":"string" }, "sMDestinationInterface":{ "$ref":"#/components/schemas/SMInterface" }, "sMrecipientProtocolId":{ "type":"string" } } }, "SMAddressInfo":{ "type":"object", "properties":{ "sMaddressType":{ "$ref":"#/components/schemas/SMAddressType" }, "sMaddressData":{ "type":"string" }, "sMaddressDomain":{ "$ref":"#/components/schemas/SMAddressDomain" } } }, "RecipientAddress":{ "type":"object", "properties":{ "recipientAddressInfo":{ "$ref":"#/components/schemas/SMAddressInfo" }, "sMaddresseeType":{ "$ref":"#/components/schemas/SMAddresseeType" } } }, "MessageClass":{ "type":"object", "properties":{ "classIdentifier":{ "$ref":"#/components/schemas/ClassIdentifier" }, "tokenText":{ "type":"string" } } }, "SMAddressDomain":{ "type":"object", "properties":{ "domainName":{ "type":"string" }, "3GPPIMSIMCCMNC":{ "type":"string" } } }, "SMInterface":{ "type":"object", "properties":{ "interfaceId":{ "type":"string" }, "interfaceText":{ "type":"string" }, "interfacePort":{ "type":"string" }, "interfaceType":{ "$ref":"#/components/schemas/InterfaceType" } } }, "5GLANTypeService":{ "type":"object", "properties":{ "internalGroupIdentifier":{ "$ref":"#/components/schemas/GroupId" } } }, "NEFChargingInformation":{ "type":"object", "description":"Exposure Function Northbound API-specific information.", "properties":{ "externalIndividualIdentifier":{ "$ref":"#/components/schemas/Gpsi" }, "externalIndividualIdList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Gpsi" }, "minItems":1 }, "externalGroupIdentifier":{ "$ref":"#/components/schemas/ExternalGroupId" }, "groupIdentifier":{ "$ref":"#/components/schemas/GroupId" }, "aPIDirection":{ "$ref":"#/components/schemas/APIDirection" }, "aPITargetNetworkFunction":{ "$ref":"#/components/schemas/NFIdentification" }, "aPIResultCode":{ "$ref":"#/components/schemas/Uint32" }, "aPIName":{ "type":"string" }, "aPIReference":{ "$ref":"#/components/schemas/Uri" }, "aPIContent":{ "type":"string" } }, "required":[ "aPIName" ] }, "RegistrationChargingInformation":{ "type":"object", "description":"The 5G registration-specific information.", "properties":{ "registrationMessagetype":{ "$ref":"#/components/schemas/RegistrationMessageType" }, "userInformation":{ "$ref":"#/components/schemas/UserInformation" }, "userLocationinfo":{ "$ref":"#/components/schemas/UserLocation" }, "pSCellInformation":{ "$ref":"#/components/schemas/PSCellInformation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "rATType":{ "$ref":"#/components/schemas/RatType" }, "5GMMCapability":{ "$ref":"#/components/schemas/Bytes" }, "mICOModeIndication":{ "$ref":"#/components/schemas/MICOModeIndication" }, "smsIndication":{ "$ref":"#/components/schemas/SmsIndication" }, "taiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tai" }, "minItems":0 }, "serviceAreaRestriction":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceAreaRestriction" }, "minItems":0 }, "requestedNSSAI":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":0 }, "allowedNSSAI":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":0 }, "rejectedNSSAI":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":0 }, "nSSAIMapList":{ "type":"array", "items":{ "$ref":"#/components/schemas/NSSAIMap" }, "minItems":0 }, "amfUeNgapId":{ "type":"integer" }, "ranUeNgapId":{ "type":"integer" }, "ranNodeId":{ "$ref":"#/components/schemas/GlobalRanNodeId" } }, "required":[ "registrationMessagetype" ] }, "PSCellInformation":{ "type":"object", "properties":{ "nrcgi":{ "$ref":"#/components/schemas/Ncgi" }, "ecgi":{ "$ref":"#/components/schemas/Ecgi" } } }, "NSSAIMap":{ "type":"object", "properties":{ "servingSnssai":{ "$ref":"#/components/schemas/Snssai" }, "homeSnssai":{ "$ref":"#/components/schemas/Snssai" } }, "required":[ "servingSnssai", "homeSnssai" ] }, "N2ConnectionChargingInformation":{ "description":"Information about a 5G N2 charging connection.", "type":"object", "properties":{ "n2ConnectionMessageType":{ "$ref":"#/components/schemas/N2ConnectionMessageType" }, "userInformation":{ "$ref":"#/components/schemas/UserInformation" }, "userLocationinfo":{ "$ref":"#/components/schemas/UserLocation" }, "pSCellInformation":{ "$ref":"#/components/schemas/PSCellInformation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "rATType":{ "$ref":"#/components/schemas/RatType" }, "amfUeNgapId":{ "description":"The UE association over the N2 interface within the AMF.", "type":"integer" }, "ranUeNgapId":{ "description":"The RAN UE NGAP ID over the N2 interface.", "type":"integer" }, "ranNodeId":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "restrictedRatList":{ "type":"array", "items":{ "$ref":"#/components/schemas/RatType" }, "minItems":0 }, "forbiddenAreaList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Area" }, "minItems":0 }, "serviceAreaRestriction":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceAreaRestriction" }, "minItems":0 }, "restrictedCnList":{ "type":"array", "items":{ "$ref":"#/components/schemas/CoreNetworkType" }, "minItems":0 }, "allowedNSSAI":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":0 }, "rrcEstCause":{ "type":"string", "pattern":"^[0-9a-fA-F]+$" } }, "required":[ "n2ConnectionMessageType" ] }, "LocationReportingChargingInformation":{ "type":"object", "description":"The 5G N2 connection-specific information.", "properties":{ "locationReportingMessageType":{ "$ref":"#/components/schemas/LocationReportingMessageType" }, "userInformation":{ "$ref":"#/components/schemas/UserInformation" }, "userLocationinfo":{ "$ref":"#/components/schemas/UserLocation" }, "pSCellInformation":{ "$ref":"#/components/schemas/PSCellInformation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "rATType":{ "$ref":"#/components/schemas/RatType" }, "presenceReportingAreaInformation":{ "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/PresenceInfo" }, "minProperties":0 } }, "required":[ "locationReportingMessageType" ] }, "N2ConnectionMessageType":{ "type":"integer" }, "LocationReportingMessageType":{ "type":"integer" }, "NSMChargingInformation":{ "type":"object", "description":"The Network Slice Management (NSM)-specific information.", "properties":{ "managementOperation":{ "$ref":"#/components/schemas/ManagementOperation" }, "idNetworkSliceInstance":{ "type":"string" }, "listOfserviceProfileChargingInformation":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceProfileChargingInformation" }, "minItems":0 }, "managementOperationStatus":{ "$ref":"#/components/schemas/ManagementOperationStatus" }, "managementOperationalState":{ "$ref":"#/components/schemas/OperationalState" }, "managementAdministrativeState":{ "$ref":"#/components/schemas/AdministrativeState" } }, "required":[ "managementOperation" ] }, "AdministrativeState":{ "type":"string", "enum":[ "LOCKED", "UNLOCKED" ] }, "OperationalState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "Sst":{ "type":"integer", "minimum":0, "maximum":255 }, "SharingLevel":{ "type":"string", "enum":[ "SHARED", "NON_SHARED" ] }, "ServiceProfileChargingInformation":{ "type":"object", "properties":{ "serviceProfileIdentifier":{ "type":"string" }, "sNSSAIList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Snssai" }, "minItems":0 }, "sST":{ "$ref":"#/components/schemas/Sst" }, "latency":{ "type":"integer" }, "availability":{ "type":"number" }, "resourceSharingLevel":{ "$ref":"#/components/schemas/SharingLevel" }, "jitter":{ "type":"integer" }, "reliability":{ "type":"string" }, "maxNumberofUEs":{ "type":"integer" }, "coverageArea":{ "type":"string" }, "dLThptPerSlice":{ "$ref":"#/components/schemas/Throughput" }, "dLThptPerUE":{ "$ref":"#/components/schemas/Throughput" }, "uLThptPerSlice":{ "$ref":"#/components/schemas/Throughput" }, "uLThptPerUE":{ "$ref":"#/components/schemas/Throughput" }, "maxNumberofPDUsessions":{ "type":"integer" }, "kPIMonitoringList":{ "type":"string" }, "supportedAccessTechnology":{ "type":"integer" }, "addServiceProfileInfo":{ "type":"string" } } }, "Throughput":{ "type":"object", "properties":{ "guaranteedThpt":{ "$ref":"#/components/schemas/Float" }, "maximumThpt":{ "$ref":"#/components/schemas/Float" } } }, "AnnouncementInformation":{ "type":"object", "properties":{ "announcementIdentifier":{ "$ref":"#/components/schemas/Uint32" }, "announcementReference":{ "$ref":"#/components/schemas/Uri" }, "variableParts":{ "type":"array", "items":{ "$ref":"#/components/schemas/VariablePart" }, "minItems":0 }, "timeToPlay":{ "$ref":"#/components/schemas/DurationSec" }, "quotaConsumptionIndicator":{ "$ref":"#/components/schemas/QuotaConsumptionIndicator" }, "announcementPriority":{ "$ref":"#/components/schemas/Uint32" }, "playToParty":{ "$ref":"#/components/schemas/PlayToParty" }, "announcementPrivacyIndicator":{ "$ref":"#/components/schemas/AnnouncementPrivacyIndicator" }, "Language":{ "$ref":"#/components/schemas/Language" } } }, "VariablePart":{ "type":"object", "properties":{ "variablePartType":{ "$ref":"#/components/schemas/VariablePartType" }, "variablePartValue":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "variablePartOrder":{ "$ref":"#/components/schemas/Uint32" } }, "required":[ "variablePartType", "variablePartValue" ] }, "Language":{ "type":"string" }, "MMTelChargingInformation":{ "type":"object", "properties":{ "supplementaryServices":{ "type":"array", "items":{ "$ref":"#/components/schemas/SupplementaryService" }, "minItems":1 } } }, "SupplementaryService":{ "type":"object", "properties":{ "supplementaryServiceType":{ "$ref":"#/components/schemas/SupplementaryServiceType" }, "supplementaryServiceMode":{ "$ref":"#/components/schemas/SupplementaryServiceMode" }, "numberOfDiversions":{ "$ref":"#/components/schemas/Uint32" }, "associatedPartyAddress":{ "type":"string" }, "conferenceId":{ "type":"string" }, "participantActionType":{ "$ref":"#/components/schemas/ParticipantActionType" }, "changeTime":{ "$ref":"#/components/schemas/DateTime" }, "numberOfParticipants":{ "$ref":"#/components/schemas/Uint32" }, "cUGInformation":{ "$ref":"#/components/schemas/OctetString" } } }, "IMSChargingInformation":{ "type":"object", "properties":{ "eventType":{ "$ref":"#/components/schemas/SIPEventType" }, "iMSNodeFunctionality":{ "$ref":"#/components/schemas/IMSNodeFunctionality" }, "roleOfNode":{ "$ref":"#/components/schemas/RoleOfIMSNode" }, "userInformation":{ "$ref":"#/components/schemas/UserInformation" }, "userLocationInfo":{ "$ref":"#/components/schemas/UserLocation" }, "ueTimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "3gppPSDataOffStatus":{ "$ref":"#/components/schemas/3GPPPSDataOffStatus" }, "isupCause":{ "$ref":"#/components/schemas/ISUPCause" }, "controlPlaneAddress":{ "$ref":"#/components/schemas/IMSAddress" }, "vlrNumber":{ "$ref":"#/components/schemas/E164" }, "mscAddress":{ "$ref":"#/components/schemas/E164" }, "userSessionID":{ "type":"string" }, "outgoingSessionID":{ "type":"string" }, "sessionPriority":{ "$ref":"#/components/schemas/IMSSessionPriority" }, "callingPartyAddresses":{ "type":"array", "items":{ "$ref":"#/components/schemas/Uri" }, "minItems":1 }, "calledPartyAddress":{ "type":"string" }, "numberPortabilityRoutinginformation":{ "type":"string" }, "carrierSelectRoutingInformation":{ "type":"string" }, "alternateChargedPartyAddress":{ "type":"string" }, "requestedPartyAddress":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "calledAssertedIdentities":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "calledIdentityChanges":{ "type":"array", "items":{ "$ref":"#/components/schemas/CalledIdentityChange" }, "minItems":1 }, "associatedURI":{ "type":"array", "items":{ "$ref":"#/components/schemas/Uri" }, "minItems":1 }, "timeStamps":{ "$ref":"#/components/schemas/DateTime" }, "applicationServerInformation":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "interOperatorIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/InterOperatorIdentifier" }, "minItems":1 }, "imsChargingIdentifier":{ "type":"string" }, "relatedICID":{ "type":"string" }, "relatedICIDGenerationNode":{ "type":"string" }, "transitIOIList":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "earlyMediaDescription":{ "type":"array", "items":{ "$ref":"#/components/schemas/EarlyMediaDescription" }, "minItems":1 }, "sdpSessionDescription":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "sdpMediaComponent":{ "type":"array", "items":{ "$ref":"#/components/schemas/SDPMediaComponent" }, "minItems":1 }, "servedPartyIPAddress":{ "$ref":"#/components/schemas/IMSAddress" }, "serverCapabilities":{ "$ref":"#/components/schemas/ServerCapabilities" }, "trunkGroupID":{ "$ref":"#/components/schemas/TrunkGroupID" }, "bearerService":{ "type":"string" }, "imsServiceId":{ "type":"string" }, "messageBodies":{ "type":"array", "items":{ "$ref":"#/components/schemas/MessageBody" }, "minItems":1 }, "accessNetworkInformation":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "additionalAccessNetworkInformation":{ "type":"string" }, "cellularNetworkInformation":{ "type":"string" }, "accessTransferInformation":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccessTransferInformation" }, "minItems":1 }, "accessNetworkInfoChange":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccessNetworkInfoChange" }, "minItems":1 }, "imsCommunicationServiceID":{ "type":"string" }, "imsApplicationReferenceID":{ "type":"string" }, "causeCode":{ "$ref":"#/components/schemas/Uint32" }, "reasonHeader":{ "type":"array", "items":{ "type":"string" }, "minItems":1 }, "initialIMSChargingIdentifier":{ "type":"string" }, "nniInformation":{ "type":"array", "items":{ "$ref":"#/components/schemas/NNIInformation" }, "minItems":1 }, "fromAddress":{ "type":"string" }, "imsEmergencyIndication":{ "type":"boolean" }, "imsVisitedNetworkIdentifier":{ "type":"string" }, "sipRouteHeaderReceived":{ "type":"string" }, "sipRouteHeaderTransmitted":{ "type":"string" }, "tadIdentifier":{ "$ref":"#/components/schemas/TADIdentifier" }, "feIdentifierList":{ "type":"string" } } }, "EdgeInfrastructureUsageChargingInformation":{ "type":"object", "properties":{ "meanVirtualCPUUsage":{ "$ref":"#/components/schemas/Float" }, "meanVirtualMemoryUsage":{ "$ref":"#/components/schemas/Float" }, "meanVirtualDiskUsage":{ "$ref":"#/components/schemas/Float" }, "measuredInBytes":{ "$ref":"#/components/schemas/Uint64" }, "measuredOutBytes":{ "$ref":"#/components/schemas/Uint64" }, "durationStartTime":{ "$ref":"#/components/schemas/DateTime" }, "durationEndTime":{ "$ref":"#/components/schemas/DateTime" } } }, "EASDeploymentChargingInformation":{ "type":"object", "properties":{ "eEASDeploymentRequirements":{ "$ref":"#/components/schemas/EASRequirements" }, "lCMEventType":{ "$ref":"#/components/schemas/ManagementOperation" }, "lCMStartTime":{ "$ref":"#/components/schemas/DateTime" }, "lCMEndTime":{ "$ref":"#/components/schemas/DateTime" } } }, "PC5ContainerInformation":{ "type":"object", "properties":{ "coverageInfoList":{ "type":"array", "items":{ "$ref":"#/components/schemas/CoverageInfo" } }, "radioParameterSetInfoList":{ "type":"array", "items":{ "$ref":"#/components/schemas/RadioParameterSetInfo" } }, "transmitterInfoList":{ "type":"array", "items":{ "$ref":"#/components/schemas/TransmitterInfo" }, "minItems":0 }, "timeOfFirstTransmission":{ "$ref":"#/components/schemas/DateTime" }, "timeOfFirstReception":{ "$ref":"#/components/schemas/DateTime" } } }, "CoverageInfo":{ "type":"object", "properties":{ "coverageStatus":{ "type":"boolean" }, "changeTime":{ "$ref":"#/components/schemas/DateTime" }, "locationInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserLocation" }, "minItems":0 } } }, "RadioParameterSetInfo":{ "type":"object", "properties":{ "radioParameterSetValues":{ "type":"array", "items":{ "$ref":"#/components/schemas/OctetString" }, "minItems":0 }, "changeTimestamp":{ "$ref":"#/components/schemas/DateTime" } } }, "TransmitterInfo":{ "type":"object", "properties":{ "proseSourceIPAddress":{ "$ref":"#/components/schemas/IpAddr" }, "proseSourceL2Id":{ "type":"string" } } }, "ProseChargingInformation":{ "type":"object", "properties":{ "announcingPlmnID":{ "$ref":"#/components/schemas/PlmnId" }, "announcingUeHplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "announcingUeVplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "monitoringUeHplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "monitoringUeVplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "discovererUeHplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "discovererUeVplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "discovereeUeHplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "discovereeUeVplmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "monitoredPlmnIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "proseApplicationID":{ "type":"string" }, "ApplicationId":{ "type":"string" }, "applicationSpecificDataList":{ "type":"array", "items":{ "type":"string" }, "minItems":0 }, "proseFunctionality":{ "$ref":"#/components/schemas/ProseFunctionality" }, "proseEventType":{ "$ref":"#/components/schemas/ProseEventType" }, "directDiscoveryModel":{ "$ref":"#/components/schemas/DirectDiscoveryModel" }, "validityPeriod":{ "type":"integer" }, "roleOfUE":{ "$ref":"#/components/schemas/RoleOfUE" }, "proseRequestTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "pC3ProtocolCause":{ "type":"integer" }, "monitoringUEIdentifier":{ "$ref":"#/components/schemas/Supi" }, "requestedPLMNIdentifier":{ "$ref":"#/components/schemas/PlmnId" }, "timeWindow":{ "type":"integer" }, "rangeClass":{ "$ref":"#/components/schemas/RangeClass" }, "proximityAlertIndication":{ "type":"boolean" }, "proximityAlertTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "proximityCancellationTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "relayIPAddress":{ "$ref":"#/components/schemas/IpAddr" }, "proseUEToNetworkRelayUEID":{ "type":"string" }, "proseDestinationLayer2ID":{ "type":"string" }, "pFIContainerInformation":{ "type":"array", "items":{ "$ref":"#/components/schemas/PFIContainerInformation" }, "minItems":0 }, "transmissionDataContainer":{ "type":"array", "items":{ "$ref":"#/components/schemas/PC5DataContainer" }, "minItems":0 }, "receptionDataContainer":{ "type":"array", "items":{ "$ref":"#/components/schemas/PC5DataContainer" }, "minItems":0 } }, "required":[ "aPIName" ] }, "PFIContainerInformation":{ "type":"object", "properties":{ "pFI":{ "type":"string" }, "reportTime":{ "$ref":"#/components/schemas/DateTime" }, "timeofFirstUsage":{ "$ref":"#/components/schemas/DateTime" }, "timeofLastUsage":{ "$ref":"#/components/schemas/DateTime" }, "qoSInformation":{ "$ref":"#/components/schemas/QosData" }, "qoSCharacteristics":{ "$ref":"#/components/schemas/QosCharacteristics" }, "userLocationInformation":{ "$ref":"#/components/schemas/UserLocation" }, "uetimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "presenceReportingAreaInformation":{ "type":"object", "additionalProperties":{ "$ref":"#/components/schemas/PresenceInfo" }, "minProperties":0 } } }, "PC5DataContainer":{ "type":"object", "properties":{ "localSequenceNumber":{ "type":"string" }, "changeTime":{ "$ref":"#/components/schemas/DateTime" }, "coverageStatus":{ "type":"boolean" }, "userLocationInformation":{ "$ref":"#/components/schemas/UserLocation" }, "dataVolume":{ "$ref":"#/components/schemas/Uint64" }, "changeCondition":{ "type":"string" }, "radioResourcesId":{ "$ref":"#/components/schemas/RadioResourcesId" }, "radioFrequency":{ "type":"string" }, "pC5RadioTechnology":{ "type":"string" } } }, "OctetString":{ "type":"string", "pattern":"^[0-9a-fA-F]+$" }, "E164":{ "type":"string", "pattern":"^[0-9a-fA-F]+$" }, "IMSAddress":{ "type":"object", "properties":{ "ipv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" }, "e164":{ "$ref":"#/components/schemas/E164" } }, "anyOf":[ { "required":[ "ipv4Addr" ] }, { "required":[ "ipv6Addr" ] }, { "required":[ "e164" ] } ] }, "ServingNodeAddress":{ "type":"object", "properties":{ "ipv4Addr":{ "$ref":"#/components/schemas/Ipv4Addr" }, "ipv6Addr":{ "$ref":"#/components/schemas/Ipv6Addr" } }, "anyOf":[ { "required":[ "ipv4Addr" ] }, { "required":[ "ipv6Addr" ] } ] }, "SIPEventType":{ "type":"object", "properties":{ "sIPMethod":{ "type":"string" }, "eventHeader":{ "type":"string" }, "expiresHeader":{ "$ref":"#/components/schemas/Uint32" } } }, "ISUPCause":{ "type":"object", "properties":{ "iSUPCauseLocation":{ "$ref":"#/components/schemas/Uint32" }, "iSUPCauseValue":{ "$ref":"#/components/schemas/Uint32" }, "iSUPCauseDiagnostics":{ "$ref":"#/components/schemas/OctetString" } } }, "CalledIdentityChange":{ "type":"object", "properties":{ "calledIdentity":{ "type":"string" }, "changeTime":{ "$ref":"#/components/schemas/DateTime" } } }, "InterOperatorIdentifier":{ "type":"object", "properties":{ "originatingIOI":{ "type":"string" }, "terminatingIOI":{ "type":"string" } } }, "EarlyMediaDescription":{ "type":"object", "properties":{ "sDPTimeStamps":{ "$ref":"#/components/schemas/SDPTimeStamps" }, "sDPMediaComponent":{ "type":"array", "items":{ "$ref":"#/components/schemas/SDPMediaComponent" }, "minItems":0 }, "sDPSessionDescription":{ "type":"array", "items":{ "type":"string" }, "minItems":0 } } }, "SDPTimeStamps":{ "type":"object", "properties":{ "sDPOfferTimestamp":{ "$ref":"#/components/schemas/DateTime" }, "sDPAnswerTimestamp":{ "$ref":"#/components/schemas/DateTime" } } }, "SDPMediaComponent":{ "type":"object", "properties":{ "sDPMediaName":{ "type":"string" }, "SDPMediaDescription":{ "type":"array", "items":{ "type":"string" }, "minItems":0 }, "localGWInsertedIndication":{ "type":"boolean" }, "ipRealmDefaultIndication":{ "type":"boolean" }, "transcoderInsertedIndication":{ "type":"boolean" }, "mediaInitiatorFlag":{ "$ref":"#/components/schemas/MediaInitiatorFlag" }, "mediaInitiatorParty":{ "type":"string" }, "threeGPPChargingId":{ "$ref":"#/components/schemas/OctetString" }, "accessNetworkChargingIdentifierValue":{ "$ref":"#/components/schemas/OctetString" }, "sDPType":{ "$ref":"#/components/schemas/SDPType" } } }, "ServerCapabilities":{ "type":"object", "properties":{ "mandatoryCapability":{ "type":"array", "items":{ "$ref":"#/components/schemas/Uint32" }, "minItems":0 }, "optionalCapability":{ "type":"array", "items":{ "$ref":"#/components/schemas/Uint32" }, "minItems":0 }, "serverName":{ "type":"array", "items":{ "type":"string" }, "minItems":0 } } }, "TrunkGroupID":{ "type":"object", "properties":{ "incomingTrunkGroupID":{ "type":"string" }, "outgoingTrunkGroupID":{ "type":"string" } } }, "MessageBody":{ "type":"object", "properties":{ "contentType":{ "type":"string" }, "contentLength":{ "$ref":"#/components/schemas/Uint32" }, "contentDisposition":{ "type":"string" }, "originator":{ "$ref":"#/components/schemas/OriginatorPartyType" } }, "required":[ "contentType", "contentLength" ] }, "AccessTransferInformation":{ "type":"object", "properties":{ "accessTransferType":{ "$ref":"#/components/schemas/AccessTransferType" }, "accessNetworkInformation":{ "type":"array", "items":{ "$ref":"#/components/schemas/OctetString" }, "minItems":0 }, "cellularNetworkInformation":{ "$ref":"#/components/schemas/OctetString" }, "interUETransfer":{ "$ref":"#/components/schemas/UETransferType" }, "userEquipmentInfo":{ "$ref":"#/components/schemas/Pei" }, "instanceId":{ "type":"string" }, "relatedIMSChargingIdentifier":{ "type":"string" }, "relatedIMSChargingIdentifierNode":{ "$ref":"#/components/schemas/IMSAddress" }, "changeTime":{ "$ref":"#/components/schemas/DateTime" } } }, "AccessNetworkInfoChange":{ "type":"object", "properties":{ "accessNetworkInformation":{ "type":"array", "items":{ "$ref":"#/components/schemas/OctetString" }, "minItems":0 }, "cellularNetworkInformation":{ "$ref":"#/components/schemas/OctetString" }, "changeTime":{ "$ref":"#/components/schemas/DateTime" } } }, "NNIInformation":{ "type":"object", "properties":{ "sessionDirection":{ "$ref":"#/components/schemas/NNISessionDirection" }, "nNIType":{ "$ref":"#/components/schemas/NNIType" }, "relationshipMode":{ "$ref":"#/components/schemas/NNIRelationshipMode" }, "neighbourNodeAddress":{ "$ref":"#/components/schemas/IMSAddress" } } }, "EASRequirements":{ "type":"object", "properties":{ "requiredEASservingLocation":{ "$ref":"#/components/schemas/ServingLocation" }, "softwareImageInfo":{ "$ref":"#/components/schemas/SoftwareImageInfo" }, "affinityAntiAffinity":{ "$ref":"#/components/schemas/AffinityAntiAffinity" }, "serviceContinuity":{ "type":"boolean" }, "virtualResource":{ "$ref":"#/components/schemas/VirtualResource" } } }, "NotificationType":{ "description":"The reason for the notification:
  • REAUTHORIZATION: Reauthorization is required
  • ABORT_CHARGING: Ending authorization is required
", "type":"string", "enum":[ "REAUTHORIZATION", "ABORT_CHARGING" ] }, "FinalUnitAction":{ "type":"string", "enum":[ "TERMINATE", "REDIRECT", "RESTRICT_ACCESS" ] }, "QuotaManagementIndicator":{ "type":"string", "description":"Indicates the charging type for the usage request: (ONLINE_CHARGING) for online charging, (OFFLINE_CHARGING) for offline-only charging, or (QUOTA_MANAGEMENT_SUSPENDED) for suspended charging.", "enum":[ "ONLINE_CHARGING", "OFFLINE_CHARGING", "QUOTA_MANAGEMENT_SUSPENDED" ] }, "SMMessageType":{ "type":"string", "enum":[ "SUBMISSION", "DELIVERY_REPORT", "SM_SERVICE_REQUEST", "DELIVERY" ] }, "SMPriority":{ "type":"string", "enum":[ "LOW", "NORMAL", "HIGH" ] }, "DeliveryReportRequested":{ "type":"string", "enum":[ "YES", "NO" ] }, "InterfaceType":{ "type":"string", "enum":[ "UNKNOWN", "MOBILE_ORIGINATING", "MOBILE_TERMINATING", "APPLICATION_ORIGINATING", "APPLICATION_TERMINATING" ] }, "ClassIdentifier":{ "type":"string", "enum":[ "PERSONAL", "ADVERTISEMENT", "INFORMATIONAL", "AUTO" ] }, "SMAddressType":{ "type":"string", "enum":[ "EMAIL_ADDRESS", "MSISDN", "IPV4_ADDRESS", "IPV6_ADDRESS", "NUMERIC_SHORTCODE", "ALPHANUMERIC_SHORTCODE", "OTHER", "IMSI" ] }, "SMAddresseeType":{ "type":"string", "enum":[ "TO", "CC", "BCC" ] }, "SMServiceType":{ "type":"string", "enum":[ "VAS4SMS_SHORT_MESSAGE_CONTENT_PROCESSING", "VAS4SMS_SHORT_MESSAGE_FORWARDING", "VAS4SMS_SHORT_MESSAGE_FORWARDING_MULTIPLE_SUBSCRIPTIONS", "VAS4SMS_SHORT_MESSAGE_FILTERING", "VAS4SMS_SHORT_MESSAGE_RECEIPT", "VAS4SMS_SHORT_MESSAGE_NETWORK_STORAGE", "VAS4SMS_SHORT_MESSAGE_TO_MULTIPLE_DESTINATIONS", "VAS4SMS_SHORT_MESSAGE_VIRTUAL_PRIVATE_NETWORK(VPN)", "VAS4SMS_SHORT_MESSAGE_AUTO_REPLY", "VAS4SMS_SHORT_MESSAGE_PERSONAL_SIGNATURE", "VAS4SMS_SHORT_MESSAGE_DEFERRED_DELIVERY" ] }, "ReplyPathRequested":{ "type":"string", "enum":[ "NO_REPLY_PATH_SET", "REPLY_PATH_SET" ] }, "oneTimeEventType":{ "type":"string", "enum":[ "IEC", "PEC" ] }, "dnnSelectionMode":{ "type":"string", "enum":[ "VERIFIED", "UE_DNN_NOT_VERIFIED", "NW_DNN_NOT_VERIFIED" ] }, "APIDirection":{ "type":"string", "enum":[ "INVOCATION", "NOTIFICATION" ] }, "RegistrationMessageType":{ "type":"string", "enum":[ "INITIAL", "MOBILITY", "PERIODIC", "EMERGENCY", "DEREGISTRATION" ] }, "MICOModeIndication":{ "type":"string", "enum":[ "MICO_MODE", "NO_MICO_MODE" ] }, "SmsIndication":{ "type":"string", "enum":[ "SMS_SUPPORTED", "SMS_NOT_SUPPORTED" ] }, "ManagementOperation":{ "type":"string", "enum":[ "CreateMOI", "ModifyMOIAttributes", "DeleteMOI", "CREATE_MOI", "MODIFY_MOI_ATTR", "DELETE_MOI", "NOTIFY_MOI_CREATION", "NOTIFY_MOI_ATTR_CHANGE", "NOTIFY_MOI_DELETION" ] }, "ManagementOperationStatus":{ "type":"string", "enum":[ "OPERATION_SUCCEEDED", "OPERATION_FAILED" ] }, "RedundantTransmissionType":{ "type":"string", "enum":[ "NON_TRANSMISSION", "END_TO_END_USER_PLANE_PATHS", "N3_N9", "TRANSPORT_LAYER" ] }, "VariablePartType":{ "type":"string", "enum":[ "INTEGER", "NUMBER", "TIME", "DATE", "CURRENCY" ] }, "QuotaConsumptionIndicator":{ "type":"string", "enum":[ "QUOTA_NOT_USED", "QUOTA_IS_USED" ] }, "PlayToParty":{ "type":"string", "enum":[ "SERVED", "REMOTE" ] }, "AnnouncementPrivacyIndicator":{ "type":"string", "enum":[ "NOT_PRIVATE", "PRIVATE" ] }, "SupplementaryServiceType":{ "type":"string", "enum":[ "OIP", "OIR", "TIP", "TIR", "HOLD", "CB", "CDIV", "CW", "MWI", "CONF", "FA", "CCBS", "CCNR", "MCID", "CAT", "CUG", "PNM", "CRS", "ECT" ] }, "SupplementaryServiceMode":{ "type":"string", "enum":[ "CFU", "CFB", "CFNR", "CFNL", "CD", "CFNRC", "ICB", "OCB", "ACR", "BLIND_TRANFER", "CONSULTATIVE_TRANFER" ] }, "ParticipantActionType":{ "type":"string", "enum":[ "CREATE", "JOIN", "INVITE_INTO", "QUIT" ] }, "TrafficForwardingWay":{ "type":"string", "enum":[ "N6", "N19", "LOCAL_SWITCH" ] }, "IMSNodeFunctionality":{ "type":"string", "enum":[ "S_CSCF", "P_CSCF", "I_CSCF", "MRFC", "MGCF", "BGCF", "AS", "IBCF", "S-GW", "P-GW", "HSGW", "E-CSCF", "MME", "TRF", "TF", "ATCF", "PROXY", "EPDG", "TDF", "TWAG", "SCEF", "IWK_SCEF", "IMS_GWF" ] }, "RoleOfIMSNode":{ "type":"string", "enum":[ "ORIGINATING", "TERMINATING", "FORWARDING" ] }, "IMSSessionPriority":{ "type":"string", "enum":[ "PRIORITY_0", "PRIORITY_1", "PRIORITY_2", "PRIORITY_3", "PRIORITY_4" ] }, "MediaInitiatorFlag":{ "type":"string", "enum":[ "CALLED_PARTY", "CALLING_PARTY", "UNKNOWN" ] }, "SDPType":{ "type":"string", "enum":[ "OFFER", "ANSWER" ] }, "OriginatorPartyType":{ "type":"string", "enum":[ "CALLING", "CALLED" ] }, "AccessTransferType":{ "type":"string", "enum":[ "PS_TO_CS", "CS_TO_PS", "PS_TO_PS", "CS_TO_CS" ] }, "UETransferType":{ "type":"string", "enum":[ "INTRA_UE", "INTER_UE" ] }, "NNISessionDirection":{ "type":"string", "enum":[ "INBOUND", "OUTBOUND" ] }, "NNIType":{ "type":"string", "enum":[ "NON_ROAMING", "ROAMING_NO_LOOPBACK", "ROAMING_LOOPBACK" ] }, "NNIRelationshipMode":{ "type":"string", "enum":[ "TRUSTED", "NON_TRUSTED" ] }, "TADIdentifier":{ "type":"string", "enum":[ "CS", "PS" ] }, "ProseFunctionality":{ "type":"string", "enum":[ "DIRECT_DISCOVERY", "DIRECT_COMMUNICATION" ] }, "ProseEventType":{ "type":"string", "enum":[ "ANNOUNCING", "MONITORING", "MATCH_REPORT" ] }, "DirectDiscoveryModel":{ "type":"string", "enum":[ "MODEL_A", "MODEL_B" ] }, "RoleOfUE":{ "type":"string", "enum":[ "ANNOUNCING_UE", "MONITORING_UE", "REQUESTOR_UE", "REQUESTED_UE" ] }, "RangeClass":{ "type":"string", "enum":[ "RESERVED", "50_METER", "100_METER", "200_METER", "500_METER", "1000_METER", "UNUSED" ] }, "RadioResourcesId":{ "type":"string", "enum":[ "OPERATOR_PROVIDED", "CONFIGURED" ] }, "UsageMonitoringData":{ "description":"Contains usage monitoring related control information.", "type":"object", "properties":{ "umId":{ "type":"string", "description":"Uniquely identifies the usage monitoring policy data within a PDU session." }, "volumeThreshold":{ "$ref":"#/components/schemas/VolumeRm" }, "volumeThresholdUplink":{ "$ref":"#/components/schemas/VolumeRm" }, "volumeThresholdDownlink":{ "$ref":"#/components/schemas/VolumeRm" }, "timeThreshold":{ "$ref":"#/components/schemas/DurationSecRm" }, "monitoringTime":{ "$ref":"#/components/schemas/DateTimeRm" }, "nextVolThreshold":{ "$ref":"#/components/schemas/VolumeRm" }, "nextVolThresholdUplink":{ "$ref":"#/components/schemas/VolumeRm" }, "nextVolThresholdDownlink":{ "$ref":"#/components/schemas/VolumeRm" }, "nextTimeThreshold":{ "$ref":"#/components/schemas/DurationSecRm" }, "inactivityTime":{ "$ref":"#/components/schemas/DurationSecRm" }, "exUsagePccRuleIds":{ "type":"array", "items":{ "type":"string" }, "minItems":1, "description":"Contains the PCC rule identifier(s) which corresponding service data flow(s) shall be excluded from PDU Session usage monitoring. It is only included in the UsageMonitoringData instance for session level usage monitoring.\n", "nullable":true } }, "required":[ "umId" ], "nullable":true }, "SmPolicyDeleteData":{ "description":"Contains the parameters to be sent to the PCF when an individual SM policy is deleted.", "type":"object", "properties":{ "userLocationInfo":{ "$ref":"#/components/schemas/UserLocation" }, "ueTimeZone":{ "$ref":"#/components/schemas/TimeZone" }, "servingNetwork":{ "$ref":"#/components/schemas/PlmnIdNid" }, "userLocationInfoTime":{ "$ref":"#/components/schemas/DateTime" }, "ranNasRelCauses":{ "type":"array", "items":{ "$ref":"#/components/schemas/RanNasRelCause" }, "minItems":1, "description":"Contains the RAN and/or NAS release cause." }, "accuUsageReports":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccuUsageReport" }, "minItems":1, "description":"Contains the usage report." }, "pduSessRelCause":{ "$ref":"#/components/schemas/PduSessionRelCause" } } }, "AccuUsageReport":{ "description":"Contains the accumulated usage report information.", "type":"object", "properties":{ "refUmIds":{ "type":"string", "description":"An id referencing UsageMonitoringData objects associated with this usage report." }, "volUsage":{ "$ref":"#/components/schemas/Volume" }, "volUsageUplink":{ "$ref":"#/components/schemas/Volume" }, "volUsageDownlink":{ "$ref":"#/components/schemas/Volume" }, "timeUsage":{ "$ref":"#/components/schemas/DurationSec" }, "nextVolUsage":{ "$ref":"#/components/schemas/Volume" }, "nextVolUsageUplink":{ "$ref":"#/components/schemas/Volume" }, "nextVolUsageDownlink":{ "$ref":"#/components/schemas/Volume" }, "nextTimeUsage":{ "$ref":"#/components/schemas/DurationSec" } }, "required":[ "refUmIds" ] }, "SponsorInformation":{ "description":"Represents a sponsor information.", "type":"object", "properties":{ "sponsorId":{ "type":"string", "description":"Indicates Sponsor ID." }, "aspId":{ "type":"string", "description":"Indicates Application Service Provider ID." } }, "required":[ "sponsorId", "aspId" ] }, "UsageThreshold":{ "description":"Represents a usage threshold.", "type":"object", "properties":{ "duration":{ "$ref":"#/components/schemas/DurationSec" }, "totalVolume":{ "$ref":"#/components/schemas/Volume" }, "downlinkVolume":{ "$ref":"#/components/schemas/Volume" }, "uplinkVolume":{ "$ref":"#/components/schemas/Volume" } } }, "UsageThresholdRm":{ "description":"Represents the same as the UsageThreshold data type but with the nullable:true property.", "type":"object", "properties":{ "duration":{ "$ref":"#/components/schemas/DurationSecRm" }, "totalVolume":{ "$ref":"#/components/schemas/VolumeRm" }, "downlinkVolume":{ "$ref":"#/components/schemas/VolumeRm" }, "uplinkVolume":{ "$ref":"#/components/schemas/VolumeRm" } }, "nullable":true }, "TimeWindow":{ "description":"Represents a time window identified by a start time and a stop time.", "type":"object", "properties":{ "startTime":{ "$ref":"#/components/schemas/DateTime" }, "stopTime":{ "$ref":"#/components/schemas/DateTime" } }, "required":[ "startTime", "stopTime" ] }, "Acknowledgement":{ "description":"Represents a successful acknowledgement of a notification.", "type":"object", "properties":{ "details":{ "type":"string", "description":"A human-readable explanation specific to this successful acknowledgement" } }, "required":[ "details" ] }, "NotificationData":{ "description":"Represents the information to be conveyed in a bearer level event(s) notification.", "type":"object", "properties":{ "transaction":{ "$ref":"#/components/schemas/Link" }, "eventReports":{ "type":"array", "items":{ "$ref":"#/components/schemas/EventReport" }, "minItems":1, "description":"Contains the reported event and applicable information" } }, "required":[ "transaction", "eventReports" ] }, "EventReport":{ "description":"Represents an event report.", "type":"object", "properties":{ "event":{ "$ref":"#/components/schemas/Event" }, "accumulatedUsage":{ "$ref":"#/components/schemas/AccumulatedUsage" }, "flowIds":{ "type":"array", "items":{ "type":"integer" }, "minItems":1, "description":"Identifies the IP flows that were sent during event subscription" } }, "required":[ "event" ] }, "AccumulatedUsage":{ "description":"Represents an accumulated usage.", "type":"object", "properties":{ "duration":{ "$ref":"#/components/schemas/DurationSec" }, "totalVolume":{ "$ref":"#/components/schemas/Volume" }, "downlinkVolume":{ "$ref":"#/components/schemas/Volume" }, "uplinkVolume":{ "$ref":"#/components/schemas/Volume" } } }, "FlowInfo":{ "description":"Represents IP flow information.", "type":"object", "properties":{ "flowId":{ "type":"integer", "description":"Indicates the IP flow identifier." }, "flowDescriptions":{ "type":"array", "items":{ "type":"string" }, "description":"Indicates the packet filters of the IP flow. Refer to clause 5.3.8 of 3GPP TS 29.214 for encoding. It shall contain UL and/or DL IP flow description.\n", "minItems":1, "maxItems":2 } }, "required":[ "flowId" ] }, "TestNotification":{ "description":"Represents a notification that can be sent to test whether a chosen notification mechanism works.", "type":"object", "properties":{ "subscription":{ "$ref":"#/components/schemas/Link" } }, "required":[ "subscription" ] }, "WebsockNotifConfig":{ "description":"Represents the configuration information for the delivery of notifications over Websockets.", "type":"object", "properties":{ "websocketUri":{ "$ref":"#/components/schemas/Link" }, "requestWebsocketUri":{ "type":"boolean", "description":"Set by the SCS/AS to indicate that the Websocket delivery is requested." } } }, "ConfigResult":{ "description":"Represents one configuration processing result for a group's members.", "type":"object", "properties":{ "externalIds":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalId" }, "minItems":1, "description":"Each element indicates an external identifier of the UE." }, "msisdns":{ "type":"array", "items":{ "$ref":"#/components/schemas/Msisdn" }, "minItems":1, "description":"Each element identifies the MS internal PSTN/ISDN number allocated for the UE." }, "resultReason":{ "$ref":"#/components/schemas/ResultReason" } }, "required":[ "resultReason" ], "oneOf":[ { "required":[ "externalIds" ] }, { "required":[ "msisdns" ] } ] }, "Bandwidth":{ "type":"integer", "minimum":0, "description":"Indicating a bandwidth in bits per second." }, "BdtReferenceId":{ "type":"string", "description":"Defines an identifier for a BDT Reference ID as specified in clause 5.3.3 of 3GPP TS 29.154." }, "BdtReferenceIdRm":{ "type":"string", "description":"Defines this data type similar to the BdtReferenceId data type, but with the nullable property set to true.", "nullable":true }, "DateTimeRo":{ "format":"date-time", "type":"string", "description":"Defines a string with format \"date-time\" as defined in OpenAPI with \"readOnly=true\" property.", "readOnly":true }, "DurationSecRo":{ "type":"integer", "minimum":0, "description":"Defines an unsigned integer identifying a period of time in units of seconds with \"readOnly=true\" property.", "readOnly":true }, "DurationMin":{ "type":"integer", "format":"int32", "minimum":0, "description":"Defines an unsigned integer identifying a period of time in units of minutes." }, "ExternalId":{ "type":"string", "description":"Defines a string containing a local identifier followed by \"@\" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any \"@\" characters. See Clause 4.6.2 of 3GPP TS 23.682 for more information." }, "Ipv4AddrRo":{ "type":"string", "description":"Defines a string identifying a Ipv4 address formatted in the \"dotted decimal\" notation as defined in IETF RFC 1166, with \"readOnly=true\" property.", "readOnly":true }, "Ipv6AddrRo":{ "type":"string", "description":"Defines a string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952, with \"readOnly=true\" property. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used.", "readOnly":true }, "Msisdn":{ "type":"string", "description":"Defines a string formatted according to clause 3.3 of 3GPP TS 23.003 that describes an MSISDN." }, "Port":{ "type":"integer", "description":"Defines an unsigned integer with valid values between 0 and 65535.", "minimum":0, "maximum":65535 }, "PortRo":{ "type":"integer", "description":"Defines an unsigned integer with valid values between 0 and 65535, with \"readOnly=true\" property.", "minimum":0, "maximum":65535, "readOnly":true }, "ResourceId":{ "type":"string", "description":"Defines a string chosen by the SCEF to serve as identifier in a resource URI." }, "ScsAsId":{ "type":"string", "description":"Defines a string that identifies an SCS/AS." }, "Volume":{ "type":"integer", "format":"int64", "minimum":0, "description":"Defines an unsigned integer identifying a volume in units of bytes." }, "VolumeRm":{ "type":"integer", "format":"int64", "minimum":0, "description":"Defines a unsigned integer identifying a volume in units of bytes with \"nullable=true\" property.", "nullable":true }, "Event":{ "anyOf":[ { "type":"string", "enum":[ "SESSION_TERMINATION", "LOSS_OF_BEARER", "RECOVERY_OF_BEARER", "RELEASE_OF_BEARER", "USAGE_REPORT", "FAILED_RESOURCES_ALLOCATION", "SUCCESSFUL_RESOURCES_ALLOCATION" ] }, { "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.\n" } ], "description":"Possible values are - SESSION_TERMINATION: Indicates that Rx session is terminated. - LOSS_OF_BEARER : Indicates a loss of a bearer. - RECOVERY_OF_BEARER: Indicates a recovery of a bearer. - RELEASE_OF_BEARER: Indicates a release of a bearer. - USAGE_REPORT: Indicates the usage report event. - FAILED_RESOURCES_ALLOCATION: Indicates the resource allocation is failed. - SUCCESSFUL_RESOURCES_ALLOCATION: Indicates the resource allocation is successful.\n" }, "ResultReason":{ "anyOf":[ { "type":"string", "enum":[ "ROAMING_NOT_ALLOWED", "OTHER_REASON" ] }, { "type":"string", "description":"This string provides a failure reason.\n" } ], "description":"Possible values are - ROAMING_NOT_ALLOWED: Identifies the configuration parameters are not allowed by roaming agreement. - OTHER_REASON: Identifies the configuration parameters are not configured due to other reason.\n" }, "ServiceExperienceInfo":{ "description":"Represents service experience information.", "type":"object", "properties":{ "svcExprc":{ "$ref":"#/components/schemas/SvcExperience" }, "svcExprcVariance":{ "$ref":"#/components/schemas/Float" }, "supis":{ "type":"array", "items":{ "$ref":"#/components/schemas/Supi" }, "minItems":1 }, "snssai":{ "$ref":"#/components/schemas/Snssai" }, "appId":{ "$ref":"#/components/schemas/ApplicationId" }, "srvExpcType":{ "$ref":"#/components/schemas/ServiceExperienceType" }, "ueLocs":{ "type":"array", "items":{ "$ref":"#/components/schemas/LocationInfo" }, "minItems":1 }, "upfInfo":{ "$ref":"#/components/schemas/UpfInformation" }, "dnai":{ "$ref":"#/components/schemas/Dnai" }, "appServerInst":{ "$ref":"#/components/schemas/AddrFqdn" }, "confidence":{ "$ref":"#/components/schemas/Uinteger" }, "dnn":{ "$ref":"#/components/schemas/Dnn" }, "networkArea":{ "$ref":"#/components/schemas/NetworkAreaInfo" }, "nsiId":{ "$ref":"#/components/schemas/NsiId" }, "ratio":{ "$ref":"#/components/schemas/SamplingRatio" }, "ratFreq":{ "$ref":"#/components/schemas/RatFreqInformation" } }, "required":[ "svcExprc" ] }, "RatFreqInformation":{ "description":"Represents the RAT type and/or Frequency information.", "type":"object", "properties":{ "allFreq":{ "type":"boolean", "description":"Set to \"true\" to indicate to handle all the frequencies the NWDAF received, otherwise set to \"false\" or omit. The \"allFreq\" attribute and the \"freq\" attribute are mutually exclusive.\n" }, "allRat":{ "type":"boolean", "description":"Set to \"true\" to indicate to handle all the RAT Types the NWDAF received, otherwise set to \"false\" or omit. The \"allRat\" attribute and the \"ratType\" attribute are mutually exclusive.\n" }, "freq":{ "$ref":"#/components/schemas/ArfcnValueNR" }, "ratType":{ "$ref":"#/components/schemas/RatType" }, "svcExpThreshold":{ "$ref":"#/components/schemas/ThresholdLevel" }, "matchingDir":{ "$ref":"#/components/schemas/MatchingDirection" } } }, "MatchingDirection":{ "anyOf":[ { "type":"string", "enum":[ "ASCENDING", "DESCENDING", "CROSSED" ] }, { "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.\n" } ], "description":"Possible values are:\n- ASCENDING: Threshold is crossed in ascending direction.\n- DESCENDING: Threshold is crossed in descending direction.\n- CROSSED: Threshold is crossed either in ascending or descending direction.\n" }, "ThresholdLevel":{ "description":"Represents a threshold level.", "type":"object", "properties":{ "congLevel":{ "type":"integer" }, "nfLoadLevel":{ "type":"integer" }, "nfCpuUsage":{ "type":"integer" }, "nfMemoryUsage":{ "type":"integer" }, "nfStorageUsage":{ "type":"integer" }, "avgTrafficRate":{ "$ref":"#/components/schemas/BitRate" }, "maxTrafficRate":{ "$ref":"#/components/schemas/BitRate" }, "avgPacketDelay":{ "$ref":"#/components/schemas/PacketDelBudget" }, "maxPacketDelay":{ "$ref":"#/components/schemas/PacketDelBudget" }, "avgPacketLossRate":{ "$ref":"#/components/schemas/PacketLossRate" }, "svcExpLevel":{ "$ref":"#/components/schemas/Float" } } }, "LocationInfo":{ "description":"Represents UE location information.", "type":"object", "properties":{ "loc":{ "$ref":"#/components/schemas/UserLocation" }, "ratio":{ "$ref":"#/components/schemas/SamplingRatio" }, "confidence":{ "$ref":"#/components/schemas/Uinteger" } }, "required":[ "loc" ] }, "ServiceExperienceType":{ "anyOf":[ { "type":"string", "enum":[ "VOICE", "VIDEO", "OTHER" ] }, { "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.\n" } ], "description":"Possible values are:\n- VOICE: Indicates that the service experience analytics is for voice service.\n- VIDEO: Indicates that the service experience analytics is for video service.\n- OTHER: Indicates that the service experience analytics is for other service.\n" }, "NsiId":{ "description":"Contains the Identifier of the selected Network Slice instance", "type":"string" }, "NetworkAreaInfo":{ "description":"Describes a network area information in which the NF service consumer requests the number of UEs.\n", "type":"object", "properties":{ "ecgis":{ "description":"Contains a list of E-UTRA cell identities.", "type":"array", "items":{ "$ref":"#/components/schemas/Ecgi" }, "minItems":1 }, "ncgis":{ "description":"Contains a list of NR cell identities.", "type":"array", "items":{ "$ref":"#/components/schemas/Ncgi" }, "minItems":1 }, "gRanNodeIds":{ "description":"Contains a list of NG RAN nodes.", "type":"array", "items":{ "$ref":"#/components/schemas/GlobalRanNodeId" }, "minItems":1 }, "tais":{ "description":"Contains a list of tracking area identities.", "type":"array", "items":{ "$ref":"#/components/schemas/Tai" }, "minItems":1 } } }, "AddrFqdn":{ "description":"IP address and/or FQDN.", "type":"object", "properties":{ "ipAddr":{ "$ref":"#/components/schemas/IpAddr" }, "fqdn":{ "type":"string", "description":"Indicates FQDN." } } }, "UpfInformation":{ "description":"Represents the ID/address/FQDN of the UPF.", "type":"object", "properties":{ "upfId":{ "type":"string" }, "upfAddr":{ "$ref":"#/components/schemas/AddrFqdn" } } }, "SvcExperience":{ "description":"Contains a mean opinion score with the customized range.", "type":"object", "properties":{ "mos":{ "$ref":"#/components/schemas/Float" }, "upperRange":{ "$ref":"#/components/schemas/Float" }, "lowerRange":{ "$ref":"#/components/schemas/Float" } } }, "NsiLoadLevelInfo":{ "description":"Represents the network slice and optionally the associated network slice instance and the load level information.\n", "type":"object", "properties":{ "loadLevelInformation":{ "$ref":"#/components/schemas/LoadLevelInformation" }, "snssai":{ "$ref":"#/components/schemas/Snssai" }, "nsiId":{ "$ref":"#/components/schemas/NsiId" }, "resUsage":{ "$ref":"#/components/schemas/ResourceUsage" }, "numOfExceedLoadLevelThr":{ "$ref":"#/components/schemas/Uinteger" }, "exceedLoadLevelThrInd":{ "type":"boolean" }, "networkArea":{ "$ref":"#/components/schemas/NetworkAreaInfo" }, "timePeriod":{ "$ref":"#/components/schemas/TimeWindow" }, "resUsgThrCrossTimePeriod":{ "type":"array", "items":{ "$ref":"#/components/schemas/TimeWindow" }, "minItems":1, "description":"Each element indicates the time elapsed between times each threshold is met or exceeded or crossed. The start time and end time are the exact time stamps of the resource usage threshold is reached or exceeded. May be present if the \"listOfAnaSubsets\" attribute is\n provided and the maximum number of instances shall not exceed the value provided in the\n \"numOfExceedLoadLevelThr\" attribute.\n" }, "numOfUes":{ "$ref":"#/components/schemas/NumberAverage" }, "numOfPduSess":{ "$ref":"#/components/schemas/NumberAverage" }, "confidence":{ "$ref":"#/components/schemas/Uinteger" } }, "required":[ "loadLevelInformation", "snssai" ] }, "NumberAverage":{ "description":"Represents information about the average and variance.", "type":"object", "properties":{ "number":{ "$ref":"#/components/schemas/Float" }, "variance":{ "$ref":"#/components/schemas/Float" }, "skewness":{ "$ref":"#/components/schemas/Float" } }, "required":[ "number", "variance" ] }, "LoadLevelInformation":{ "type":"integer", "description":"Represents load level information of the network slice and the optionally associated network slice instance.\n" }, "ResourceUsage":{ "description":"The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.\n", "type":"object", "properties":{ "cpuUsage":{ "$ref":"#/components/schemas/Uinteger" }, "memoryUsage":{ "$ref":"#/components/schemas/Uinteger" }, "storageUsage":{ "$ref":"#/components/schemas/Uinteger" } } }, "ServingLocation":{ "type":"object", "properties":{ "geographicalLocation":{ "$ref":"#/components/schemas/GeoLoc" }, "topologicalLocation":{ "$ref":"#/components/schemas/TopologicalServiceArea" } } }, "TopologicalServiceArea":{ "type":"object", "properties":{ "cellIdList":{ "type":"array", "items":{ "type":"integer" } }, "trackingAreaIdList":{ "$ref":"#/components/schemas/TaiList" }, "servingPLMN":{ "$ref":"#/components/schemas/PlmnId" } } }, "TaiList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Tai" } }, "GeoLoc":{ "type":"object", "properties":{ "geographicalCoordinates":{ "$ref":"#/components/schemas/GeographicalCoordinates" }, "civicLocation":{ "type":"string" } } }, "EDNConnectionInfo":{ "type":"object", "properties":{ "dNN":{ "type":"string" }, "eDNServiceArea":{ "$ref":"#/components/schemas/ServingLocation" } } }, "AffinityAntiAffinity":{ "type":"object", "properties":{ "affinityEAS":{ "type":"array", "items":{ "type":"string" } }, "antiAffinityEAS":{ "type":"array", "items":{ "type":"string" } } } }, "VirtualResource":{ "type":"object", "properties":{ "virtualMemory":{ "type":"integer" }, "virtualDisk":{ "type":"integer" }, "virutalCPU":{ "type":"string" } } }, "SoftwareImageInfo":{ "type":"object", "properties":{ "minimumDisk":{ "type":"integer" }, "minimumRAM":{ "type":"integer" }, "discFormat":{ "type":"string" }, "operatingSystem":{ "type":"string" }, "swImageRef":{ "type":"string" } } } }, "responses":{ "307":{ "description":"The request should be repeated with another URI; however, future requests should still use the original URI", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RedirectResponse" } } }, "headers":{ "Location":{ "description":"The URI pointing to the resource located on the redirect target", "required":true, "schema":{ "type":"string" } }, "3gpp-Sbi-Target-Nf-Id":{ "description":"Identifier of target NF (service) instance towards which the request is redirected", "schema":{ "type":"string" } } } }, "308":{ "description":"The current and all future requests should be directed to the given URI.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RedirectResponse" } } }, "headers":{ "Location":{ "description":"The URI pointing to the resource located on the redirect target", "required":true, "schema":{ "type":"string" } }, "3gpp-Sbi-Target-Nf-Id":{ "description":"'Identifier of target NF (service) instance towards which the request is redirected'\n", "schema":{ "type":"string" } } } }, "400":{ "description":"The request could not be processed because it contains missing or invalid information (such as a validation error on a parameter or a missing required value).", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "401":{ "description":"The request is not authorized. The authentication credentials included with this request are missing or invalid.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "403":{ "description":"The user can't be authenticated. The user does not have authorization to perform this request.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "404":{ "description":"The request includes a resource URI that does not exist.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "405":{ "description":"The HTTP method specified in the request (DELETE, GET, POST, PUT) is not supported for this request URI" }, "406":{ "description":"The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request" }, "408":{ "description":"The server timed out waiting for the request.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "409":{ "description":"The request can't be completed due to a conflict with the current state of the target resource.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "410":{ "description":"Indicates that the resource requested was previously in use but is no longer available and will not be available again.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "411":{ "description":"The request did not specify the length of its content, which is required by the requested resource.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "412":{ "description":"The server does not meet one of the preconditions that the requester put on the request header fields.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "413":{ "description":"The request is larger than the server is willing or able to process.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "414":{ "description":"The URI provided was too long for the server to process.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "415":{ "description":"The request entity has a media type which the server or resource does not support.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "429":{ "description":"The user has sent too many requests in a given amount of time.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "500":{ "description":"The server encountered an unexpected condition that prevented it from fulfilling the request.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "501":{ "description":"The server does not recognize the request method, or lacks the ability to fulfil the request.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "502":{ "description":"The server was acting as a gateway or proxy and received an invalid response from the upstream server.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "503":{ "description":"The server cannot handle the request (because it is overloaded or down for maintenance). Usually a temporary state.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "504":{ "description":"The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.", "content":{ "application/problem+json":{ "schema":{ "$ref":"#/components/schemas/ProblemDetails" } } } }, "default":{ "description":"Generic Error" } } }, "tags":[ { "name":"Nchf Converged Charging", "description":"The Nchf Converged Charging endpoints perform converged online and offline charging." }, { "name":"Nchf Offline-Only Charging", "description":"The Nchf Offline-Only Charging endpoints perform offline charging for session-based Network Function (NF) services and generate Call Detail Records (CDRs)." }, { "name":"Nchf Spending Limit Control", "description":"The Nchf Spending Limit Control endpoints manage spending limit reports for your subscribers." }, { "name":"Usage Consumption", "description":"The Usage Consumption endpoints allow you to view the balance and consumption counters for each of your customer's devices by service type, such as voice, data, and TV." } ] }