hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.5.2.3 Resource Standard Methods | 7.4.5.2.3.1 POST The method shall support carrying the data payload in the request body. The format of the data payload and Content- Type header are determined by the data message schema. The method shall support the response data structures and response codes specified in Table 7.4.5.2.3.1-1. Table 7.4.5.2.3.1-1: 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 data delivery. 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.4.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.7 Notifications | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 71 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.8.1 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.8.2 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.8.4 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.9.1 General | For the Push data 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 Push data API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.4.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5 HTTP based Pull data API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.1 Introduction | This API enables the API Consumer to pull data from the API Producer based on the Pull 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.5.2 API version | For the Pull 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.5.3 Resource structure and methods | The resource URI is a target URI provided when creating a data job for data request or a data offer, or when notifying the data availability for data subscription. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 72 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.4.1 Pull data | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.4.1.1 Operation definition | The API Consumer uses Pull data operation to pull data payload from the API Producer. The operation is based on HTTP GET. Figure 7.5.4.1.1-1: Pull data operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer. The target URI (dataPullUri) identifies the destination for pulling data from. 2) The API Producer shall return the HTTP GET response. On success, "200 OK" shall be returned, 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. 3) If the data payload is not ready yet, "202 Accepted" shall be returned, with the Retry-After header optionally provided to indicate how long the API Consumer should wait before making a follow-up request. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.4.1.2 Referenced procedures | 7.5.4.1.2.1 Pull data procedure The Pull data operation illustrated in Figure 7.5.4.1.1-1 is based on the Retrieve data procedure defined for the Pull data service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5.1 Overview | This clause defines the resources for the Pull data API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5.2 Resource: "Pull delivery URI" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5.2.1 Description | The resource represents the destination for pulling data from. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 73 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5.2.2 Resource Definition | The resource URI is a target URI provided in the "PullDeliveryDetailsHttp" data structure when creating a data job for data request or a data offer, or when notifying the data availability for data subscription. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5.2.3 Resource Standard Methods | 7.5.5.2.3.1 GET This method shall support the request data structures specified in Table 7.5.5.2.3.1-1 the response data structures and response codes specified in Table 7.5.5.2.3.1-2 and the HTTP response headers as defined in Table 7.5.5.2.3.1-3. Table 7.5.5.2.3.1-1: Data structures supported by the HTTP GET request body on this resource Data type P Cardinality Description NA There is no object in the message content of a GET request. Table 7.5.5.2.3.1-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description N/A 200 OK Carry data payload in the response body. N/A 202 Accepted Data payload is not ready, retry later and the response body shall be empty. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. The method shall support carrying the data payload in the response body of the "200OK" response. The format of the data payload and Content-Type header are determined by the data message schema. Table 7.5.5.2.3.1-3: Headers supported by the 202 Response code on this resource Name Data type P Cardinality Description Retry-After string O 0..1 Indicates to the API Consumer the length of the time interval to wait until sending the next request, or the point in time when such request should earliest be sent. The format is defined in IETF RFC 9110 [25]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.8.1 Structured data types | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 74 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.8.2 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.8.4 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9.1 General | For the Pull data API, HTTP error responses shall be supported as specified in clause 4.8 of 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 Pull data API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6 Data offer API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.1 Introduction | This API enables an API Consumer to trigger the API Producer to collect a data instance produced by the API Consumer and to store it for later consumption, based on the procedures for managing a data offer defined in R1GAP [5]. The API definition applies to the scenario when a Data Producer is the Service Consumer and the DME framework is the Service Producer. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.2 API version | For the Data offer 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). Consequently, the <apiVersion> URI path segment shall be set to "v1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.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-offer". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 7.6.5. Figure 7.6.3-1 shows the overall resource URI structure defined for the Data offer API. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 75 Figure 7.6.3-1: Resource URI structure of the Data offer API Table 7.6.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 7.6.3-1: Resource and methods overview of the Data offer API Resource name Resource URI HTTP method Service Operation All data offers …/offers POST Create an individual data offer Individual data offer …/offers/{dataOfferId} DELETE Cancel data offer |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.1 Create data offer | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.1.1 Operation definition | The API Consumer uses the Create data offer operation to create a data offer. The operation is based on HTTP POST. Figure 7.6.4.1.1-1: Create data offer 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 (…/offers) under which the new data offer is to be created. The message content shall carry a DataOfferInfo structure. 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 offer resource with dataOfferId assigned by the API producer. The message content shall carry a DataOfferInfo representing the created data offer. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. {apiRoot}/data-offer/<apiVersion>/ /offers /{dataOfferId} {apiRoot}/data-offer/<apiVersion> /offers /{dataOfferId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 76 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.1.2 Referenced procedures | 7.6.4.1.2.1 Create data offer procedure The Create data offer operation illustrated in Figure 7.6.4.1.1-1 is based on the Create data offer procedure defined for the Data offer service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.2 Cancel data offer | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.2.1 Operation definition | The API Consumer uses the Cancel data offer operation to cancel a data offer, i.e. to indicate to the API Producer that it has stopped the delivery of data for the data offer. The operation is based on HTTP DELETE. Figure 7.6.4.2.1-1: Cancel data offer operation The service operation is as follows: 1) The API Consumer shall send an HTTP DELETE request to the API Producer. The target URI shall identify the resource (…/offers/{dataOfferId}). 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. NOTE: For some data delivery methods, due to race conditions, residual produced data can arrive at the API Producer even after having received the HTTP DELETE request. The API Producer should be robust against this situation. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.