A.2 Nucmf_Provisioning API
29.6753GPPRelease 18Stage 3TSUser Equipment (UE) radio capability provisioning service
openapi: 3.0.0
info:
title: Nucmf_Provisioning
version: 1.2.0-alpha.1
description: |
UCMF_Provisioning Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.675 V18.0.0; User Equipment (UE) radio capability provisioning service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.675/
servers:
– url: ‘{apiRoot}/nucmf-provisioning/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– nucmf-provisioning
paths:
/provisionings:
post:
summary: Create an Individual UE radio capability provisioning
operationId: CreateProvisioning
tags:
– UE radio capability provisionings (Collection)
requestBody:
description: Create new provisionings for a given SCS/AS.
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/RacsData’
responses:
‘201’:
description: >
Created. The creation of an Individual UE radio capability provisioning
resource is confirmed and a representation of that resource is returned.
content:
application/json:
schema:
$ref: ‘#/components/schemas/RacsData’
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’:
description: The RACS data for all RACS IDs were not provisioned successfully.
content:
application/json:
schema:
type: array
items:
$ref: ‘TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport’
minItems: 1
application/problem+json:
schema:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/ProblemDetails’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29122_CommonData.yaml#/components/responses/default’
/provisionings/{provisioningId}:
parameters:
– name: provisioningId
in: path
description: Provisioning ID
required: true
schema:
type: string
get:
summary: Get an Individual UE radio capability provisioning
operationId: GetProvisioning
tags:
– Individual UE radio capability provisioning (Document)
responses:
‘200’:
description: OK. The provisioning information related to the request URI is returned.
content:
application/json:
schema:
$ref: ‘#/components/schemas/RacsData’
‘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’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29122_CommonData.yaml#/components/responses/default’
patch:
summary: Update (PATCH) an Individual UE radio capability provisioning
operationId: UpdateProvisioning
tags:
– Individual UE radio capability provisioning (Document)
requestBody:
description: Update an existing parameter provisioning.
required: true
content:
application/merge-patch+json:
schema:
$ref: ‘#/components/schemas/RacsDataPatch’
responses:
‘200’:
description: >
OK. The Individual UE radio capability provisioning resource is modified
and a representation of that resource is returned.
content:
application/json:
schema:
$ref: ‘#/components/schemas/RacsData’
‘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’:
description: The RACS data for all RACS IDs were not provisioned successfully.
content:
application/json:
schema:
type: array
items:
$ref: ‘TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport’
minItems: 1
application/problem+json:
schema:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/ProblemDetails’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29122_CommonData.yaml#/components/responses/default’
put:
summary: Replace (PUT) an Individual UE radio capability provisioning
operationId: ReplaceProvisioning
tags:
– Individual UE radio capability provisioning (Document)
requestBody:
description: Update an existing parameter provisioning.
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/RacsData’
responses:
‘200’:
description: >
OK. The Individual UE radio capability provisioning resource is modified and a
representation of that resource is returned.
content:
application/json:
schema:
$ref: ‘#/components/schemas/RacsData’
‘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’:
description: The RACS data for all RACS IDs were not provisioned successfully.
content:
application/json:
schema:
type: array
items:
$ref: ‘TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport’
minItems: 1
application/problem+json:
schema:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/ProblemDetails’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29122_CommonData.yaml#/components/responses/default’
delete:
summary: Remove an Individual UE radio capability provisioning
operationId: RemoveProvisioning
tags:
– Individual UE radio capability provisioning (Document)
responses:
‘204’:
description: >
No Content. The Individual UE radio capability resource was successfully removed.
The payload body shall be empty.
‘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’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘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:
nucmf-provisioning: Access to the Nucmf_Provisioning API
schemas:
RacsData:
description: Represents a UE radio capability data provided by the NF service consumer.
type: object
properties:
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
racsConfigs:
type: object
additionalProperties:
$ref: ‘TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfiguration’
minProperties: 1
description: >
Identifies the configuration related to manufacturer specific UE radio capability.
Each element uniquely identifies an RACS configuration for an RACS ID and is
identified in the map via the RACS ID as key. The response shall include
successfully provisioned RACS data.
racsReports:
type: object
additionalProperties:
$ref: ‘TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport’
minProperties: 1
description: >
Contains the RACS IDs for which the RACS data are not provisioned successfully. The
failure reason is also included. Any string value can be used as a key of the map.
readOnly: true
required:
– racsConfigs
RacsDataPatch:
description: >
Represents a modification of a UE radio capability data provided by the NF service
consumer.
type: object
properties:
racsConfigs:
type: object
additionalProperties:
$ref: ‘TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfigurationRm’
minProperties: 1
description: >
Identifies the configuration related to manufacturer specific UE radio
capability. Each element uniquely identifies an RACS configuration for an RACS ID
and is identified in the map via the RACS ID as key.
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
TSG # |
TSG Doc. |
CR |
Rev |
Cat |
Subject/Comment |
New |
|
2019-06 |
TS skeleton of UE Radio Capability Provisioning Service |
0.0.0 |
|||||
|
2019-09 |
Includes pCRs agreed in CT3#105: |
0.1.0 |
|||||
|
2019-10 |
Includes pCRs agreed in CT3#106: |
0.2.0 |
|||||
|
2019-11 |
Rapporteur changes: – fill in the referred clause number of TS 29.122 in clauses 4.2.2.2 and 4.2.3.2. – correct the TS version in externalDocs and step the openAPI file version. |
0.3.0 |
|||||
|
2019-12 |
Sent to plenary for information. |
1.0.0 |
|||||
|
2020-03 |
Includes pCRs agreed in CT3#108-e: |
1.1.0 |
|||||
|
2020-03 |
CT#87e |
CP-200189 |
TS sent to plenary for approval |
2.0.0 |
|||
|
2020-03 |
CT#87e |
CP-200189 |
TS approved by plenary |
16.0.0 |
|||
|
2020-06 |
CT#88e |
CP-201243 |
0003 |
– |
F |
Correcting errors in clause 5.6 |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201244 |
0004 |
1 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201243 |
0002 |
1 |
F |
Update to UE radio capability information data type |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201189 |
0001 |
3 |
F |
Addition of IMEI-TAC values for RACS operations |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201190 |
0006 |
1 |
F |
Avoid using the same data type for PUT and PATCH |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201256 |
0005 |
1 |
F |
URI of the Nucmf_Provisioning service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201243 |
0007 |
1 |
F |
Correct OpenAPI scope |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201243 |
0008 |
1 |
F |
Supported headers, Resource Data type and yaml mapping |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201255 |
0009 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.1.0 |
|
|
2020-09 |
CT#89e |
CP-202072 |
0011 |
F |
Resource correction |
16.2.0 |
|
|
2020-09 |
CT#89e |
CP-202078 |
0012 |
1 |
F |
Reference point representation |
17.0.0 |
|
2020-12 |
CT#90e |
CP-203139 |
0014 |
A |
Essential corrections and alignments |
17.1.0 |
|
|
2020-12 |
CT#90e |
CP-203139 |
0016 |
1 |
A |
Storage of YAML files in ETSI Forge |
17.1.0 |
|
2020-12 |
CT#90e |
CP-203136 |
0018 |
1 |
A |
Correct UCMF id |
17.1.0 |
|
2021-03 |
CT#91e |
CP-210218 |
0019 |
F |
Update of "description" field for racsReports |
17.2.0 |
|
|
2021-03 |
CT#91e |
CP-210218 |
0020 |
F |
OpenAPI reference |
17.2.0 |
|
|
2021-03 |
CT#91e |
CP-210221 |
0021 |
1 |
F |
Adding some missing description fields to data type definitions in OpenAPI specification files |
17.2.0 |
|
2021-03 |
CT#91e |
CP-210219 |
0022 |
F |
Support of optional HTTP custom header fields |
17.2.0 |
|
|
2021-03 |
CT#91e |
CP-210220 |
0023 |
F |
Terminology alignment: usage of "NF service consumer" |
17.2.0 |
|
|
2021-03 |
CT#91e |
CP-210235 |
0024 |
F |
Correcting the receiver of HTTP DELETE request |
17.2.0 |
|
|
2021-03 |
CT#91e |
CP-210240 |
0025 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.2.0 |
|
|
2021-09 |
CT#93e |
CP-212218 |
0027 |
A |
Correcting resource definitions |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213239 |
0028 |
F |
API URI of the Nucmf_Provisioning API |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220201 |
0029 |
1 |
F |
Formatting of description fields |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220194 |
0030 |
F |
Update of info and externalDocs fields |
17.5.0 |
|
|
2022-06 |
CT#96 |
CP-221155 |
0031 |
F |
Alignment with the SBI template |
17.6.0 |
|
|
2022-06 |
CT#96 |
CP-221152 |
0032 |
F |
Update of info and externalDocs fields |
17.6.0 |
|
|
2022-12 |
CT#98e |
CP-223213 |
0033 |
1 |
F |
Adding the mandatory error code 502 Bad Gateway |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223190 |
0034 |
F |
Update of info and externalDocs fields |
18.0.0 |
|