NpConfiguration

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-network-parameter-configuration

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

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

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-network-parameter-configuration/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause of 3GPP TS 29.122.

paths

scsAsId configurations

get:

Summary: read all of the active configurations for the SCS/AS

Tags:

- NpConfiguration API SCS/AS level GET Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (Successful get all of the active NpConfigurations for the SCS/AS)

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/NpConfiguration'

minItems: 0

Description: Network Parameter configurations

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

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

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

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

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

Method: Post

Summary: Creates a new configuration resource for network parameter configuration

Tags:

- NpConfiguration API Configuration level POST Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

Request Body:

Description: new configuration creation

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/NpConfiguration'

Callbacks:

notificationDestination:

'{request.body#/notificationDestination}':

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ConfigurationNotification'

Responses:

'204' No Content (successful notification)

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

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

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

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

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

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

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

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

Responses:

'201' Created (Successful creation of configuration)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/NpConfiguration'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

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

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

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

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

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

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

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

scsAsId configurations configurationId

get:

Summary: read an active configuration for the SCS/AS and the configuration Id

Tags:

- NpConfiguration API Configuration level GET Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: configurationId

In: path

Description: Identifier of the configuration resource

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (Successful get the active configuration)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/NpConfiguration'

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

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

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

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

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

put:

Summary: Updates/replaces an existing configuration resource

Tags:

- NpConfiguration API Configuration level PUT Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: configurationId

In: path

Description: Identifier of the configuration resource

Required/Optional: true

Schema:

Type: string

Request Body:

Description: Parameters to update/replace the existing configuration

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/NpConfiguration'

Responses:

'200' OK (Successful deletion of the existing configuration)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/NpConfiguration'

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

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

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

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

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

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

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

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

patch:

Summary: Updates/replaces an existing configuration resource

Tags:

- NpConfiguration API Configuration level PATCH Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: configurationId

In: path

Description: Identifier of the configuration resource

Required/Optional: true

Schema:

Type: string

Request Body:

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/NpConfigurationPatch'

Responses:

'200' OK. The configuration was modified successfully.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/NpConfiguration'

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

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

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

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

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

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

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

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

delete:

Summary: Deletes an already existing configuration

Tags:

- NpConfiguration API Configuration level DELETE Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: configurationId

In: path

Description: Identifier of the configuration resource

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content (Successful deletion of the existing configuration)

'200' OK. (Successful deletion of the existing configuration)

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult'

minItems: 1

Description: The configuration was terminated successfully, the configuration failure information for group members shall be included if received.

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

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

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

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

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

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

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

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

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

NpConfiguration

Type: object

Properties:

self:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

externalId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'

msisdn:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Msisdn'

externalGroupId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'

maximumLatency:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

maximumResponseTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

suggestedNumberOfDlPackets:

Type: integer

Minimum: 0

Description: This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable.

groupReportingGuardTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

notificationDestination:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

requestTestNotification:

Type: boolean

Description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

websockNotifConfig:

Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

oneOf:

- required: [externalId]

- required: [msisdn]

- required: [externalGroupId]

NpConfigurationPatch

Type: object

Properties:

maximumLatency:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'

maximumResponseTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'

suggestedNumberOfDlPackets:

Type: integer

Minimum: 0

Description: This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable.

nullable: true

groupReportGuardTime:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'

ConfigurationNotification

Type: object

Properties:

configuration:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

configResults:

Type: array

Items:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult'

minItems: 1

Description: The grouping configuration result notification provided by the SCEF.

Required: configuration