hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7 Data management and exposure services | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1 Data registration API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.1 Introduction | This API enables the API Consumer to register DME type production capabilities based on the data registration service procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.2 API version | For the data registration 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". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.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 "dataregistration". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 7.1.5. Figure 7.1.3-1 shows the overall resource URI structure defined for the data registration API. Figure 7.1.3-1: Resource URI structure of the Data registration API Table 7.1.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. {apiRoot}/data-registration/<apiVersion> /production-capabilities /{registrationId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 42 Table 7.1.3-1: Resource and methods overview of the Data registration API Resource name Resource URI HTTP method Service Operation Registered DME type production capabilities …/production- capabilities POST Register DME type Individual registered DME type production capability …/production-capabilities/ {registrationId} DELETE Deregister DME type PUT Update DME type GET Query DME type |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.1 Register DME type | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.1.1 Operation definition | The API Consumer uses this operation to register DME type production capabilities. The operation to register the capability to produce a DME type is based on HTTP POST. Figure 7.1.4.1.1-1: Register DME type 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 (…/production-capabilities) under which the new registration is requested to be created. The message content shall carry a DmeTypeRelatedCapabilities structure. 2) The API Producer shall generate the registration identifier and construct the URI for the created resource. 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 registration resource. The message content shall carry a DmeTypeRelatedCapabilities structure that represents the new resource. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.1.2 Referenced procedures | 7.1.4.1.2.1 Register DME type procedure The Register DME type operation illustrated in Figure 7.1.4.1.1-1 is based on the Register DME type procedure defined for the Data registration service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.2 Deregister DME type | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.2.1 Operation definition | The API Consumer uses this operation to deregister DME type production capabilities. The operation to deregister the capability to produce a DME type is based on HTTP DELETE. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 43 Figure 7.1.4.2.1-1: Deregister DME type 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 to be deleted (…/production-capabilities/{registrationId}). 2) The API Producer shall return the HTTP DELETE response. On success, "204 No Content" shall be returned and the response message content shall be empty. On failure, the appropriate error code shall be returned, and the message response content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.2.2 Referenced procedures | 7.1.4.2.2.1 Deregister DME type procedure The Deregister DME type operation illustrated in Figure 7.1.4.2.1-1 is based on the Deregister DME type procedure defined for the Data registration service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.1.4.3 Update DME type | |
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 Consumer shall send an HTTP PUT request to the API Producer. The target URI shall identify the resource (…/production-capabilities/{registrationId}). The message content shall carry an updated DmeTypeRelatedCapabilities 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. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 44 7.1.4.3.2 Referenced procedures 7.1.4.3.2.1 Update DME type procedure The Update DME type operation illustrated in Figure 7.1.4.4.1-1 is based on the Update DME type procedure defined for the Data registration service in R1GAP [5]. |
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 follows: 1) The API Consumer shall send an HTTP GET request to the API Producer. The target URI shall identify the resource (…/production-capabilities/{registrationId}). 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 production capability information. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
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 this resource Data Type P Cardinality Description DmeTypeRelatedCapabilities M 1 Registered capabilities of a Data Producer related to a DME type Table 7.1.5.2.3.1-2: Data structures supported by the POST response body on this resource Data Type P Cardinality Response codes Description DmeTypeRelatedCapabilities M 1 201 Created The operation was successful, and the message content of the POST response contains a DmeTypeProdCapRegistration structure as a representation of the created resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. Table 7.1.5.2.3.1-3: Headers supported by the 201 Response Code on this resource Name Data type P Cardinality Description Location string M 1 Contains the URI of the newly created "Individual registered DME type production capability" resource, as defined in clause 7.1.5.3, with the registrationId in the URI. |
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 registrationId The related DME type production capabilities registration identifier |
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 A DELETE request has no message content Table 7.1.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 DME type production capability registration associated with the registrationId has been deleted successfully. The message content shall be empty. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. 7.1.5.3.3.2 PUT This method shall support the request data structure specified in Table 7.1.5.3.3.2-1 and the response data structure and response code specified in Table 7.1.5.3.3.2-2. Table 7.1.5.3.3.2-1: Data structures supported by the PUT request body on this resource Data Type P Cardinality Description DmeTypeRelatedCapabilities M 1 Updated DME type production capability information Table 7.1.5.3.3.2-2: Data structures supported by the PUT response body on this resource Data Type P Cardinality Response codes Description DmeTypeRelatedCapabilities M 1 200 OK The DME type production capability registration associated with the registrationId has been updated successfully and the response contain the DmeTypeProdCapRegistration as a representation of the updated resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 47 7.1.5.3.3.3 GET This method shall support the request data structure specified in Table 7.1.5.3.3.3-1 and the response data structure and response code specified in Table 7.1.5.3.3.3-2. Table 7.1.5.3.3.3-1: Data structures supported by the GET request body on this resource Data Type P Cardinality Description N/A A GET request has no message content Table 7.1.5.3.3.3-2: Data structures supported by the GET response body on this resource Data Type P Cardinality Response codes Description DmeTypeRelatedCapabilities M 1 200 OK The DME type production capability registration associated with the registrationId has been queried successfully and the response contain the DmeTypeProdCapRegistration as a representation of the query resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. |
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.1.2-1: Definition of type DmeTypeRelatedCapabilities Attribute Name Data type P Cardinality Description dmeTypeDefinition DmeTypeDefinition M 1 Information of the DME type. dataAccessEndpoint Interface Description O 0..1 Endpoint to which to send the data request or data subscription for data instances of this DME type. This attribute shall be provided in data registration requests and responses related to data registration. It may be provided in data discovery responses. If this information is not provided, the data access endpoint can be discovered by means outside the scope of the of the DME services. dataDeliveryMode array(DataDeliveryMode) M 1..N Supported modes for data delivery for this DME type, i.e. one time (data request) or continuous (data subscription) or both. constraints object O 0..1 When this data structure is used for registration, this attribute represents producer constraints related to the DME type based on the dataProductionSchema. When this data structure is used for discovery, this attribute represents constraints applicable to the consumption of data instances of this DME type based on the dataProductionSchema. |
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. metadata Metadata M 1 Metadata that can be used in discovering the DME type. dataProductionSchema object O 0..1 Schema that defines the information necessary to formulate a data request or data subscription. If this attribute is not present, the schema is assumed to be known from the DME type definition that is referenced by dmeTypeId (see note). dataDeliverySchemas array (DeliverySchema) M 1.. N List of delivery schemas supported by the producer for the DME type being registered (see note). dataDeliveryMechanism s array (DataDeliveryMechanism) M 1.. N See clause B.4.4.2. NOTE: The schemas for data production and data delivery are DME type specific and are not defined in the present document. |
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 Defines the category of the DME type e.g. PM counters. rat array(string) O 0.. N Defines the radio access technology e.g. 5G. |
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 each supported schema type a delivery schema identifier is assigned. A Data Consumer uses this attribute while creating a data job and request to deliver the data using specific schema type which is identified by this attribute. schema string O 0..1 The schema serialized to string. If this attribute is not present, the schema is assumed to be known from the DME type definition that is referenced by the DME type identifier. |
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 shows the overall resource URI structure defined for the data discovery API. Figure 7.2.3-1: Resource URI structure of the Data discovery API Table 7.2.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. {apiRoot}/data-discovery/<apiVersion> /dme-types /{dmeTypeId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 51 Table 7.2.3-1: Resources and methods overview of the Data discovery API Resource name Resource URI HTTP method Service Operation All DME types …/dme-types GET Discover DME types Individual DME types …/dme-types/{dmeTypeId} GET Query capabilities related to a DME type |
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 identify the resource (…/dme-types) and may also contain query parameters to discover the available DME types. 2) The API Producer shall return the HTTP GET response. On success, "200 OK" shall be returned and the message content shall carry an array of Dme type related capabilities. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
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 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 (…/dme-types/{dmeTypeId}) and the message content shall be empty. 2) The API Producer shall return the HTTP GET response. On success, "200 OK" shall be returned and the message content shall carry capability information related to the DME type identified by {dmeTypeId}. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
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 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]. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.