6.8 VAE_V2VConfigRequirement API
29.4863GPPRelease 18Stage 3TSV2X Application Enabler (VAE) Services
6.8.1 Introduction
The VAE_V2VConfigRequirement Service shall use the VAE_V2VConfigRequirement API.
The API URI of the VAE_V2VConfigRequirement API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the VAE Server shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [3], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [3].
– The <apiName> shall be "vae-v2v-config-req".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.8.3.
6.8.2 Usage of HTTP
6.8.2.1 General
Support of HTTP/1.1 (IETF RFC 7230 [12], IETF RFC 7231 [13], IETF RFC 7232 [14], IETF RFC 7233 [15], IETF RFC 7234 [16] and IETF RFC 7235 [17]) over TLS (IETF RFC 5246 [18]) is mandatory and support of HTTP/2 as specified in clause 5 of 3GPP TS 29.500 [2] is recommended. A V2X application specific server desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version as described in IETF RFC 7540 [5].
HTTP/2, shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [2].
An OpenAPI [6] specification of HTTP messages and content bodies for the VAE_V2VConfigRequirement is contained in Annex A.9.
6.8.2.2 HTTP standard headers
6.8.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [2] for the usage of HTTP standard headers.
6.8.2.2.2 Content type
JSON, IETF RFC 8259 [7], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [2]. The use of the JSON format shall be signalled by the content type "application/json".
6.8.2.3 HTTP custom headers
6.8.2.3.1 General
The HTTP custom header fields specified in clause 5.2.8 of 3GPP TS 29.122 [22] may be applicable.
6.8.3 Resources
6.8.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.8.3.1-1 depicts the resource URIs structure for the VAE_V2VConfigRequirement API.
Figure 6.8.3.1-1: Resource URI structure of the VAE_V2VConfigRequirement API
Table 6.8.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.8.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
V2V Configurations |
/configurations |
POST |
Create a new Individual V2V Configuration. |
|
Individual V2V Configuration |
/configurations/{configurationId} |
GET |
Read an Individual V2V Configuration. |
|
PUT |
Update an Individual V2V Configuration. |
||
|
DELETE |
Delete an Individual V2V Configuration. |
6.8.3.2 Resource: V2V Configurations
6.8.3.2.1 Description
This resource represents the collection of the Individual V2V Configuration resources created in the VAE Server.
6.8.3.2.2 Resource Definition
Resource URI: {apiRoot}/vae-v2v-config-req/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 6.8.3.2.2-1.
Table 6.8.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.8.1 |
6.8.3.2.3 Resource Standard Methods
6.8.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.8.3.2.3.1-1.
Table 6.8.3.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 6.8.3.2.3.1-2 and the response data structures and response codes specified in table 6.8.3.2.3.1-3.
Table 6.8.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
V2vConfigurationData |
M |
1 |
Parameters to create an Individual V2V Configuration resource. |
Table 6.8.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
V2vConfigurationData |
O |
0..1 |
201 Created |
An Individual V2V Configuration resource is created successfully. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [2] shall also apply. |
||||
Table 6.8.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/vae-pc5-prov-req/<apiVersion>/configurations/{configurationId} |
6.8.3.2.4 Resource Custom Operations
None.
6.8.3.3 Resource: Individual V2V Configuration
6.8.3.3.1 Description
The Individual V2V Configuration resource represents Individual V2V Configuration created in the VAE Server.
6.8.3.3.2 Resource definition
Resource URI: {apiRoot}/vae-pc5-prov-req/<apiVersion>/ configurations/{configurationId}
This resource shall support the resource URI variables defined in table 6.8.2.3.3-1.
Table 6.8.3.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.8.1 |
|
configurationId |
string |
Unique identifier of the Individual V2V Configuration resource. |
6.8.3.3.3 Resource Standard Methods
6.8.3.3.3.1 GET
This method shall support the URI query parameters specified in table 6.8.3.3.3.1-1.
Table 6.8.3.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.8.3.3.3.1-2 and the response data structures and response codes specified in table 6.8.3.3.3.1-3.
Table 6.8.3.3.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.8.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
V2vConfigurationData |
M |
1 |
200 OK |
An Individual V2V Configuration resource is returned successfully. |
|
n/a |
307 Temporary Redirect |
Temporary redirection, during Individual V2V Configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection, during Individual V2V Configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server. |
||
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [2] shall also apply. |
||||
Table 6.8.3.3.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative VAE Server. |
Table 6.8.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative VAE Server. |
6.8.3.3.3.2 PUT
This method shall support the URI query parameters specified in table 6.8.3.3.3.2-1.
Table 6.8.3.3.3.2-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.8.3.3.3.2-2 and the response data structures and response codes specified in table 6.8.3.3.3.2-3.
Table 6.8.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
V2vConfigurationData |
M |
1 |
Parameters to update an Individual V2V Configuration resource. |
Table 6.8.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
V2vConfigurationData |
M |
1 |
200 OK |
The Individual V2V Configuration resource was successfully updated. |
|
n/a |
204 No Content |
The Individual V2V Configuration resource was successfully updated. |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection, during the Individual V2V Configuration update. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection, during the Individual V2V Configuration update. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server. |
||
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. |
||||
Table 6.8.3.3.3.2-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative VAE Server. |
Table 6.8.3.3.3.2-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative VAE Server. |
6.8.3.3.3.3 DELETE
This method shall support the URI query parameters specified in table 6.8.3.3.3.3-1.
Table 6.8.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.8.3.3.3.3-2 and the response data structures and response codes specified in table 6.8.3.3.3.3-3.
Table 6.8.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.8.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Individual V2V Configuration resource was successfully deleted |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection, during the Individual V2V Configuration resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection, during the Individual V2V Configuration resource deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative VAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [22] with the difference: SCEF is replaced by the VAE Server and the SCS/AS is replaced by the V2X application specific server. |
||
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. |
||||
Table 6.8.3.3.3.3-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative VAE Server. |
Table 6.8.3.3.3.3-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative VAE Server. |
6.8.3.4 Resource Custom Operations
None.
6.8.4 Custom Operations without associated resources
There are no custom operations without associated resources supported on V2V Configuration Requirement.
6.8.5 Notifications
None.
6.8.6 Data Model
6.8.6.1 General
This clause specifies the application data model supported by the API.
Table 6.8.6.1-1 specifies the data types defined for the VAE_V2VConfigRequirement API.
Table 6.8.6.1-1: VAE_V2VConfigRequirement specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
V2vConfigurationData |
6.8.6.2.2 |
Contains the V2V configuration data. |
Table 6.8.6.1-2 specifies data types re-used by the VAE_V2VConfigRequirement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the VAE_V2VConfigRequirement service based interface.
Table 6.8.6.1-2: VAE_V2VConfigRequirement re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
AppplicationQosRequirement |
6.7.6.2.4 |
Used to indicate an application layer QoS requirement. |
|
|
SupportedFeatures |
3GPP TS 29.571 [11] |
Used to negotiate the applicability of the optional features. |
|
|
Uri |
3GPP TS 29.571 [11] |
Used to indicate an URI. |
|
|
V2xGroupId |
6.1.6.3.2 |
The group ID |
|
|
V2xServiceId |
6.1.6.3.2 |
The V2X service ID. |
|
|
V2xUeId |
6.1.6.3.2 |
Identifier of the destination V2X UE |
6.8.6.2 Structured data types
6.8.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.8.6.2.2 Type: V2vConfigurationData
Table 6.8.6.2.2-1: Definition of type V2vConfigurationData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
groupId |
V2xGroupId |
C |
0..1 |
Identity of the V2X group for which the V2X application requirement is initiated. |
|
|
serviceId |
V2xServiceId |
C |
1 |
The V2X service ID for which application requirement corresponds to. |
|
|
canUeIds |
array(V2xUeId) |
O |
1..N |
List of identities of the V2X UEs, which are candidate to serve as application layer relays. |
|
|
appQosReq |
ApplicationQosRequirement |
O |
0..1 |
The application QoS requirements for the V2X service. |
|
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the features supported by the service consumer. It shall be included in the first interaction. |
|
|
NOTE: Either "groupId" attribute or "serviceId" attribute shall be present. |
|||||
6.8.6.3 Simple data types and enumerations
6.8.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.8.6.3.2 Simple data types
The simple data types defined in table 6.8.6.3.2-1 shall be supported.
Table 6.8.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
6.8.7 Error Handling
6.8.7.1 General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [2].
For the VAE_V2VConfigRequirement Service API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [3].
Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [2] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [2].
In addition, the requirements in the following clauses are applicable for the VAE_V2VConfigRequirement Service API.
6.8.7.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the VAE_V2VConfigRequirement API.
6.8.7.3 Application Errors
The application errors defined for the VAE_V2VConfigRequirement service are listed in Table 6.3.7.3-1.
Table 6.8.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
6.8.8 Feature negotiation
The optional features in table 6.8.8-1 are defined for the VAE_V2VConfigRequirement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [2].
Table 6.8.8-1: Supported Features
|
Feature number |
Feature Name |
Description |