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 DataJob... |
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 ... |
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 ... |
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 iden... |
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 o... |
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 D... |
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 descri... |
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 U... |
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 dataDeliver... |
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 to... |
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 ad... |
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-ti... |
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 sup... |
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... |
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 desti... |
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... |
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 ET... |
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 desti... |
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 ... |
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 HTT... |
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 ... |
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 sh... |
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 (…/o... |
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 ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.