hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.2.2 Resource Definition | Resource URI: {apiRoot}/data-discovery/<apiVersion>/dme-types The resource URI variables supported by the resource are defined in Table 7.2.5.2.2-1. Table 7.2.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 7.2.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 53 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.2.3 Resource Standard Methods | 7.2.5.2.3.1 GET This method shall support the URI query parameters specified in Table 7.2.5.2.3.1-1, the request data structure specified in Table 7.2.5.2.3.1-2 and the response data structure and response code specified in Table 7.2.5.2.3.1-3. Table 7.2.5.2.3.1-1: URI query parameters supported by the GET method on this resource Name Data type P Cardinality Description Applicability identity- namespace string O 0..1 Identity namespace, which shall match the "namespace" part of the "dmeTypeId" attribute (see note 1). identity-name string O 0..1 Identity name, which shall match the "name" part of the "dmeTypeId" attribute (see note 1). data-category array(string) O 0..N Set of data category entries, all of which shall match entries of the "dataCategory" attribute (see notes 1 and 2). NOTE 1: If multiple query parameters are provided these shall be combined with AND when evaluating the query. NOTE 2: The encoding of query parameter for array of string shall follow the guideline defined in ETSI TS 129 501 [1] clause 5.3.13. Table 7.2.5.2.3.1-2: Data structures supported by the GET request body on this resource Data Type P Cardinality Description N/A There is no object in the message content of the GET request. Table 7.2.5.2.3.1-3: Data structures supported by the GET response body on this resource Data Type P Cardinality Response codes Description array (DmeTypeRelatedCapabilities) M 0.. N 200 OK The operation was successful. The message content of the GET response carries an array of DmeTypeRelatedCapabilities structures. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.3 Resource: "Individual DME type" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.3.1 Description | The resource represents a DME type. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.3.2 Resource Definition | Resource URI: {apiRoot}/data-discovery/<apiVersion>/dme-types/{dmeTypeId} The resource URI variables supported by the resource are defined in Table 7.2.5.3.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 54 Table 7.2.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2 apiVersion See clause 7.2.2 dmeTypeId DME type identifier identifying a DME type |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.3.3 Resource Standard Methods | 7.2.5.3.3.1 GET This method shall support the URI query parameters specified in Table 7.2.5.3.3.1-1, the request data structure specified in Table 7.2.5.3.3.1-2 and the response data structure and response code specified in Table 7.2.5.3.3.1-3. Table 7.2.5.3.3.1-1: URI query parameters supported by the GET method on this resource Name Data type P Cardinality Description Applicability N/A Table 7.2.5.3.3.1-2: Data structures supported by the GET request body on this resource Data type P Cardinality Description N/A The message content of a GET request is empty. Table 7.2.5.3.3.1-3: Data structures supported by the GET response body on this resource Data type P Cardinality Response codes Description DmeTypeRelatedCap abilities M 1 200 OK The operation was successful. The message content a DmeTypeRelatedCapabilities structure. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.3.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.7 Notifications | None. 7.2.8 Data Model |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.1.1 Overview | The following clause defines the structured data types and their attributes to be used by the service API. For this service API, no structured data types are defined in the present document. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 55 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.2.1 Introduction | The following clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.2.2 Simple data types | For this service API, no simple data types are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.2.3 Enumerations | For this service API, no enumerations are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.8.4 Service-specific registration information | None. 7.2.9 Error Handling |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.9.1 General | In addition to the general provisions in clause 5.4.3, the requirements in the following clauses are applicable for the Data Discovery API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3 Data access API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.1 Introduction | This API enables the API Consumer to request or subscribe data instances based on the Data request service and Data subscription service procedures defined in R1GAP [5]. The API definition applies to both scenarios when rApp is the Service Consumer and when DME is the Service Consumer, respectively. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.2 API version | For the Data access API as specified in the present document, the MAJOR version field shall be 2, the MINOR version field shall be 0 and the PATCH version field shall be 0 (see ETSI TS 129 501 [1] for a definition of the version fields). Consequently, the <apiVersion> URI path segment shall be set to "v2". The API is under development and consequently the API version shall include the pre-release version "alpha.2". ETSI ETSI TS 104 231 V8.0.0 (2026-03) 56 7.3.3 Resource structure and methods The request URIs used in HTTP requests from the API Consumer towards the API Producer shall have the resource URI structure as defined in clause 5.2. The <apiName> resource URI variable shall be "data-access". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 7.3.5. Figure 7.3.3-1 shows the overall resource URI structure defined for the Data access API. Figure 7.3.3-1: Resource URI structure of the Data access API Table 7.3.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 7.3.3-1: Resources and methods overview of the data access API Resource name Resource URI HTTP method Service Operation All data jobs …/data-jobs POST Create an individual data job GET Query data job identifiers Individual data job …/data-jobs/{dataJobId} DELETE Cancel data job PUT Update data job GET Query data job Individual data job status …/data-jobs/{dataJobId}/status GET Query data Job status |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.1 Create data job | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.1.1 Operation definition | The API Consumer uses Create data job operation to create the job for data request or subscription. A data job can be either for data request or data subscription. An API Producer supporting the Data access API shall support at least one type of the services, data request (one time delivery mode) or data subscription (continuous delivery mode). NOTE: The mean for communicating the service support capabilities with API Consumers is not specified in the present document. The operations are based on HTTP POST. {apiRoot}/data-access/<apiVersion>/ /data-jobs /{dataJobId} /status ETSI ETSI TS 104 231 V8.0.0 (2026-03) 57 Figure 7.3.4.1.1-1: Create data job operation The service operation is as follows: 1) The API Consumer shall send an HTTP POST request to the API Producer. The target URI shall identify the resource (…/data-jobs) under which the new data job is to be created. The message content shall carry a DataJobInfo. 2) The API Producer shall return the HTTP POST response. On success, "201 Created" shall be returned. The Location header shall be present and shall carry the URI of the new data job resource with dataJobId assigned by the service producer. The message content shall carry a DataJobInfo representing the created data job. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.1.2 Referenced procedures | 7.3.4.1.2.1 Request data procedure The Create data job operation illustrated in Figure 7.3.4.1.1-1 is based on the Request data procedure defined for the Data request service in R1GAP [5]. 7.3.4.1.2.2 Subscribe data procedure The Create data job operation illustrated in Figure 7.3.4.1.1-1 is based on the Subscribe data procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.2 Cancel data job | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.2.1 Operation definition | The API Consumer uses Cancel data job operation to cancel a data job. The operations are based on HTTP DELETE. Figure 7.3.4.2.1-1: Cancel data job operation The service operation is as follows: 1) The API Consumer shall send an HTTP DELETE request to API Producer. The target URI shall identify the resource (…/data-jobs/{dataJobId}). ETSI ETSI TS 104 231 V8.0.0 (2026-03) 58 2) The API Producer shall return the HTTP DELETE response. On success, "204 No Content" shall be returned. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.2.2 Referenced procedures | 7.3.4.2.2.1 Cancel data request procedure The Cancel data job operation illustrated in Figure 7.3.4.2.1-1 is based on the cancel data request procedure defined for the Data request service in R1GAP [5]. 7.3.4.2.2.2 Unsubscribe data procedure The Cancel data job operation illustrated in Figure 7.3.4.2.1-1 is based on the Unsubscribe data procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.3 Notify data availability | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.3.1 Operation definition | The API Producer uses this operation to notify data availability related to a data subscription. The operation is based on HTTP POST. Figure 7.3.4.3.1-1: Notify data availability operation The service operation is as follows: 1) The API Producer shall send an HTTP POST request to API Consumer. The target URI (dataAvailabilityNotificationUri) identifies the address where to send the notifications. The message content shall carry a DataAvailabilityNotification. 2) The API Consumer shall return the HTTP POST response. On success, "204 No Content" shall be returned. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.3.2 Referenced procedures | 7.3.4.3.2.1 Notify data availability procedure The Notify data job availability operation illustrated in Figure 7.3.4.3.1-1 is based on the Notify data availability procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.4 Update data job | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.4.1 Operation definition | The API Consumer uses this operation to update the created job for data subscription. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 59 The operation to update a data job is based on HTTP PUT. Figure 7.3.4.4.1-1: Update data job operation The service operation is as follows: 1) The API Consumer shall send an HTTP PUT request to the API Producer. The target URI shall identify the resource (…/data-jobs/{dataJobId}). The message content shall carry an update DataJobInfo structure. The API Producer shall process the HTTP PUT message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP response. On success, "200 OK" shall be returned. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. 3) The API Producer shall reject the update data job with "405 Method Not Allowed" if the dataJobId in the target URI is associated with delivery mode "ONE_TIME". NOTE: Updating the Data Job can introduce discontinuities in the produced data that are specific to the DME type and/or Data Producer. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.4.2 Referenced procedures | 7.3.4.3.2.1 Update data job procedure The Update data job operation illustrated in Figure 7.3.4.4.1-1 is based on the Update data subscription procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.5 Query data job | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.5.1 Operation definition | The API Consumer uses this operation to query the created job. The operation to query the data job is based on HTTP GET. Figure 7.3.4.5.1-1: Query data job operation The service operation is as follows: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 60 1) The API Consumer shall send an HTTP GET request to the API Producer. The target URI shall identify the resource (……/data-jobs/{dataJobId}). The message content shall be empty. The API producer shall process the HTTP GET message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP response. On success, "200 OK" shall be returned. The message content shall carry the queried data job information. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.5.2 Referenced procedures | 7.3.4.5.2.1 Query data job procedure The Query data job operation illustrated in Figure 7.3.4.5.1-1 is based on the Query data subscription procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.6 Query data job status | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.6.1 Operation definition | The API Consumer uses this operation to query the data job status. The operation to query the data job is based on HTTP GET. Figure 7.3.4.6.1-1: Query data job status operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer. The target URI shall identify the resource (……/data-jobs/{dataJobId}/status). The message content shall be empty. The API producer shall process the HTTP GET message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP response. On success, "200 OK" shall be returned. The message content shall carry the queried data job status information. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.6.2 Referenced procedures | 7.3.4.6.2.1 Query data job procedure The Query data job status operation illustrated in Figure 7.3.4.6.1-1 is based on the Query data subscription status procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.7 Query data job identifiers | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.7.1 Operation definition | The API Consumer uses Query data job identifiers operation to get the data job identifiers for all the jobs that are created for the specific API consumer. A data job can be either for data request or data subscription. The operations are based on HTTP GET. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 61 Figure 7.3.4.7.1-1: Query data job operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer. The target URI shall identify the resource (……/data-jobs/). The message content shall be empty. The API producer shall process the HTTP GET message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP response. On success, "200 OK" shall be returned. The message content shall carry an array of data job identifiers (dataJobId) created by the API Consumer. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.4.7.2 Referenced procedures | 7.3.4.7.2.1 Query data job identifiers procedure The Query data job identifiers operation illustrated in Figure 7.3.4.7.1-1 is based on the Query data subscription procedure defined for the Data subscription service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.1 Overview | This clause defines the resources for the Data access API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.2 Resource: "All data jobs" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.2.1 Description | The resource All data jobs represents all data jobs created by a particular consumer. Only the methods defined in clause 7.3.5.2.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.2.2 Resource Definition | Resource URI: {apiRoot}/data-access/<apiVersion>/data-jobs The resource URI variables supported by the resource are defined in Table 7.3.5.2.2-1. Table 7.3.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 7.3.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 62 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.2.3 Resource Standard Methods | 7.3.5.2.3.1 POST This method shall support the request data structure specified in Table 7.3.5.2.3.1-1, and the response data structure and response code specified in Table 7.3.5.2.3.1-2. Table 7.3.5.2.3.1-1: Data structures supported by the POST request body on this resource Data Type P Cardinality Description DataJobInfo M 1 Provides information for the data job to be created. Table 7.3.5.2.3.1-2: Data structures supported by the POST response body on this resource Data Type P Cardinality Response codes Description DataJobInfo M 1 201 Created The operation was successful. The message content of the POST response contains a DataJobInfo representing the created resource. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. Table 7.3.5.2.3.1-3: Headers supported by the 201-response code this resource Name Data type P Cardinality Description Location String M 1 Contains the URI of the newly created resource as defined in clause 7.3.5.2.2. 7.3.5.2.3.2 GET This method shall support the request data structure specified in Table 7.3.5.2.3.2-1 and the response data structure and response code specified in Table 7.3.5.2.3.2-2. Table 7.3.5.2.3.2-1: Data structure supported by the GET request body on this resource Data type P Cardinality Description N/A There is no object in the message content of a GET request. Table 7.3.5.2.3.2-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description array(dataJobId) M 0..N 200 OK All data job identifiers. ProblemDetails O 0..1 4xx/5xx Detailed problem description. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.2.4 Resource Custom Operations | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 63 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.3 Resource: "Individual data job" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.3.1 Description | The resource Individual data job represents an individual data job for a data request or data subscription. Only the methods defined in clause 7.3.5.3.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.3.2 Resource Definition | Resource URI: {apiRoot}/data-access/<apiVersion>/data-jobs/{dataJobId} The resource URI variables supported by the resource are defined in Table 7.3.5.3.2-1. Table 7.3.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 7.3.2. dataJobId The data job identifier assigned by the Service Producer. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.3.3 Resource Standard Methods | 7.3.5.3.3.1 DELETE This method shall support the request data structure specified in Table 7.3.5.3.3.1-1 and the response data structure and response code specified in Table 7.3.5.3.3.1-2. Table 7.3.5.3.3.1-1: Data structures supported by the DELETE request body on this resource Data type P Cardinality Description N/A There is no object in the message content of a DELETE request. Table 7.3.5.3.3.1-2: Data structures supported by the DELETE response body on this resource Data type P Cardinality Response codes Description N/A 204 No content The operation was successful. The data request has been cancelled. ProblemD etails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. 7.3.5.3.3.2 PUT This method shall support the request data structure specified in Table 7.3.5.3.3.2-1 and the response data structure and response code specified in Table 7.3.5.3.3.2-2. Table 7.3.5.3.3.2-1: Data structure supported by the PUT request body on this resource Data type P Cardinality Description DataJobInfo M 1 Provides update data job information. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 64 Table 7.3.5.3.3.2-2: Data structure supported by the PUT response body on this resource Data type P Cardinality Response code Description DataJobInfo M 1 200 OK The operation was successful. Data job information updated successfully. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. 7.3.5.3.3.3 GET This method shall support the request data structure specified in Table 7.3.5.3.3.3-1 and the response data structure and response code specified in Table 7.3.5.3.3.3-2. Table 7.3.5.3.3.3-1: Data structure supported by the GET request body on this resource Data type P Cardinality Description N/A There is no object in the message content of a GET request. Table 7.3.5.3.3.3-2: Data structure supported by the GET response body on this resource Data type P Cardinality Response code Description DataJobInfo M 1 200 OK The operation was successful. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.3.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.4 Resource: "Individual data job status" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.4.1 Description | The resource Individual data job status represents an individual data job status for a data request or data subscription. Only the methods defined in clause 7.3.5.4.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.4.2 Resource Definition | Resource URI: {apiRoot}/data-access/<apiVersion>/data-jobs/{dataJobId}/status The resource URI variables supported by the resource are defined in Table 7.3.5.4.2-1. Table 7.3.5.4.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 7.3.2. dataJobId The data job identifier assigned by the Service Producer. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 65 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.4.3 Resource Standard Methods | 7.3.5.4.3.1 GET This method shall support the request data structure specified in Table 7.3.5.4.3-1 and the response data structure and response code specified in Table 7.3.5.4.3-2. Table 7.3.5.4.3-1: Data structure supported by the GET request body on this resource Data type P Cardinality Description N/A There is no object in the message content of a GET request. Table 7.3.5.4.3-2: Data structure supported by the GET response body on this resource Data type P Cardinality Response code Description DataJobS atatusInfo M 1 200 OK The operation was successful. ProblemD etails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.5.4.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.7 Notifications | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.7.1 Notify data availability | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.7.1.1 Description | The notification informs the receiver about the availability of data for a data subscription and provides details about how to access them. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.7.1.2 Resource Definition | The Resource URI is a callback URI provided when creating a data job for data subscription. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.7.1.3 Resource Standard Methods | 7.3.7.1.3.1 POST This method shall support the request data structures specified in Table 7.3.7.1.3.1-1 and the response data structure and response codes specified in Table 7.3.7.1.3.1-2. Table 7.3.7.1.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description DataAvailabilityNotification M 1 Notify data availability ETSI ETSI TS 104 231 V8.0.0 (2026-03) 66 Table 7.3.7.1.3.1-2: Data structures supported by the HTTP POST response body on this resource Data type P Cardinality Response codes Description N/A 204 No content Confirmation of received notification ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.1 Overview | The following clauses define the data type and attributes to be used in the resource representation. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.2 Data type: DataJobInfo | The DataJobInfo contains the attributes defined in Table 7.3.8.1.2-1. Table 7.3.8.1.2-1: Definition of type DataJobInfo Attribute Name Data type P Cardinality Description dataDeliveryMode DataDeliveryMode M 1 See clause 7.3.8.2.3.1. dmeTypeId DmeTypeId M 1 See clause B.4.2. productionJobDefinition object M 1 Job description based on the DME type specific dataProductionSchema. dataDeliveryMethod DataDeliveryMethod M 1 See clause B.4.3.1. dataDeliverySchemaId string M 1 A delivery schema identifier provided by a Data Producer during the data registration procedure. pullDeliveryDetailsHttp PullDeliveryDetailsHttp C 0..1 See clause 7.3.8.1.3 (see note 1). dataAvailabilityNotificationUri Uri C 0..1 Callback URI for data availability notifications (see note 2). pushDeliveryDetailsHttp PushDeliveryDetailsHttp C 0..1 See clause 7.3.8.1.4 (see note 3). streamingConfigurationKafka StreamingConfigurationKafka C 0..1 See clause 7.3.8.1.6 (see note 4). dataJobInfoStatus ProcessMonitor C 0..1 ProcessMonitor datatype is specified in ETSI TS 128 622 [21] clause 4.3.43 (see note 5). NOTE 1: If dataDeliveryMethod is PULL_HTTP and dataDeliveryMode is ONE_TIME, the pullDeliveryDetailsHttp attribute shall be present in the Create data job response. NOTE 2: If dataDeliveryMethod is PULL_HTTP, and dataDeliveryMode is CONTINOUS, the dataAvailabilityNotificationUri attribute shall be present in the Create data job request and Create data job response. NOTE 3: If dataDeliveryMethod is PUSH_HTTP, the pushDeliveryDetailsHttp attribute shall be present in the Create data job request and Create data job response. NOTE 4: If dataDeliveryMethod is STREAMING_KAFKA, the streamingConfigurationKafka attribute shall be present in the Create data job request sent by the DME as API Consumer and in the Create data job response sent by the DME as API Producer. If the streamingConfigurationKafka attribute is present in the Create data job request, it shall be present in the corresponding Create data job response. NOTE 5: When API Consumer requesting the datajob, the dataJobInfoStatus shall not present in the request. When API Producer creating a data job the response shall include the DataJobInfo with dataJobInfoStatus. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.3 Data type: PullDeliveryDetailsHttp | The PullDeliveryDetailsHttp data type signals how to pull data using the HTTP protocol. It contains the attributes defined in Table 7.3.8.1.3-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 67 Table 7.3.8.1.3-1: Definition of type PullDeliveryDetailsHttp Attribute Name Data type P Cardinality Description dataPullUri Uri M 1 URI which data can be pulled from. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.4 Data type: PushDeliveryDetailsHttp | The PushDeliveryDetailsHttp data type signals how to push data using the HTTP protocol. It contains the attributes defined in Table 7.3.8.1.4-1. Table 7.3.8.1.4-1: Definition of type PushDeliveryDetailsHttp Attribute Name Data type P Cardinality Description dataPushUri Uri M 1 URI to which data can be pushed. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.5 Data type: DataAvailabilityNotification | The DataAvailabilityNotification contains the attributes defined in Table 7.3.8.1.5-1. Table 7.3.8.1.5-1: Definition of type DataAvailabilityNotification Attribute Name Data type P Cardinality Description dataJobId string M 1 Data job identifier. pullDeliveryDetailsHttp PullDeliveryDetailsHttp C 0..1 If the dataDeliveryMechanism attribute of the data job identified by the dataJobId attribute is PULL_HTTP, this attribute shall be included. Otherwise, it shall be absent. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.6 Data type: StreamingConfigurationKafka | The StreamingConfigurationKafka data type signals a data streaming configuration for the Kafka protocol. It contains the attributes defined in Table 7.3.8.1.6-1. Table 7.3.8.1.6-1: Definition of type StreamingConfigurationKafka Attribute Name Data type P Cardinality Description topicName string M 1 Name of the Kafka topic. kafkaBootstrapServers array (ServerAddressWithPort) M 1.. N See clause 7.3.8.1.7. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.1.7 Data type: ServerAddressWithPort | The ServerAddressWithPort contains the attributes defined in Table 7.3.8.1.7-1. Table 7.3.8.1.7-1: Definition of type ServerAddressWithPort Attribute Name Data type P Cardinality Description hostname string M 1 hostname shall follow DNS naming convention as defined in IETF RFC 1035 [19]. portAddress integer M 1 Port address, e.g. 9092. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 68 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.2.1 Introduction | This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.2.2 Simple data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.2.3 Enumerations | 7.3.8.2.3.1 Enumeration: DataDeliveryMode This indicates whether the data instance is created in a one-time data delivery (data request) or continuously (data subscription). Table 7.3.8.2.3.1-1: Enumeration type of DataDeliveryMode Enumerations Value Description ONE_TIME indicate the data job to be created is for on-time data delivery, i.e. for data request. CONTINUOUS indicate the data job to be created is for continuous data delivery, i.e. for data subscription. 7.3.8.2.3.2 Void |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.8.4 Service-specific registration information | The following structure defines the content of the "serviceCapabilities" attribute in the "ServiceProperties" data type (see clause B.3.4.2) for registration and discovery of this service. Table 7.3.8.4-1: Definition of the service-specific registration information Attribute Name Data type P Cardinality Description supportedDataDeliveryModes array(DataDeliveryMode) M 1..N Indicates whether one-time or continuous data delivery, or both, are supported by the service. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.9.1 General | For the Data access API, HTTP error responses shall be supported as specified in ETSI TS 129 501) [1]. Protocol errors and application errors specified in ETSI TS 129 500 [2], Table 5.2.7.2-1, shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in ETSI TS 129 500 [2], Table 5.2.7.1-1. In addition, the requirements in the following clauses are applicable for the Data access API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.9.2 Protocol Errors | No specific protocol errors are defined in the present document. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 69 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.3.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4 HTTP based Push data API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.1 Introduction | This API enables the API Producer to push data to the API Consumer based on the Push data service procedures defined in R1GAP [5]. The API definition applies to both scenarios when rApp is the Service Consumer and when DME is the Service Consumer, respectively. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.2 API version | For the Push data API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 0 and the PATCH version field shall be 0 (see ETSI TS 129 501 [1] for a definition of the version fields). |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.3 Resource structure and methods | The resource URI is a callback URI provided when creating a data job or data offer. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.4.1 Push data | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.4.1.1 Operation definition | The API Producer uses Push data operation to push data payload to the API Consumer. The operation is based on HTTP POST. Figure 7.4.4.1.1-1: Push data operation The service operation is as follows: 1) The API Producer shall send an HTTP POST request to the API Consumer. The target URI (dataPushUri) identifies the destination for pushing data to. The message content shall carry the data payload. The Content- Type header shall be present and set to the exact media type of the data payload. 2) The API Consumer shall return the HTTP POST response. On success, "204 No Content" shall be returned. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 70 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.4.1.2 Referenced procedures | 7.4.4.1.2.1 Push data procedure The Push data operation illustrated in Figure 7.4.4.1.1-1 is based on the Push data procedure defined for the Push data service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.5.1 Overview | This clause defines the resources for the Push data API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.5.2 Resource: "Push delivery URI" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.5.2.1 Description | The resource represents the destination for pushing data to. 7.4.5.2.2 Resource Definition The resource URI is a callback URI provided in the "PushDeliveryDetailsHttp" data structure when creating a data job for data subscription or a data offer. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.