6.2 VAE_FileDistribution Service API
29.4863GPPRelease 18Stage 3TSV2X Application Enabler (VAE) Services
6.2.1 Introduction
The VAE_FileDistribution shall use the VAE_FileDistribution API.
The API URI of the VAE_FileDistribution 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-file-distribution".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.2.3.
6.2.2 Usage of HTTP
6.2.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 is mandatory and support of HTTP/2 as specified in clause 5 of 3GPP TS 29.500 [2] is recommended. TLS shall be used as specified in 3GPP TS 33.536 [31] and 3GPP TS 33.501 [32]. 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_FileDistribution is contained in Annex A.3.
6.2.2.2 HTTP standard headers
6.2.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [2] for the usage of HTTP standard headers.
6.2.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.2.2.3 HTTP custom headers
6.2.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.2.3 Resources
6.2.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.2.3.1-1 depicts the resource URIs structure for the VAE_FileDistribution API.
Figure 6.2.3.1-1: Resource URI structure of the VAE_FileDistribution API
Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.2.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
File Distributions |
/file-distributions |
POST |
Create a new Individual File Distribution resource for a V2X group ID. |
|
Individual File Distribution |
/file-distributions/{distributionId} |
GET |
Read an Individual File Distribution resource. |
|
DELETE |
Delete an Individual File Distribution resource. |
6.2.3.2 Resource: File Distributions
6.2.3.2.1 Description
This resource represents the collection of the individual File Distribution resources created in the VAE Server.
6.2.3.2.2 Resource Definition
Resource URI: {apiRoot}/vae-file-distribution/<apiVersion>/file-distributions
This resource shall support the resource URI variables defined in table 6.2.3.2.2-1.
Table 6.2.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
6.2.3.2.3 Resource Standard Methods
6.2.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1.
Table 6.2.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.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3.
Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
FileDistributionData |
M |
1 |
Parameters to create an individual File Distribution resource. |
Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
FileDistributionData |
O |
0..1 |
201 Created |
An individual File Distribution resource for the V2X group ID 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.2.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-file-distribution/<apiVersion>/file-distributions/{distributionId} |
6.2.3.2.4 Resource Custom Operations
None.
6.2.3.3 Resource: Individual File Distribution
6.2.3.3.1 Description
The individual File Distribution resource represents an individual File Distribution created in the VAE Server and associated with the V2X group ID.
6.2.3.3.2 Resource definition
Resource URI: {apiRoot}/vae-file-distribution/<apiVersion>/file-distributions/{distributionId}
This resource shall support the resource URI variables defined in table 6.2.3.3-1.
Table 6.2.3.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 6.2.1 |
|
distributionId |
string |
Unique identifier of the individual File Distribution resource for the V2X group ID. |
6.2.3.3.3 Resource Standard Methods
6.2.3.3.3.1 GET
This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1.
Table 6.2.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.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3.
Table 6.2.3.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
FileDistributionData |
M |
1 |
200 OK |
An individual File Distribution resource for the V2X group ID is returned successfully. |
|
n/a |
307 Temporary Redirect |
Temporary redirection, during Individual File Distribution 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 File Distribution 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.2.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.2.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.2.3.3.3.2 DELETE
This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1.
Table 6.2.3.3.3.2-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.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3.
Table 6.2.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 6.2.3.3.3.2-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 File Distribution resource was successfully deleted. |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection, during Individual File Distribution 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 Individual File Distribution 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 [2] also apply. |
||||
Table 6.2.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.2.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.2.3.4 Resource Custom Operations
None.
6.2.4 Custom Operations without associated resources
There are no custom operations without associated resources supported on VAE_FileDistribution.
6.2.5 Notifications
N/A
6.2.6 Data Model
6.2.6.1 General
This clause specifies the application data model supported by the API.
Table 6.2.6.1-1 specifies the data types defined for the VAE_FileDistribution API.
Table 6.2.6.1-1: VAE_FileDistribution specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
FileDistributionData |
6.2.6.2.2 |
Represents an individual File Distribution resource for a V2X group ID. |
|
|
Filelist |
6.2.6.2.3 |
Represents a file list. |
|
|
FileStatus |
6.2.6.3.3 |
Represents a file status. |
|
|
LocalMbmsInfo |
6.2.6.2.4 |
Contains the local MBMS information. |
LocalMBMS |
Table 6.1.6.1-2 specifies data types re-used by the VAE_FileDistribution 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_FileDistribution service based interface.
Table 6.2.6.1-2: VAE_FileDistribution re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
BitRate |
3GPP TS 29.571 [11] |
||
|
DateTime |
3GPP TS 29.571 [11] |
||
|
DurationSec |
3GPP TS 29.571 [11] |
||
|
GeographicArea |
3GPP TS 29.572 [20] |
||
|
SupportedFeatures |
3GPP TS 29.571 [11] |
||
|
Uinteger |
3GPP TS 29.571 [11] |
||
|
V2xGroupId |
6.1.6.3.2 |
6.2.6.2 Structured data types
6.2.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.2.6.2.2 Type: FileDistributionData
Table 6.2.6.2.2-1: Definition of type FileDistributionData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
groupId |
V2xGroupId |
O |
0..1 |
Indicates a group ID for which the V2X message is addressed. |
|
|
fileLists |
array(FileList) |
M |
1..N |
File lists. |
|
|
serviceClass |
string |
O |
0..1 |
Information about the V2X application (e.g., software update, HD map download) |
|
|
geoArea |
GeographicArea |
M |
1 |
Target geographical area for the V2X Ues |
|
|
maxBitrate |
BitRate |
M |
1 |
Maximum bitrate for the V2X application. |
|
|
maxDelay |
Uinteger |
M |
1 |
Unsigned integer identifying a maximum delay in units of milliseconds for the V2X application. |
|
|
duration |
DateTime |
O |
0..1 |
Identifies the absolute time at which the related Individual File Distribution Data resource is considered to expire. When omitted in the request, it indicates the resource is requested to be valid forever by the NF service consumer. When omitted in the response, it indicates the resource is set to valid forever by the VAE server |
|
|
localMbmsInfo |
LocalMbmsInfo |
O |
0..1 |
Contains the local MBMS inforamtion. The information only can be provided by the NF service consumer in the trust domain. |
LocalMBMS |
|
localMbmsActInd |
boolean |
0..1 |
When this attribute is included and set to true, it indicates that the local MBMS is activated. The default value "FALSE" shall apply, if the attribute is not present. |
LocalMBMS |
|
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the features supported by the service consumer and VAE server. It shall be included in the request and response of the Creation of Individual File Distribution Data resource.. |
6.2.6.2.3 Type: FileList
Table 6.2.6.2.4-1: Definition of type FileList
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
fileUri |
Uri |
M |
1 |
||
|
fileDisplayUri |
Uri |
M |
1 |
||
|
fileEarFetchTime |
DateTime |
M |
1 |
||
|
fileLatFetchTime |
DateTime |
M |
1 |
||
|
fileSize |
Uinteger |
O |
0..1 |
||
|
fileStatus |
FileStatus |
M |
1 |
||
|
completionTime |
DateTime |
M |
1 |
||
|
keepUpdateInterval |
DurationSec |
M |
1 |
||
|
uniAvailability |
Boolean |
O |
0..1 |
||
|
fileRepetition |
Uinteger |
O |
0..1 |
6.2.6.2.4 Type: LocalMbmsInfo
Table 6.2.6.2.4-1: Definition of type LocalMbmsInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
mbmsEnbIpv4MulAddr |
Ipv4Addr |
O |
0..1 |
Contains the M1 (transport) plane IPv4 destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams. |
|
|
mbmsEnbIpv6MulAddr |
Ipv6Prefix |
O |
0..1 |
Contains the M1 (transport) plane IPv6 prefix of destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams. |
|
|
mbmsGwIpv4SsmAddr |
Ipv4Addr |
O |
0..1 |
Contains the value of MBMS-GW’s IPv4 address for Source Specific Multicasting. |
|
|
mbmsGwIpv6SsmAddr |
Ipv6Addr |
O |
0..1 |
Contains the value of MBMS-GW’s IPv6 address for Source Specific Multicasting. |
|
|
cteid |
string |
O |
0..1 |
Indicates the common tunnel endpoint identifier of MBMS GW for user plane. |
|
|
bmscIpv4Addr |
Ipv4Addr |
O |
0..1 |
Indicates the destination IPv4 address of the BM‑SC for the reception of user plane data via the MB2-U or xMB‑U interface. |
|
|
bmscIpv6Addr |
Ipv6Addr |
O |
0..1 |
Indicates the destination IPv6 address of the BM‑SC for the reception of user plane data via the MB2-U or xMB‑U interface. |
|
|
bmscPort |
Uinteger |
O |
0..1 |
Indicates the destination UDP port of the BM‑SC for the reception of user plane data via the MB2-U or xMB‑U interface. |
6.2.6.3 Simple data types and enumerations
6.2.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.2.6.3.2 Simple data types
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
Table 6.2.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
6.2.6.3.3 Enumeration: FileStatus
Table 6.2.6.3.3-1: Enumeration FileStatus
|
Enumeration value |
Description |
Applicability |
|
PENDING |
The file is pending. |
|
|
FETCHED |
The file is fetched |
|
|
PREPARED |
The file is prepared |
|
|
TRANSMITTING |
The file is transmitting |
|
|
SENT |
The file is sent. |
6.2.6.3.4 Enumeration: Result
Table 6.2.6.3.4-1: Enumeration Result
|
Enumeration value |
Description |
Applicability |
|
SUCCESS |
Indicates that the downlink message delivery is successful. |
|
|
FAIL |
Indicates that the downlink message delivery is failed. |
6.2.7 Error Handling
6.2.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_FileDistribution 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_FileDistribution Service API.
6.2.7.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the VAE_FileDistribution API.
6.2.7.3 Application Errors
The application errors defined for the VAE_FileDistribution service are listed in table 6.2.7.3-1.
Table 6.2.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
6.2.8 Feature negotiation
The optional features in table 6.1.8-1 are defined for the VAE_FileDistribution API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [2].
Table 6.1.8-1: Supported Features
|
Feature number |
Feature Name |
Description |
|
x |
LocalMBMS |
Indicate the support of local MBMS transmission. |