hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.8.4 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9.1 General | For the Pull data 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 HTTP method in ETSI TS 129 500 [2], Table 5.2.7.1-1. In addition, the requirements in the following clauses are applicable for the Pull data API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.5.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6 Data offer API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.1 Introduction | This API enables an API Consumer to trigger the API Producer to collect a data instance produced by the API Consumer and to store it for later consumption, based on the procedures for managing a data offer defined in R1GAP [5]. The API definition applies to the scenario when a Data Producer is the Service Consumer and the DME framework is the Service Producer. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.2 API version | For the Data offer 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 | 7.6.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-offer". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 7.6.5. Figure 7.6.3-1 shows the overall resource URI structure defined for the Data offer API. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 75 Figure 7.6.3-1: Resource URI structure of the Data offer API Table 7.6.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 7.6.3-1: Resource and methods overview of the Data offer API Resource name Resource URI HTTP method Service Operation All data offers …/offers POST Create an individual data offer Individual data offer …/offers/{dataOfferId} DELETE Cancel data offer |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4 Service Operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.1 Create data offer | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.1.1 Operation definition | The API Consumer uses the Create data offer operation to create a data offer. The operation is based on HTTP POST. Figure 7.6.4.1.1-1: Create data offer 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 (…/offers) under which the new data offer is to be created. The message content shall carry a DataOfferInfo structure. 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 offer resource with dataOfferId assigned by the API producer. The message content shall carry a DataOfferInfo representing the created data offer. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. {apiRoot}/data-offer/<apiVersion>/ /offers /{dataOfferId} {apiRoot}/data-offer/<apiVersion> /offers /{dataOfferId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 76 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.1.2 Referenced procedures | 7.6.4.1.2.1 Create data offer procedure The Create data offer operation illustrated in Figure 7.6.4.1.1-1 is based on the Create data offer procedure defined for the Data offer service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.2 Cancel data offer | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 7.6.4.2.1 Operation definition | The API Consumer uses the Cancel data offer operation to cancel a data offer, i.e. to indicate to the API Producer that it has stopped the delivery of data for the data offer. The operation is based on HTTP DELETE. Figure 7.6.4.2.1-1: Cancel data offer 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 (…/offers/{dataOfferId}). 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. NOTE: For some data delivery methods, due to race conditions, residual produced data can arrive at the API Producer even after having received the HTTP DELETE request. The API Producer should be robust against this situation. |
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) The API Producer shall send an HTTP POST request to the API Consumer. The target URI (dataOfferTerminationNotificationUri which was provided during data offer creation) identifies the address where to send the notifications. The message content shall carry a DataOfferTerminationNotification. 2) The API Producer shall stop producing data. 3) 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. NOTE: For some data delivery methods, due to race conditions, residual produced data can arrive at the API Producer even after having received the "204 No Content" response. The API Producer should be robust against this situation. |
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 DataOfferInfo M 1 Provides information for the data job to be created. Table 7.6.5.2.3.1-2: Data structures supported by the POST response body on all data jobs Data Type P Cardinality Response codes Description DataOfferInfo M 1 201 Created The operation was successful. The message content of the POST response contains a DataOfferInfo representing the created resource. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. Table 7.6.5.2.3.1-3: Headers supported by the 201-response code on the resource Name Data type P Cardinality Description Location String M 1 Contains the URI of the newly created resource as defined in clause 7.6.5.3.2. |
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.6.2. dataOfferId The data offer identifier assigned by the Service Producer. |
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 There is no object in the message content of a DELETE request. Table 7.6.5.3.3.1-2: Data structure supported by the DELETE response body on this resource Data type P Cardinality Response codes Description N/A 204 No content The operation was successful. The data offer has been cancelled. ProblemD etails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. |
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 DataOfferTerminationNotification M 1 Notify data offer termination. Table 7.6.7.1.3.1-2: Data structures supported by the HTTP POST response body on this resource Data type P Cardinality Response codes Description N/A 204 No content Confirmation of received notification. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. |
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 definition based on the DME type specific dataProductionSchema dataDeliveryMethods array (DataDeliveryMethod) M 1..N Data delivery method(s), see clause B.4.3.1 (see note). dataDeliverySchemaIds array (string) M 1..N Delivery schema identifiers (see note). pullDeliveryDetailsHttp PullDeliveryDetailsHttp C 0..1 Access details for HTTP Pull delivery of the data, managed by the API Consumer, see clause 7.3.8.1.3. The API Consumer shall provide this attribute in the HTTP request to create a data offer if the value "PULL_HTTP" is included in "dataDeliveryMechanisms". The API Producer shall include this attribute in HTTP responses if it has chosen "PULL_HTTP" data delivery. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 81 Attribute Name Data type P Cardinality Description dataAvailabilityNotificationUri Uri C 0..1 Callback URI to receive data availability notifications, managed by the API Producer. The API Consumer shall not include this attribute in the HTTP request to create a data offer. The API Producer shall include this attribute in HTTP responses if it has chosen "PULL_HTTP" data delivery in "CONTINUOUS" delivery mode. dataOfferTerminationNotificationU ri Uri M 1 Callback URI to receive data offer termination notifications, managed by the API Consumer. pushDeliveryDetailsHttp PushDeliveryDetailsHttp C 0..1 Access details for HTTP Push delivery of the data, managed by the API Producer, see clause 7.3.8.1.4. The API Consumer shall not provide this attribute in the HTTP request to create a data offer. The API Producer shall include this attribute in HTTP responses if it has chosen "PUSH_HTTP" data delivery. streamingConfigurationKafka StreamingConfigurationK afka C 0..1 Configuration to stream data over a Kafka bus, see clause 7.3.8.1.6. This attribute shall not be present in the HTTP request to create a data offer. If the value "STREAMING_KAFKA" is included in "dataDeliveryMechanisms", this attribute shall be included in HTTP responses. NOTE: In the HTTP request to create a data offer, the API Consumer shall include all items it supports. In HTTP responses, the API Producer shall include the single item that has been chosen from the alternatives proposed during data offer creation. |
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. pullDeliveryDetailsHttp PushDeliveryDetailsHttp C 1 Access details for HTTP Push delivery of the data, managed by the API Producer, see clause 7.3.8.1.4. The API Consumer shall not provide this attribute in the HTTP request to create a data offer. The API Producer shall include this attribute in HTTP responses if it has chosen "PUSH_HTTP" data delivery. |
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 StreamingConfigurationKafka Clause 7.3.8.1.6 |
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 HTTP method in ETSI TS 129 500 [2], Table 5.2.7.1-1. In addition, the requirements in the following clauses are applicable for the Data offer API. |
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 Configuration management API is under development and consequently the API version shall include the pre-release version "alpha.1". |
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 the API, the applicable HTTP methods as defined in ETSI TS 128 532 [20], clause 12.1.1, and the associated service operations. Table 8.1.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 8.1.3-1: Resources and methods overview of the configuration management API Resource Name ETSI TS 128 532 [20] Resource URI ETSI TS 128 532 [20] HTTP method ETSI TS 128 532 [20] Service Operation MOI .../{URI-LDN-first part}/{class Name}={id} GET Read configuration data. PATCH Write configuration changes. NOTE: CM service procedures related to M-Plane nodes, such as O-RUs, are not currently supported in this API resource structure and can be defined in future releases. |
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 Figure 8.1.4.1.1-1: Read configuration data operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer that includes the Node Identifier and optional query criteria. The API Producer shall process the read information 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 configuration data. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
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 configuration changes operation The service operation is as follows: 1) The API Consumer shall send an HTTP PATCH request to the API Producer that includes the Node Identifier and optional query criteria along with payload which includes attribute identifiers, attribute values and modify operator as part of modification list defined in ETSI TS 128 532 [20], clause 11.1.1.3.2. The API Producer shall process the write configuration changes information received in the HTTP PATCH message and determine if the request sent by the API consumer is authorized or not. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 85 2) The API Producer shall return the HTTP PATCH response. On success "200 OK" shall be returned and the message content shall carry configuration data. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. NOTE: Response format to represent "partial success" is not specified in the present document. |
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 MnS Producer defined in ETSI TS 128 532 [20]. By consuming this API, an rApp as Configuration Management (CM) service Consumer takes the role of the Generic provisioning MnS Consumer defined in ETSI TS 128 532 [20]. |
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 PATCH shall only be used. |
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 response codes specified in ETSI TS 128 532 [20], clause 12.1.1.3.2.1.3.3. |
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 the API, the applicable HTTP methods as defined in ETSI TS 128 532 [20], clause 12.1.1, and the associated service operations. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 87 Table 8.2.3-1: Resources and methods overview of the fault management API Resource Name ETSI TS 128 532 [20] Resource URI ETSI TS 128 532 [20] HTTP method ETSI TS 128 532 [20] Service Operation Alarm list .../{URI-LDN-first part}/{className}={id}/ AlarmList={alarmListId} GET Query alarms. PATCH Change alarm acknowledgement status. NOTE: FM service procedures related to M-Plane nodes, such as O-RUs, are not currently supported in this API resource structure and can be defined in future releases. |
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 The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer that includes either "SubNetwork" or "ManagedElement" as the class name, the related object instance identifier, the alarm list identifier, and optional query criteria. The API Producer shall process the information 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 the representation of the alarm list. If query criteria were given, the content of the alarm entries in the returned alarm list shall match the query criteria. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
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 as follows: 1) The API Consumer shall send a PATCH request to the API Producer that includes in the resource URI either "SubNetwork" or "ManagedElement" as the class name, the related object instance identifier, and the alarm list identifier. Further, it shall include in the message content information about which alarms to be updated as well as information about the actual alarm acknowledgements / unacknowledgments. The API Producer shall process the information received in the HTTP PATCH message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP PATCH response. 3) On success, the API Producer should return a "204 No Content" response message with empty message content. 4) On success, the API Producer may alternatively return a "200 OK" response message with the representation of updated alarm list in the message content. 5) On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
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 the Generic provisioning MnS Producer defined in ETSI TS 128 532 [20]. By consuming this API, an rApp as Fault Management (FM) service Consumer takes the role of the Generic provisioning MnS Consumer defined in ETSI TS 128 532 [20]. |
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}/AlarmList={alarmListId} The resource URI variables supported by the resource are defined in Table 8.2.5.2.2-1. Table 8.2.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 8.2.2. URI-LDN-first-part See ETSI TS 128 532 [20], clause 12.1.1.3.2.1.2. className Name of the object class (IOC) of the managed object instance to which the alarm list is attached. Shall be either "SubNetwork" or "ManagedElement" as defined in ETSI TS 128 622 [21], clause 4.3.26.1. id Identifier of the managed object instance to which the alarm list is attached. alarmListId Identifier of the managed object instance which is the alarm list. |
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 a single alarm: GET /SubNetwork=SN123/AlarmList=AL123?fields=/attributes/alarmRecords/ALARM456 HTTP/1.1. NOTE: Selection of alarm records in the query based on then values of other alarm attributes than alarm identifier is not supported in the present version. 8.2.5.2.3.2 PATCH 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.3. To change the alarm state, the patch payload shall contain values for the "ackState" attribute ("ACKNOWLEDGED" or "UNACKNOWLEDGED") and the "ackUserId" attribute and may contain a value for the "ackSystemId" attribute, as defined in ETSI TS 128 111 [26], clause 7.3.1.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 90 |
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. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.