hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.1 Introduction | This API allows the API Consumer to perform service discovery based on the service discovery procedures defined in R1GAP [5]. The API is based on the CAPIF_Discover_Service_API as specified in ETSI TS 129 222 [9]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.2 API version | For the service discovery API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 2 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 | 6.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 for the CAPIF_Discovery_Service_API (see ETSI TS 129 222 [9], Figure 8.1.2.1-1 in clause 8.1.2). Table 6.2.3-1 lists the individual resources defined for the API and the applicable HTTP methods as defined in ETSI TS 129 222 [9], clause 8.1 of) and the associated service operations. Table 6.2.3-1: Resources and methods overview of the service discovery API Resource Name ETSI TS 129 222 [9] Resource URI ETSI TS 129 222 [9] HTTP method ETSI TS 129 222 [9] Service Operation All published service APIs .../allServiceAPIs GET Query service APIs |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.4.1 Query service APIs | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.4.1.1 Operation definition | The API Consumer uses the Query service APIs operation to discover service APIs information. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 31 The operation is based on HTTP GET as per Figure 6.2.4.1.1-1. The HTTP GET response contains information about all services that the API Consumer is authorized to access and that match the filtering criteria. Figure 6.2.4.1.1-1: Query service APIs operation This 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 (…/allServiceAPIs) and may also contain that includes the rApp identifier and optional filtering criteria. The API Producer shall process the service discovery details received in 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 GET response. On success "200 OK" shall be returned and the message content shall carry a list of service profiles that the API Consumer is authorized to access and that match the filtering criteria, if provided. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.4.1.2 Referenced procedures | 6.2.4.1.2.1 Discovery services procedure The Query service APIs operation illustrated in Figure 6.2.4.1.1-1 is based on the Discover services procedure as defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.5.1 Overview | This clause defines the resource for the Service discovery API based on ETSI TS 129 222 [9]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.5.2 Resource: "All published service APIs" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.5.2.0 Description | This resource is defined in ETSI TS 129 222 [9], clause 8.1 with the following URI: {apiRoot}/service-apis /<apiVersion>/allserviceapis In addition to the provisions in ETSI TS 129 222 [9], clause 8.1, the following shall apply: 1) In the GET method, the URI query parameters "api-name" and "api-version" are relevant in the context of the SME services and shall be supported by the API Producer to allow filtering the query by name and/or version of the service API. The API Consumer may provide these parameters. The following parameters are not applicable in the context of the SME services and therefore need not be supported: comm-type, protocol, aef-id, data-format, api-cat, preferred-aef-loc, supported-features, api-supported-features. 2) In the GET method, the URI query parameter "api-invoker-id" shall carry the rAppId of the rApp that performs the service discovery. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 32 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.5.2.1 Resource Standard Methods | 6.2.5.2.1.1 GET This method shall support the URI query parameters, response data structures and response codes specified in ETSI TS 129 222 [9], clause 8.1.2.2.3.1. 6.2.5.2.2 Resource Custom Operations None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.6 Custom operations without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.8 Data model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.8.1 General | The application data model is defined in ETSI TS 129 222 [9], clause 8.1.4, apply to this API. In addition, the adaptations specified in clause B.3 apply to this API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.8.2 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.8.3 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.8.4 Re-used data types | The re-used data types are defined in clause B.3. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.8.5 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.9.1 General | HTTP error handling is applicable for this API as specified in ETSI TS 129 222 [9], clause 7.7. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.9.2 Protocol Errors | Protocol error handling shall be supported as specified in ETSI TS 129 222 [9], clause 8.1.5.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.2.9.3 Application Errors | Application error handling shall be supported as specified in ETSI TS 129 222 [9], clause 8.2.5.3. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 33 6.3 Service events subscription API |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.1 Introduction | This API allows the API Consumer to subscribe to and unsubscribe from service event notifications as specified in R1GAP [5]. The API is based on the CAPIF_Events_API as specified in ETSI TS 129 222 [9]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.2 API version | For the service events subscription API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 2 and the PATCH version field shall be 0 (see ETSI TS 129 501 [1], clause 4.3.1.1, for a definition of the version fields). Consequently, the <apiVersion> URI part segment shall be set to "v1". 6.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 for the CAPIF_Events_API (see ETSI TS 129 222 [9], Figure 8.3.2.1-1 in clause 8.3.1). Table 6.3.3-1 lists the individual resources defined for the API and the applicable HTTP methods as defined in ETSI TS 129 222 [9], clause 8.3.1, and the associated service operations. Table 6.3.3-1: Resources and methods overview of the service subscription API Resource Name ETSI TS 129 222 [9] Resource URI ETSI TS 129 222 [9] HTTP method ETSI TS 129 222 [9] Service Operation CAPIF Events Subscriptions /{subscriberId}/subscriptions POST Subscribe service events Individual CAPIF Events Subscription /{subscriberId}/subscriptions/ {subscriptionId} DELETE Unsubscribe service events |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.1 Subscribe service events | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.1.1 Operation definition | The API Consumer uses the subscribe service events API operation to subscribe to service event notifications. The operation is based on HTTP POST. Figure 6.3.4.1.1-1: Subscribe service events APIs operation ETSI ETSI TS 104 231 V8.0.0 (2026-03) 34 This 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 (".../{subscriberId}/subscriptions/") under which the new subscription is requested to be created. The message content shall carry a EventSubscription structure. The API Producer shall process the request received in the HTTP POST message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return HTTP POST response. On success "201 Created" shall be returned. The "Location" HTTP header shall be present and shall carry the URI for the newly created resource i.e. subscription identifier. The message content shall carry a EventSubscription structure that represents the new resource. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.1.2 Referenced procedures | 6.3.4.1.2.1 Subscribe service availability The Subscribe service events operation illustrated in Figure 6.3.4.1.1-1 is based on the Subscribe service availability procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.2 Unsubscribe service events | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.2.1 Operation definition | The API Consumer uses the unsubscribe service events operation to unsubscribe from service event notifications. The operation is based on HTTP DELETE. Figure 6.3.4.2.1-1: Unsubscribe service events operation This 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 ("…/{subscriberId}/subscriptions/{subscriptionId}"). The message content shall be empty. The API Producer shall process the request received in the HTTP DELETE message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP DELETE response. On success "204 No Content" shall be returned. The message content shall be empty. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. 6.3.4.2.2 Referenced procedures 6.3.4.2.2.1 Unsubscribe service availability The Unsubscribe service events operation illustrated in Figure 6.3.4.3.1-1 is based on the Unsubscribe service availability procedure defined in R1GAP [5]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 35 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.3 Notification service API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.3.1 Operation definition | The API Producer sends notifications to all subscribed API Consumers. The operation is based on HTTP POST. Figure 6.3.4.3.1-1: Notification service API operation This service operation is as follows: 1) The API Producer shall send an HTTP POST request to the API Consumer. The target URI ("…/Eventnotification") shall contain the call back URI received in the subscription request to notify the generated events to all the subscribed API Consumers. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.4.3.2 Referenced procedures | 6.3.4.3.2.1 Notify service availability changes The Notification service API operation illustrated in Figure 6.3.4.3.1-1 is based on the Notify service availability changes procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.1 Overview | This clause defines the resource for the Service events subscription API based on ETSI TS 129 222 [9]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.2 Resource: "CAPIF Events Subscriptions" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.2.0 Description | This resource is defined in ETSI TS 129 222 [9], clause 8.3, with the following URI: {apiRoot}/capif-events/<apiVersion>/{subscriberId}/subscriptions This resource shall support the resource URI variables defined in ETSI TS 129 222 [9], Table 8.3.2.2.2-1. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.2.1 Resource Standard Methods | 6.3.5.2.1.1 POST This method shall support the URI query parameters, request data, response data structures and response codes specified in ETSI TS 129 222 [9], clause 8.3.2.2.3.1. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.2.2 Resource Custom Operations | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 36 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.3 Resource: "Individual CAPIF Events Subscription" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.3.0 Description | This resource is defined in ETSI TS 129 222 [9], clause 8.3, with the following URI: {apiRoot}/capif-events/<apiVersion>/{subscriberId}/subscriptions/{subscriptionId} This resource shall support the resource URI variables defined in ETSI TS 129 222 [9], Table 8.3.2.3.2-1. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.3.1 Resource Standard Methods | 6.3.5.3.1.1 DELETE This method shall support the URI query parameters, request data, response data structures and response codes specified in ETSI TS 129 222 [9], clause 8.3.2.3.3.1. 6.3.5.3.1.2 PUT This method shall support the URI query parameters, request data, response data structures and response codes specified in ETSI TS 129 222 [9], clause 8.3.2.3.3.2. 6.3.5.3.1.2 PATCH This method shall support the URI query parameters, request data, response data structures and response codes specified in ETSI TS 129 222 [9], clause 8.3.2.3.3.3. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.5.3.2 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.6 Custom operations without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.7 Notifications | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.7.1 General | The delivery of notification shall conform to ETSI TS 129 222 [9], clause 8.3.3.1. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.7.2 Event Notification | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.7.2.1 Description | Event Notifications is used by the API Producer to notify all the subscribed API Consumers. The API Consumers shall subscribe to Event Notifications via the Individual CAPIF Events Subscription resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.7.2.2 Notification definition | This method shall support the request data structures, URI query parameters and the response data structures as specified in ETSI TS 129 222 [9], clause 8.3.3.2.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 37 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.8.1 General | The application data model is defined in ETSI TS 129 222 [9], clause 8.3.4. In addition, the adaptations specified in clause B.3 of the present document and the data types listed in ETSI TS 129 222 [9], clause 7.2, also apply to this API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.8.2 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.8.3 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.8.4 Re-used data types | The re-used data types are defined in clause B.3. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.8.5 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.3.9 Error Handling | General error responses are defined in ETSI TS 129 222 [9], clause 7.7. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4 Bootstrap API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.1 Introduction | This API allows the API Consumer to discover the entry points into the Service management and exposure services and the related token endpoints as defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.2 API version | For the Bootstrap 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 | 6.4.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 "bootstrap". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 6.4.5. Figure 6.4.3-1 shows the overall resource URI structure defined for the bootstrap API. Figure 6.4.3-1: Resource URI structure of the Bootstrap API ETSI ETSI TS 104 231 V8.0.0 (2026-03) 38 Table 6.4.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 6.4.3-1: Resource and methods overview of the Bootstrap API Resource name Resource URI HTTP method Service Operation Bootstrap info …/bootstrap-info/ GET Query bootstrap information |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.4.1 Query bootstrap information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.4.1.1 Operation definition | The API Consumer uses this operation to retrieve bootstrap information. The operation to query bootstrap information based on HTTP GET. Figure 6.4.4.1.1-1: Query bootstrap 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 (…/bootstrap-info). The message content shall be empty. 2) The API Producer shall return the HTTP response. On success, "200 OK" shall be returned. The message content shall carry the BootstrapInformation. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.4.1.2 Referenced procedures | 6.4.4.1.2.1 Discover bootstrap procedure The Query bootstrap operation illustrated in Figure 6.4.4.1.1-1 is based on the Discover bootstrap procedure defined for the Service management and exposure services in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.5.1 Overview | The following clause defines the resources for the Bootstrap API. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 39 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.5.2 Resource: "Bootstrap info" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.5.2.1 Description | The resource represents the bootstrap information for service management and exposure services. Only the methods defined in clause 6.4.5.2.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.5.2.2 Resource Definition | Resource URI: {apiRoot}/bootstrap/<apiVersion>/bootstrap-info The resource URI variables supported by the resource is defined in Table 6.4.5.2.2-1. Table 6.4.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2 apiVersion See clause 6.4.2 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.5.2.3 Resource Standard Methods | 6.4.5.2.3.1 GET This method shall support the URI query parameters specified in Table 6.4.5.2.3.1-1, the request data structure specified in Table 6.4.5.2.3.1-2 and the response data structure and response code specified in Table 6.4.5.2.3.1-3. Table 6.4.5.2.3.1-1: URI query parameters supported by the GET method on this resource Name Data type P Cardinality Description Applicability N/A Table 6.4.5.2.3.1-2: 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 6.4.5.2.3.1-3: Data structures supported by the GET response body on this resource Data Type P Cardinality Response codes Description BootstrapInformation M 1 200 OK The bootstrap information has been queried successfully by the rApp and the response contains a BootstrapInformation structure 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 | 6.4.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.6 Custom operation without associated resources | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 40 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.1.1 Overview | The following clauses define the structured data types and their attributes to be used by the bootstrap API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.1.2 Data type: BootstrapInformation | The BootstrapInformation data type represents entry point information for the Service management and exposure services. It contains the attributes defined in Table 6.4.8.1.2-1. Table 6.4.8.1.2-1: Definition of type BootstrapInformation Attribute Name Data type P Cardinality Description apiEndpoints array(ApiEndpointInformation) M 1..N Information about the API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.1.3 Data type: ApiEndpointInformation | The ApiEndpointInformation data type represents entry point information for a single API. It contains the attributes defined in Table 6.4.8.1.3-1. Table 6.4.8.1.3-1: Definition of type ApiEndpointInformation Attribute Name Data type P Cardinality Description apiName string M 1 Name of API, as defined in the URI structure as <apiName>. The following values shall be supported: "service-apis" for discovery and "published-apis" for service registration tokenEndPoint InterfaceDescription C 0..1 InterfaceDescription as defined in clause B.3.5, Token endpoint shall be provided if the API requires authorization over OAuth2.0 apiEndPoint InterfaceDescription M 1 InterfaceDescription as defined in clause B.3.5, End point of the API |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.2 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.8.4 Service-specific registration information | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 41 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 6.4.9.1 General | In addition to the general provisions in clause 5.4.3, the requirements in the following clauses are applicable for Bootstrap API. |
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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.