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... |
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 t... |
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... |
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 s... |
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 ... |
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.... |
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 co... |
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 i... |
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 sho... |
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 sh... |
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 th... |
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(ApiEndpointInf... |
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 structu... |
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 AP... |
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.... |
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 Pro... |
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 Consum... |
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.