A.10 VAE_PC5ProvisioningRequirement API
29.4863GPPRelease 18Stage 3TSV2X Application Enabler (VAE) Services
openapi: 3.0.0
info:
version: 1.1.0-alpha.1
title: VAE_PC5ProvisioningRequirement
description: |
API for VAE_PC5ProvisioningRequirement
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/’
security:
– {}
– oAuth2ClientCredentials: []
servers:
– url: ‘{apiRoot}/vae-pc5-prov-req/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
paths:
/subscriptions:
post:
summary: VAE_PC5 Provisioning Requirement resource create service Operation
tags:
– PC5 provisioning requirement subscriptions collection (Document)
operationId: Create
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProvisioningRequirement’
required: true
responses:
‘201’:
description: PC5 Provisioning Requirement Subscription Resource Created
headers:
Location:
description: ‘Contains the URI of the newly created resource’
required: true
schema:
type: string
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProvisioningRequirement’
‘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’
callbacks:
NotifyResutOfMultiOperationPC5Provisioning:
‘{$request.body#/notifUri}’:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/Notification’
responses:
‘204’:
description: No Content, Notification was succesfull
‘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’
/subscriptions/{subscriptionId}:
get:
summary: VAE PC5 Provisioning Requirement Subscription resource read service Operation
tags:
– Individual PC5 Provisioning Requirement Subscription (Document)
operationId: ReadPC5ProvisioningRequirementSubscription
parameters:
– name: subscriptionId
in: path
description: Identifier of an PC5 Provisioning Requirement Subscription resource
required: true
schema:
type: string
responses:
‘200’:
description: OK. Resource representation is returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProvisioningRequirement’
‘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: Updates/replaces an existing subscription resource
tags:
– VAE PC5 Provisioning Requirement Subscription resource put service Operation
operationId: UpdatePC5ProvisioningRequirementSubscription
parameters:
– name: subscriptionId
in: path
description: Identifier of an PC5 Provisioning Requirement Subscription resource
required: true
schema:
type: string
requestBody:
description: Parameters to update/replace the existing subscription
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProvisioningRequirement’
responses:
‘200’:
description: OK (Successful update of the subscription)
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProvisioningRequirement’
‘204’:
description: No Content (Successful update of the subscription)
‘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: VAE PC5 Provisioning Requirement Subscription resource delete service Operation
tags:
– Individual PC5 Provisioning Requirement Subscription (Document)
operationId: DeletePC5ProvisioningRequirementSubscription
parameters:
– name: subscriptionId
in: path
required: true
description: Unique ID of the PC5 Provisioning Requirement Subscription to be deleted
schema:
type: string
responses:
‘204’:
description: The subscription was terminated successfully.
‘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:
ProvisioningRequirement:
description: Represents an Individual PC5 Provisioning Requirement Subscription resource.
type: object
properties:
ueId:
$ref: ‘TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId’
groupId:
$ref: ‘TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xGroupId’
notifUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
serviceId:
$ref: ‘TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xServiceId’
appQosReq:
$ref: ‘TS29486_VAE_SessionOrientedService.yaml#/components/schemas/AppplicationQosRequirement’
plmnList:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PlmnId’
minItems: 1
requestTestNotification:
type: boolean
description: >
Set to true by the NF service consumer to request the VAE server to send a test
notification as defined in clause 6.3.5.3. Set to false or omitted otherwise.
websockNotifConfig:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig’
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– serviceId
– notifUri
Notification:
description: Represents a notificaton of result of PC5 Provisioning Requirement.
type: object
properties:
resourceUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
result:
$ref: ‘TS29486_VAE_MessageDelivery.yaml#/components/schemas/Result’
required:
– resourceUri
– result
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-06 |
TS skeleton of V2X Application Enabler (VAE) Services |
0.0.0 |
|||||
|
2019-09 |
CT3#105 |
Inclusion of C3-193499, C3-193310, C3-193501, C3-193603, C3-193604 and editorial changes from Rapporteur |
0.1.0 |
||||
|
2019-10 |
CT3#106 |
Inclusion of C3-193142, C3-194143, C3-194309, C3-194417, C3-194311 and editorial changes from Rapporteur |
0.2.0 |
||||
|
2019-11 |
CT3#107 |
Inclusion of C3-195320, C3-195102, C3-195321, C3-195322, C3-195323, C3-195407 and editorial changes from Rapporteur |
0.3.0 |
||||
|
2020-02 |
CT3#108e |
Inclusion of C3-201341, C3-201342, C3-201343, C3-201344, C3-201345, C3-201453, C3-201454, C3-201455 and editorial changes from Rapporteur |
0.4.0 |
||||
|
2020-03 |
CT#87e |
CP-200186 |
TS sent to plenary for approval |
1.0.0 |
|||
|
2020-03 |
CT#87e |
CP-200186 |
TS approved by plenary |
16.0.0 |
|||
|
2020-06 |
CT#88e |
CP-201251 |
0001 |
1 |
B |
Apiversion of VAE_FileDistribution API |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201251 |
0003 |
F |
Correction to DELETE method of VAE_FileDistribution API |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201251 |
0004 |
1 |
F |
Editoral corrections of 29.486 |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201251 |
0005 |
1 |
F |
Storage of YAML files |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201256 |
0006 |
1 |
F |
URI of the VAE APIs |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201251 |
0007 |
1 |
F |
Correct resource tree and service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201251 |
0009 |
1 |
F |
Corrections to apiVersion |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201251 |
0010 |
1 |
F |
Supported headers, Resource Data type and yaml mapping |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201255 |
0011 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.1.0 |
|
|
2020-12 |
CT#90e |
CP-203139 |
0012 |
1 |
F |
Essential corrections and alignments |
16.2.0 |
|
2020-12 |
CT#90e |
CP-203139 |
0013 |
F |
Storage of YAML files in 3GPP Forge |
16.2.0 |
|
|
2021-03 |
CT#91e |
CP-210245 |
0015 |
F |
Error handling of 29.486 |
16.3.0 |
|
|
2021-03 |
CT#91e |
CP-210236 |
0014 |
3 |
F |
Support Redirection for V2XAPP APIs |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210221 |
0017 |
1 |
F |
Adding some missing description fields to data type definitions in OpenAPI specification files |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210220 |
0018 |
F |
Corrections to HTTP custom headers handling for Northbound APIs |
17.0.0 |
|
|
2021-03 |
CT#91e |
CP-210220 |
0019 |
F |
OpenAPI reference |
17.0.0 |
|
|
2021-03 |
CT#91e |
CP-210240 |
0020 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.0.0 |
|
|
2021-06 |
CT#92e |
CP-211239 |
0021 |
1 |
F |
Additional corrections to HTTP custom headers handling for Northbound APIs |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211223 |
0022 |
3 |
B |
Support Local MBMS |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211223 |
0023 |
2 |
B |
Introduction of VAE_HDMapDynamicInfo service |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211223 |
0024 |
2 |
B |
Procedure of VAE_HDMapDynamicInfo service |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211223 |
0025 |
2 |
B |
Resources and methods of VAE_HDMapDynamicInfo service |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211223 |
0026 |
2 |
B |
OpenAPI file of VAE_HDMapDynamicInfo service |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211255 |
0027 |
F |
Correct the subclause number of reference |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211260 |
0029 |
A |
Correct referenced datatype for VAE_MessageDelivery |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211260 |
0031 |
A |
Correct resourceUri used in Message Delivery procedures |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211260 |
0033 |
A |
Correction of Individual Downlink Message Delivery resource name |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211260 |
0035 |
A |
Correct service operation name for VAE_FileDistribution |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211260 |
0037 |
A |
Correct serivce name and resourceUri for VAE_ApplicationRequirement |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211260 |
0039 |
A |
Correct service name and resourceUri for VAE_DynamicGroup |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211255 |
0041 |
1 |
F |
Termination of Downlink Message Delivery procedure |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211255 |
0043 |
1 |
F |
Termination of File Distribution procedure |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211255 |
0045 |
1 |
F |
Network Resource Reservation procedure |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211260 |
0047 |
1 |
A |
Termination of Dynamic Group Configuration procedure |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211255 |
0048 |
1 |
F |
Common default HTTP response |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211255 |
0049 |
F |
Termination of Dynamic Group Configuration procedure |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211179 |
0050 |
1 |
B |
Reception report for downlink message delivery |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211240 |
0051 |
B |
Reception report for uplink message delivery |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211241 |
0052 |
1 |
B |
Behaviour of the VAE server for VAE_ApplicationRequirement Service |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211241 |
0053 |
1 |
B |
Behaviour of the VAE server for VAE_DynamicGroup Service |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211240 |
0054 |
B |
Behaviour of the VAE server for VAE_ServiceContinuity Service |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211223 |
0055 |
1 |
B |
CAPIF support |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211265 |
0056 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.1.0 |
|
|
2021-09 |
CT#93e |
CP-212214 |
0058 |
F |
Resource URI correction on VAE APIs |
17.2.0 |
|
|
2021-09 |
CT#93e |
CP-212214 |
0059 |
F |
Correction of some remaining invalid characters in OpenAPI specification files |
17.2.0 |
|
|
2021-09 |
CT#93e |
CP-212223 |
0060 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.2.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0061 |
B |
Introduction of VAE_SessionOrientedService |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0062 |
B |
Procedure of VAE_SessionOrientedService |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0063 |
B |
Resources and methods of VAE_SessionOrientedService |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0064 |
2 |
B |
OpenAPI file of VAE_SessionOrientedService |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213232 |
0065 |
B |
Introduction of VAE_V2VConfigRequirement |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0066 |
B |
Procedure of VAE_V2VConfigRequirement |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0067 |
B |
Resources and methods of VAE_V2VConfigRequirement |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0068 |
2 |
B |
OpenAPI file of VAE_PC5ProvisioningRequirement |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213232 |
0069 |
B |
Introduction of VAE_PC5ProvisioningRequirement |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0070 |
B |
Procedure of VAE_PC5ProvisioningRequirement |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213232 |
0071 |
2 |
B |
Resources and methods of VAE_PC5ProvisioningRequirement |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213232 |
0072 |
2 |
B |
OpenAPI file of VAE_PC5ProvisioningRequirement |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213220 |
0073 |
B |
Alignment with SA3 supported TLS profiles |
17.3.0 |
|
|
2022-03 |
CT#95e |
CP-220184 |
0078 |
F |
Correction to VAE_PC5ProvisioningRequirement Service |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220184 |
0079 |
F |
Correction to VAE_SessionOrientedService Service |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220184 |
0080 |
F |
Correction to VAE_V2VConfigRequirement Service |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220201 |
0081 |
F |
Formatting of Description Fields |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220194 |
0082 |
F |
Update of info and externalDocs fields |
17.4.0 |
|
|
2022-06 |
CT#96 |
CP-221147 |
0083 |
1 |
F |
VAE_DynamicGroup API corrections |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221147 |
0084 |
2 |
F |
Removing the apiVersion placeholder from the Resource URI variables tables |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221151 |
0085 |
F |
Update of info and externalDocs fields |
17.5.0 |
|
|
2022-09 |
CT#97e |
CP-222117 |
0086 |
F |
Correction of the "SubscriptionId" resource URI variable name |
17.6.0 |
|
|
2022-12 |
CT#98e |
CP-223185 |
0088 |
F |
Correction of the tables for the re-used, API-specific data structures in VAE APIs |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223185 |
0089 |
1 |
F |
Correction the enumerations in the VAE OpenAPI files |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223185 |
0090 |
F |
Correction of the OpenAPI file formating and descriptions in the VAE APIs |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223189 |
0091 |
F |
Update of info and externalDocs fields |
18.0.0 |
|