hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.2.2 Referenced procedures | 7.6.4.2.2.1 Cancel data offer procedure The Cancel data offer operation illustrated in Figure 7.6.4.2.1-1 is based on the cancel data offer procedure defined for the Data offer service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.3 Notify data offer termination | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.3.1 Operation definition | The API Producer uses this operation to notify the API Consumer that it has stopped collecting the offered data. The API Consumer stops producing data. The operation is based on HTTP POST. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 77 Figure 7.6.4.3.1-1: Notify data offer termination The service operation is as follows: 1) ... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.3.2 Referenced procedures | 7.6.4.3.2.1 Notify data availability procedure The Notify data offer termination operation illustrated in Figure 7.6.4.3.1-1 is based on the Notify data offer termination procedure defined for the Data offer service in R1GAP [5]. 7.6.5 Resources |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.1 Overview | This clause defines the resources for the Data offer API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.2 Resource: "All data offers" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.2.1 Description | The resource All data offers represents all data offers created by a particular consumer. Only the methods defined in clause 7.6.5.2.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.2.2 Resource Definition | Resource URI: {apiRoot}/data-offer/<apiVersion>/offers The resource URI variables supported by the resource are defined in Table 7.6.5.2.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 78 Table 7.6.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.3. apiVersion See clause 7.6.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.2.3 Resource Standard Methods | 7.6.5.2.3.1 POST This method shall support the request data structure specified in Table 7.6.5.2.3.1-1, and the response data structure and response code specified in Table 7.6.5.2.3.1-2. Table 7.6.5.2.3.1-1: Data structures supported by the POST request body on all data jobs Data Type P Cardinality Description DataOff... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.3 Resource: "Individual data offer" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.3.1 Description | The resource Individual data offer represents an individual data offer. The methods defined in clause 7.6.5.3.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.3.2 Resource Definition | Resource URI: {apiRoot}/data-offer /<apiVersion>/offers/{dataOfferId} The resource URI variables supported by the resource is defined in Table 7.6.5.3.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 79 Table 7.6.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.3. apiVersion See clause 7.... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.3.3 Resource Standard Methods | 7.6.5.3.3.1 DELETE This method shall support the request data structure specified in Table 7.6.5.3.3.1-1 and the response data structure and response code specified in Table 7.6.5.3.3.1-2. Table 7.6.5.3.3.1-1: Data structure supported by the DELETE request body on this resource Data type P Cardinality Description N/A T... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.5.3.4 Resource Custom Operations | None. 7.6.6 Custom operation without associated resources None. 7.6.7 Notifications |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.7.1 Notify data offer termination | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.7.1.1 Description | The notification informs the Data Producer as API Consumer that the sender of the notification, i.e. the Api Producer, does not intend to collect the data instance related to the data offer from the Data Producer any longer. The Data Producer shall stop data production when receiving this notification. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.7.1.2 Resource Definition | The resource URI is a callback URI that has been provided when creating the related data offer. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 80 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.7.1.3 Resource Standard Methods | 7.6.7.1.3.1 POST This method shall support the request data structures specified in Table 7.6.7.1.3.1-1 and the response data structure and response codes specified in Table 7.6.7.1.3.1-2. Table 7.6.7.1.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description D... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.1.1 Overview | The following clauses define the data types and attributes to be used in the resource representation. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.1.2 Data type: DataOfferInfo | The DataOfferInfo contains the attributes defined in Table 7.6.8.1.2-1. Table 7.6.8.1.2-1: Definition of type DataOfferInfo Attribute Name Data type P Cardinality Description dataDeliveryMode DataDeliveryMode M 1 See clause 7.3.8.2.3.1 dmeTypeId DmeTypeId M 1 See clause B.4.2 productionJobDefinition object M 1 Job defi... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.1.3 Data type: DataOfferTerminationNotification | The DataOfferTerminationNotification contains the attributes defined in Table 7.6.8.1.3-1. Table 7.6.8.1.3-1: Definition of type DataOfferTerminationNotification Attribute Name Data type P Cardinality Description dataOfferId string M 1 Identifier of the data offer to be terminated. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.1.4 Data type: DataAvailabilityNotification | The DataAvailabilityNotification contains the attributes defined in Table 7.6.8.1.4-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 82 Table 7.6.8.1.4-1: Definition of type DataAvailabilityNotification Attribute Name Data type P Cardinality Description dataOfferId string M 1 Identifier of the data offer to be terminated. pull... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.2 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.3 Re-used data types | Table 7.6.8.3-1 specified data types re-used from the Data Access API. Table 7.6.8.3-1: Re-used data types Data type Reference Comments DataDeliveryMethod Clause B.4.3.1 PullDeliveryDetailsHttp Clause 7.3.8.1.3 PushDeliveryDetailsHttp Clause 7.3.8.1.4 DataAvailabilityNotification Clause 7.6.8.1.4 StreamingConfiguration... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.8.4 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.9.1 General | For the Data offer API, HTTP error responses shall be supported as specified in clause 4.8 of ETSI TS 129 501 [1]. Protocol errors and application errors specified in ETSI TS 129 500 [2], Table 5.2.7.2-1, shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HT... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.9.3 Application Errors | No additional application errors defined in the present document. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 83 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8 RAN OAM related services | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1 Configuration management API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.1 Introduction | This API allows the API Consumer to request managing configuration data based on the procedures for "Configuration Management (CM) service" defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.2 API version | For the Configuration management 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 variable shall be set to "v1". The... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.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 for the Generic provisioning management service API (see ETSI TS 128 532 [20], Figure 12.1.1.3.1.1-1 in clause 12.1.1.3.1.1). Table 8.1.3-1 lists the individual resources defined for th... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4.1 Read configuration data | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4.1.1 Operation definition | A Service Consumer uses the Read configuration data API operation as API Consumer to read configuration with the API Producer. The operation is based on HTTP GET as per Figure 8.1.4.1.1-1. The HTTP GET response contains configuration data that the API Consumer has requested. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 84 Fig... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4.1.2 Referenced procedures | 8.1.4.1.2.1 Reading configuration data procedure The procedure for reading configuration data API operation illustrated in Figure 8.1.4.1.1-1 is based on Read Configuration procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4.2 Write configuration changes | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4.2.1 Operation definition | A Service Consumer uses the Write configuration changes API operation as API Consumer to write configuration with the API Producer. The operation is based on HTTP PATCH as per Figure 8.1.4.2.1-1. The HTTP PATCH response contains configuration data that the API Consumer has requested. Figure 8.1.4.2.1-1: Write configura... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.4.2.2 Referenced procedures | 8.1.4.2.2.1 Writing configuration change procedure The procedure for writing configuration data API operation illustrated in Figure 8.1.4.2.1-1 is based on write Configuration procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5.1 Overview | This clause defines the resources for the Configuration Management (CM) service API based on the RESTful HTTP-based solution set for the Generic provisioning management service defined in ETSI TS 128 532 [20], clause 12.1.1. The Configuration Management (CM) service Producer take the role of the Generic provisioning Mn... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5.2 Resource: "MOI" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5.2.1 Description | The MOI resource represents a managed object instance, or a tree of these, containing the configuration data. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5.2.2 Resource definition | The resource URI structure of the provisioning MnS is defined in ETSI TS 128 532 [20], as per clause 12.1.1.3.1.1, with the following URI: {apiRootProvMnS/<apiVersion>/{URI-LDN-first-part}/{className}={id} The resource URI variables are specified in ETSI TS 128 532 [20], clause 12.1.1.3.2.1.2. HTTP methods GET and PATC... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5.2.3 Resource Standard Methods | 8.1.5.2.3.1 GET This method shall support the URI query parameters, request data structures, response data structures and response codes specified in ETSI TS 128 532 [20], clause 12.1.1.3.2.1.3.2. 8.1.5.2.3.2 PATCH This method shall support the URI parameters, request data structures, response data structures and respo... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.5.2.4 Resource custom operations | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 86 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.6 Custom operations without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.7 Notifications | NOTE: The notifications are not specified in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8 Data model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.1 General | The application data model is defined in ETSI TS 128 532 [20], clause 12.1.1.4, apply to this API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.2 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.3 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.4 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.5 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2 Fault management API | 8.2.1 Introduction This API allows the API Consumer to read information about alarms and to acknowledge alarms based on the procedures for the "Fault Management (FM) service" defined in R1GAP [5]. The API is based on the AlarmList IOC as specified in ETSI TS 128 111 [26], clause 7.3.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.2 API version | For the fault management 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 variable shall be set to "v1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.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 Generic provisioning management service API (see ETSI TS 128 532 [20], Figure 12.1.1.3.1.1-1 in clause 12.1.1.3.1.1). Table 8.2.3-1 lists the individual resources defined for th... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.1 Query alarms | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.1.1 Operation definition | A Service Consumer uses the Query alarms API operation as API Consumer to query alarm information from the API Producer. The operation is based on HTTP GET as per Figure 8.2.4.1.1-1. The HTTP GET response contains a list of alarm records matching the query of the API Consumer. Figure 8.2.4.1.1-1: Query alarms operation... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.1.2 Referenced procedures | 8.2.4.1.2.1 Query alarms procedure The procedure for querying alarm information illustrated in Figure 8.2.4.1.1-1 is based on the Query Alarms procedure defined in R1GAP [5]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 88 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.2 Change alarm acknowledgement state | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.2.1 Operation definition | A Service Consumer uses the Change alarm acknowledgement state API operation as API Consumer to acknowledge or unacknowledge one or more alarms with the API Producer. The operation is based on HTTP PATCH as per Figure 8.2.4.2.1-1. Figure 8.2.4.2.1-1: Change alarm acknowledgement state operation The service operation is... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.2.2 Referenced procedures | 8.2.4.2.2.1 Change alarm acknowledgement state procedure The procedure for changing the acknowledgement state of one or more alarms illustrated in Figure 8.2.4.2.1-1 is based on the Change alarm acknowledgement state procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.1 Overview | This clause defines the resources for the Fault Management (FM) service API based on the RESTful HTTP-based solution set for the Generic provisioning management service defined in ETSI TS 128 532 [20], clause 12.1.1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 89 The Fault Management (FM) service Producer take the role of th... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2 Resource: "Alarm list" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.1 Description | The "Alarm list" resource represents a list of alarms related to either a subnetwork or a managed element. It allows to query alarms and to change the acknowledgement state of alarms. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.2 Resource definition | The resource URI structure of the alarm list as managed by the Generic provisioning MnS is defined as per ETSI TS 128 532 [20], clause 12.1.1.3.1.1, for the AlarmList IOC as defined in ETSI TS 128 111 [26], clause 7.3.2, with the following URI: {apiRoot}/ProvMnS/<apiVersion>/{URI-LDN-first-part}/{className}={id}/AlarmL... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.3 Resource Standard Methods | 8.2.5.2.3.1 GET This method shall support the URI query parameters, HTTP headers, response data structures and response codes specified in ETSI TS 128 532 [20], clause 12.1.1.3.2.1.3.2. EXAMPLE 1: This request queries the whole alarm list: GET /SubNetwork=SN123/AlarmList=AL123 HTTP/1.1. EXAMPLE 2: This request queries ... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.4 Resource custom operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.6 Custom operations without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8 Data model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.1 General | The application data model is defined in ETSI TS 128 111 [26], clause A.1.3. The key IOCs for this API are SubNetwork, ManagedElement and AlarmList. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.2 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.3 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.4 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.5 Service-specific registration information | None. 8.2.9 Error Handling |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.9.1 General | HTTP error handling is applicable for this API as specified in ETSI TS 128 111 [26], clause A.1.3. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.9.3 Application Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3 Configuration schema information API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.1 Introduction | This API enables the API Consumer to retrieve configuration schema information based on the procedure defined in R1GAP [5]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 91 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.2 API version | For the configuration schema information 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 clause 4.3.1.1 of ETSI TS 129 501 [1] for a definition of the version fields). Consequently, the <apiVersion> URI path seg... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.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 "ran-oam-cm-schema-info". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 8.3.5. Figur... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.1 Get all schema information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.1.1 Operation definition | An API consumer uses the Get all schema information operation to get Schemas. {apiRoot}/ran-oam-cm-schema-info/<apiVersion> /schemas /{schemaId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 92 Figure 8.3.4.1.1-1: Get all schema information operation The service operation is as follows: 1) The API Consumer shall send an HTTP G... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.1.2 Referenced procedures | 8.3.4.1.2.1 Get schemas procedure The Get all schema information operation illustrated in Figure 8.3.4.1.1-1 is based on Get schemas procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.2 Get Individual schema information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.2.1 Operation definition | An API consumer uses the Get Individual schema information to get one or more schemas of interest for a schemaId. Figure 8.3.4.2.1-1: retrieving specific schema API operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to API Producer. The target URI shall identify the resour... |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.2.2 Referenced procedures | 8.3.4.2.2.1 Get Schemas procedure The Get individual schema information operation illustrated in Figure 8.3.4.2.1-1 is based on Get schemas procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.1 Overview | This clause defines the resources for the retrieving configuration schemas API. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.