hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.3.1 Operation definition | The API Consumer uses this operation to update the registration of production capabilities related to a DME type. The operation to update the registration of production capability related to a DME type is based on HTTP PUT. Figure 7.1.4.3.1-1: Update DME type operation The service operation is as follows: 1) The API Co... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.4 Query DME type | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.4.1 Operation definition | The API Consumer uses this operation to query the registration of production capability information on a specific DME type that it has previously registered. The operation to query the registration of production capability is based on HTTP GET. Figure 7.1.4.4.1-1: Query DME type operation The service operation is as fo... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.4.2 Referenced procedures | 7.1.4.4.2.1 Query DME type procedure The Query DME type operation illustrated in Figure 7.1.4.4.1-1 is based on the Query DME type procedure defined for the Data registration service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.1 Overview | The following clause defines the resources for the Data registration API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.2 Resource: "Registered DME type production capabilities" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.2.1 Description | The resource represents the registered capabilities of an API Consumer to produce DME types. Only the methods defined in clause 7.1.5.2.3 shall be supported by this resource. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 45 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.2.2 Resource Definition | Resource URI: {apiRoot}/data-registration/<apiVersion>/production-capabilities The resource URI variables supported by the resource are defined in Table 7.1.5.2.2-1. Table 7.1.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2 apiVersion See clause 7.1.2 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.2.3 Resource Standard Methods | 7.1.5.2.3.1 POST This method shall support the request data structure specified in Table 7.1.5.2.3.1-1 and the response data structure and response code specified in Table 7.1.5.2.3.1-2, and the HTTP headers specified in Table 7.1.5.2.3.1-3. Table 7.1.5.2.3.1-1: Data structures supported by the POST request body on thi... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.3 Resource: "Individual registered DME type production capability" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.3.1 Description | The resource represents an individual registered DME type production capability. Only the methods defined in clause 7.1.5.3.3 shall be supported by this resource. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 46 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.3.2 Resource Definition | Resource URI: {apiRoot}/data-registrations/<apiVersion>/production-capabilities/{registrationId} The resource URI variables supported by the resource are defined in Table 7.1.5.3.2-1. Table 7.1.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2 apiVersion See clause 7.1.2 registrati... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.5.3.3 Resource Standard Methods | 7.1.5.3.3.1 DELETE This method shall support the request data structure specified in Table 7.1.5.3.3.1-1 and the response data structure and response code specified in Table 7.1.5.3.3.1-2. Table 7.1.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.1.5.3.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.1.1 Overview | The following clauses define the structured data types and their attributes to be used by the service API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.1.2 Data type: DmeTypeRelatedCapabilities | The DmeTypeRelatedCapabilities data type represents capabilities of a data provider entity (such as Data Producer, SME functions) related to providing data instances of a DME type for collection or consumption. It contains the attributes defined in Table 7.1.8.1.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 48 Table 7.1.8... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.1.3 Data type: DmeTypeDefinition | The DmeTypeDefinition data type represents information about a DME type. It contains the attributes defined in Table 7.1.8.1.3-1. Table 7.1.8.1.3-1: Definition of type DmeTypeDefinition Attribute Name Data type P Cardinality Description dmeTypeId DmeTypeIdStruct M 1 The identifier of the DME type being registered. meta... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.1.4 Data type: Metadata | The Metadata data type contains the attributes defined in Table 7.1.8.1.4-1 and the set of metadata attributes may be extended by deployments. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 49 Table 7.1.8.1.4-1: Definition of type Metadata Attribute Name Data type P Cardinality Description dataCategory array(string) M 1.. N Def... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.1.5 Data type: DeliverySchema | The DeliverySchema data type contains the attributes defined in Table 7.1.8.1.5-1. Table 7.1.8.1.5-1: Definition of type DeliverySchema Attribute Name Data type P Cardinality Description type SchemaTypes M 1 Type of the schema. deliverySchemaId string M 1 A Data Producer may support one or more delivery schemas and for... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.2.1 Introduction | 7.1. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 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.1.8.2.2 Simple data types | No simple data types are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.2.3 Enumeration | 7.1.8.2.3.1 Enumeration: SchemaTypes Table 7.1.8.2.3.1-1: Enumeration SchemaTypes Enumeration value Description JSON_SCHEMA Following JSON Schema 2020-12 [14]. XML_SCHEMA Following XML Schema [16], [17], [18] and [i.1]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.8.4 Service-specific registration information | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 50 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.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 Registration API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2 Data discovery API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.1 Introduction | This API enables the API Consumer to discover the available DME types based on the data discovery service procedures defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.2 API version | For the data discovery 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". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.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 "datadiscovery". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 7.2.5. Figure 7.2.3-1... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4.1 Discover DME types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4.1.1 Operation definition | The API Consumer uses this operation to discover the available DME types. The operation to discover the DME types is based on HTTP GET. Figure 7.2.4.1.1-1: Discover DME types 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 ident... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4.1.2 Referenced procedures | 7.2.4.1.2.1 Discover DME types procedure The Discover DME types operation illustrated in Figure 7.2.4.1.1-1 is based on the Discover DME types procedure defined for the Data discovery service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4.2 Query DME type information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4.2.1 Operation definition | The API Consumer uses this operation to query for information about a specific DME type identified by a DME type identifier. The operation to query for information about a specific DME type is based on HTTP GET. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 52 Figure 7.2.4.2.1-1: Query DME type information operation The servic... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.4.2.2 Referenced procedures | 7.2.4.2.2.1 Query DME type information procedure The Query DME type operation illustrated in Figure 7.2.4.2.1-1 is based on the Query DME type information procedure defined for the Data discovery service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.1 Overview | The following clause defines the resources for the Data discovery API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.2 Resource: "All DME types" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.2.5.2.1 Description | The resource represents the available DME types. Only the methods defined in clause 7.2.5.2.3 shall be supported by this resource. |
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 th... |
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 claus... |
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 th... |
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 u... |
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 (... |
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... |
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... |
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 th... |
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 (dataAvail... |
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... |
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 ... |
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 ... |
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: Q... |
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" |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.