A.8 LpiParameterProvision API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

openapi: 3.0.0

info:

title: 3gpp-lpi-pp

version: 1.1.2

description: |

API for Location Privacy Indication Parameters Provisioning.

© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

All rights reserved.

externalDocs:

description: >

3GPP TS 29.522 V17.8.0; 5G System; Network Exposure Function Northbound APIs.

url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/’

security:

– {}

– oAuth2ClientCredentials: []

servers:

– url: ‘{apiRoot}/3gpp-lpi-pp/v1’

variables:

apiRoot:

default: https://example.com

description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.

paths:

/{afId}/provisionedLpis:

get:

summary: read all of the active LPI Parameters Provisioning resources for the AF

operationId: ReadAllResources

tags:

– LPI Parameters Provisionings

parameters:

– name: afId

in: path

description: Identifier of the AF

required: true

schema:

type: string

responses:

‘200’:

description: OK (Successful get all of the active resources for the AF)

content:

application/json:

schema:

type: array

items:

$ref: ‘#/components/schemas/LpiParametersProvision’

‘307’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/307’

‘308’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/308’

‘400’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/400’

‘401’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/401’

‘403’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/403’

‘404’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/404’

‘406’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/406’

‘429’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/429’

‘500’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/500’

‘503’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/503’

default:

$ref: ‘TS29122_CommonData.yaml#/components/responses/default’

post:

summary: Creates a new LPI Parameters Provisioning resource

operationId: CreateNewResource

tags:

– LPI Parameters Provisionings

parameters:

– name: afId

in: path

description: Identifier of the AF

required: true

schema:

type: string

requestBody:

description: new resource creation

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvision’

responses:

‘201’:

description: Created (Successful creation)

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvision’

headers:

Location:

description: Contains the URI of the newly created resource.

required: true

schema:

type: string

‘400’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/400’

‘401’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/401’

‘403’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/403’

‘404’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/404’

‘411’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/411’

‘413’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/413’

‘415’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/415’

‘429’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/429’

‘500’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/500’

‘503’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/503’

default:

$ref: ‘TS29122_CommonData.yaml#/components/responses/default’

/{afId}/provisionedLpis/{provisionedLpiId}:

get:

summary: read an active LPI Parameters Provisioning resource for the AF and the provisioned LPI Id

operationId: ReadAnResource

tags:

– Individual LPI Parameters Provisioning

parameters:

– name: afId

in: path

description: Identifier of the AF

required: true

schema:

type: string

– name: provisionedLpiId

in: path

description: Identifier of the provisioned LPI parameter resource

required: true

schema:

type: string

responses:

‘200’:

description: OK (Successful get the active resource)

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvision’

‘307’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/307’

‘308’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/308’

‘400’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/400’

‘401’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/401’

‘403’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/403’

‘404’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/404’

‘406’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/406’

‘429’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/429’

‘500’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/500’

‘503’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/503’

default:

$ref: ‘TS29122_CommonData.yaml#/components/responses/default’

put:

summary: Fully updates/replaces an existing LPI Parameters Provisioning resource

operationId: FullyUpdateAnResource

tags:

– Individual LPI Parameters Provisioning

parameters:

– name: afId

in: path

description: Identifier of the AF

required: true

schema:

type: string

– name: provisionedLpiId

in: path

description: Identifier of the provisioned LPI parameter resource

required: true

schema:

type: string

requestBody:

description: Parameters to update/replace the existing resource

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvision’

responses:

‘200’:

description: >

OK. The resource has been successfully updated and a representation of the updated

resource is returned.

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvision’

‘204’:

description: >

Successful case. The resource has been successfully updated and no additional

content is sent in the response message.

‘307’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/307’

‘308’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/308’

‘400’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/400’

‘401’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/401’

‘403’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/403’

‘404’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/404’

‘411’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/411’

‘413’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/413’

‘415’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/415’

‘429’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/429’

‘500’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/500’

‘503’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/503’

default:

$ref: ‘TS29122_CommonData.yaml#/components/responses/default’

patch:

summary: Partially modifies an existing LPI Parameters Provisioning resource.

operationId: PartialUpdateAnResource

tags:

– Individual LPI Parameters Provisioning

parameters:

– name: afId

in: path

description: Identifier of the AF

required: true

schema:

type: string

– name: provisionedLpiId

in: path

description: Identifier of the provisioned LPI parameter resource

required: true

schema:

type: string

requestBody:

description: Parameters to modify the existing resource.

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvisionPatch’

responses:

‘200’:

description: >

OK. The resource has been successfully modified and a representation of the

updated resource is returned.

content:

application/json:

schema:

$ref: ‘#/components/schemas/LpiParametersProvision’

‘204’:

description: >

Successful case. The resource has been successfully modified and no additional content

is sent in the response message.

‘307’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/307’

‘308’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/308’

‘400’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/400’

‘401’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/401’

‘403’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/403’

‘404’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/404’

‘411’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/411’

‘413’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/413’

‘415’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/415’

‘429’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/429’

‘500’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/500’

‘503’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/503’

default:

$ref: ‘TS29122_CommonData.yaml#/components/responses/default’

delete:

summary: Deletes an already existing LPI Parameters Provisioning resource

operationId: DeleteAnResource

tags:

– Individual LPI Parameters Provisioning

parameters:

– name: afId

in: path

description: Identifier of the AF

required: true

schema:

type: string

– name: provisionedLpiId

in: path

description: Identifier of the provisioned LPI parameter resource

required: true

schema:

type: string

responses:

‘204’:

description: No Content (Successful deletion of the existing resource)

‘307’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/307’

‘308’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/308’

‘400’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/400’

‘401’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/401’

‘403’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/403’

‘404’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/404’

‘429’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/429’

‘500’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/500’

‘503’:

$ref: ‘TS29122_CommonData.yaml#/components/responses/503’

default:

$ref: ‘TS29122_CommonData.yaml#/components/responses/default’

components:

securitySchemes:

oAuth2ClientCredentials:

type: oauth2

flows:

clientCredentials:

tokenUrl: ‘{tokenUrl}’

scopes: {}

schemas:

LpiParametersProvision:

description: Represents an individual LPI Parameters Provisionings resource.

type: object

properties:

self:

$ref: ‘TS29122_CommonData.yaml#/components/schemas/Link’

exterGroupId:

$ref: ‘TS29122_CommonData.yaml#/components/schemas/ExternalGroupId’

gpsi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’

lpi:

$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/Lpi’

mtcProviderId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation’

suppFeat:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’

required:

– lpi

– suppFeat

LpiParametersProvisionPatch:

description: Represents the parameters to modify an existing Individual LPI Parameters Provisionings resource.

type: object

properties:

lpi:

$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/Lpi’

mtcProviderId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation’