hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5.2.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-discovery/<apiVersion>/models The resource URI variables supported by the resource is defined in Table 10.2.5.2.2-1. Table 10.2.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.2.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 129 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5.2.3 Resource Standard Methods | 10.2.5.2.3.1 GET This method shall support the URI query parameters specified in Table 10.2.5.2.3.1-1, the request data structure specified in Table 10.2.5.2.3.1-2 and the response data structures, and response code specified in Table 10.2.5.2.3.1-3. Table 10.2.5.2.3.1-1: URI query parameters supported by the GET method on this resource Name Data type P Cardinality Description Applicability model-name string O 0..1 Name of the model as specified in R1GAP [5] (see note). model-version string O 0..1 Version of the model as specified in R1GAP [5] (see note). NOTE: If multiple query parameters are provided these shall be combined with AND when evaluating the query. Table 10.2.5.2.3.1-2: Data structures supported by the GET request body on this resource Data Type P Cardinality Description N/A There is no object in the message content of the GET request. Table 10.2.5.2.3.1-3: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description array (ModelRelatedInformation) O 0..N 200 OK The message content of the GET response carries an array of model identifiers and metadata of the models. ProblemDetails O 0..1 4xx/5xx Detailed problem description. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5.2.4 Resource Custom Methods | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.7 Notifications | NOTE: No notifications are specified in the current version of the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.1.1 Overview | The following clause defines the structured data types and their attributes to be used by the service API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.1.2 Data type: ModelRelatedInformation | The ModelRelatedInformation data type represents registration information for an AI/ML model. It contains the attributes defined in Table 10.2.8.1.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 130 Table 10.2.8.1.2-1: Definition of type ModelRelatedInformation Attribute Name Data type P Cardinality Description modelId ModelId M 1 Identifier of a model as specified in clause 10.1.8.1.3. metadata string M 1 Description of the AIML model that includes the AI/ML model related information and training related information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.2.1 Introduction | The following clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.2.2 Simple data types | For this service API, no simple data types are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.8.2.3 Enumerations | For this service API, no enumerations are defined in the present document. 10.2.9 Error Handling |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.9.1 General | In addition to the general provisions in clause 5.4.3, the requirements in the following clauses are applicable for the AI/ML model discovery API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3 AI/ML model training API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.1 Introduction | This API enables the API Consumer to request AI/ML model training, query AI/ML model training job status, and cancel AI/ML model training based on the procedures for "AI/ML model training services" as defined in R1GAP [5]. It also allows the API Producer to notify AI/ML model training job status change based on the procedure for "AI/ML model training services" defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.2 API version | For the AI/ML model training 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". The AI/ML model training API is under development and consequently the API version shall include the pre-release version "alpha.1". ETSI ETSI TS 104 231 V8.0.0 (2026-03) 131 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.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 "ai-ml-model-training". Figure 10.3.3-1 shows the overall resource URI structure defined for the AI/ML model training API. Figure 10.3.3-1: Resource URI structure of the AI/ML model training API Table 10.3.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 10.3.3-1: Resource and methods overview of the AI/ML model training API Resource name Resource URI HTTP method Service Operation All AI/ML model training jobs …/training-jobs POST Request AI/ML model training. Individual AI/ML model training job …/training-jobs/{trainingJobId} DELETE Cancel AI/ML model training job. Individual AI/ML model training job status …/training-jobs/{trainingJobId}/status GET Query AI/ML model training job status. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.1 Request AI/ML model training | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.1.1 Operation definition | The API Consumer uses this operation to request AI/ML model training. The operation to create AI/ML model training job is based on HTTP POST. {apiRoot}/ai-ml-model-training/<apiVersion> /training-jobs /{trainingJoblId} /status ETSI ETSI TS 104 231 V8.0.0 (2026-03) 132 Figure 10.3.4.1.1-1: Request AI/ML model training 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 "/training-jobs", the message content shall carry a TrainingJobInfo structure which includes information for training. 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 generate the training job 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" HTTP header shall be present and shall carry the URI for the newly created resource. The message content shall carry a TrainingJobInfo structure 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 | 10.3.4.1.2 Referenced procedures | 10.3.4.1.2.1 Request AI/ML model training procedure The request AI/ML model training operation illustrated in Figure 10.3.4.1.1-1 is based on the request AI/ML model training procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.2 Cancel AI/ML model training | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.2.1 Operation definition | The API Consumer uses this operation to cancel AI/ML model training. The operation to delete AI/ML model training job is based on HTTP DELETE. Figure 10.3.4.2.1-1: Cancel AI/ML model training 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 training job resource to be deleted as "/training-jobs/{trainingJobId}", 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. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 133 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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.2.2 Referenced procedures | 10.3.4.2.2.1 Cancel AI/ML model training procedure The cancel AI/ML model training operation illustrated in Figure 10.3.4.2.1-1 is based on the cancel AI/ML model training procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.3 Query AI/ML model training job status | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.3.1 Operation definition | The API Consumer uses this operation to query the AI/ML model training job status. The operation to query AI/ML model training job status is based on HTTP GET. Figure 10.3.4.3.1-1: Query AI/ML model training job status 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 "/training-jobs/{trainingJobId}/status", the message content shall be empty. The API Producer shall process the request 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. The message content shall carry a TrainingJobStatus representing the status of the training job, which is identified by the trainingJobId. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.3.2 Referenced procedures | 10.3.4.3.2.1 Query AI/ML model training job status procedure The query AI/ML model training job status operation illustrated in Figure 10.3.4.3.1-1 is based on the query AI/ML model training job status procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.4 Notify AI/ML model training job status change | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.4.1 Operation definition | The API Producer uses this operation to notify the status change of an AI/ML model training job. The operation to notify AI/ML model training job status change is based on HTTP POST. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 134 Figure 10.3.4.4.1-1: Notify AI/ML model training job status change operation The service operation is as follows: 1) The API Producer shall send an HTTP POST request to the API Consumer. The target URI {notificationDestination} shall be the one provided by API Consumer during the creation of the training job, the message content shall carry a TrainingJobStatusChangeNotification which includes the updated training job status. The API Consumer shall process the request received in the HTTP POST message and determine if the request sent by the API Producer is authorized or not. 2) The API Consumer shall return the HTTP POST 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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.4.4.2 Referenced procedures | 10.3.4.4.2.1 Notify AI/ML model training job status change procedure The notify AI/ML model training job status change operation illustrated in Figure 10.3.4.4.1-1 is based on the notify AI/ML model training job status change procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.1 Overview | This clause defines the resource for the AI/ML model training API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.2 Resource: "All AI/ML model training jobs" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.2.1 Description | The resource represents all AI/ML model training jobs created in the AI/ML model training API producer. The methods defined in clause 10.3.5.2.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.2.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-training/<apiVersion>/training-jobs The resource URI variables supported by the resource is defined in Table 10.3.5.2.2-1. Table 10.3.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.3.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 135 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.2.3 Resource Standard Methods | 10.3.5.2.3.1 POST This method shall support the request data structures specified in Table 10.3.5.2.3.1-1 and the response data structures, and response codes specified in Table 10.3.5.2.3.1-2 and the HTTP headers specified in Table 10.3.5.2.3.1-3. Table 10.3.5.2.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description TrainingJobInfo M 1 Information related to the creation of the AI/ML model training job. Table 10.3.5.2.3.1-2: Data structures supported by the HTTP POST response body on this resource Data type P Cardinality Response codes Description TrainingJobInfo M 1 201 Created Confirmation of creation of the AI/ML model training job. ProblemDetails O 0..1 4xx/5xx Detailed problem description. Table 10.3.5.2.3.1-3: Headers supported by the 201 Response Code on this resource Name Data type P Cardinality Description Location string M 1 Contains the URI of the newly created individual AI/ML model training job resource, as defined in clause 10.3.5.3, with the trainingJobId in the URI. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.2.4 Resource Custom Methods | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.3 Resource: "Individual AI/ML model training job" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.3.1 Description | The resource represents an individual AI/ML model training job created in the AI/ML model training API producer. The methods defined in clause 10.3.5.3.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.3.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-training/<apiVersion>/training-jobs/{trainingJobId} The resource URI variables supported by the resource is defined in Table 10.3.5.3.2-1. Table 10.3.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.3.2. trainingJobId The training job identifier assigned by the Service Producer. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 136 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.3.3 Resource Standard Methods | 10.3.5.3.3.1 DELETE This method shall support the request data structures specified in Table 10.3.5.3.3.1-1 and the response data structures, and response codes specified in Table 10.3.5.3.3.1-2. Table 10.3.5.3.3.1-1: Data structures supported by the HTTP 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 10.3.5.3.3.1-2: Data structures supported by the HTTP DELETE response body on this resource Data type P Cardinality Response codes Description N/A 204 No content Confirmation of successful deletion. ProblemDetails O 0..1 4xx/5xx Detailed problem description. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.3.4 Resource Custom Methods | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.4 Resource: "Individual AI/ML model training job status" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.4.1 Description | The resource represents the status of an individual AI/ML model training job created in the Non-RT RIC. The methods defined in clause 10.3.5.4.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.4.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-training/<apiVersion>/training-jobs/{trainingJobId}/status The resource URI variables supported by the resource is defined in Table 10.3.5.4.2-1. Table 10.3.5.4.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.3.2. trainingJobId The training job identifier assigned by the Service Producer. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.4.3 Resource Standard Methods | 10.3.5.4.3.1 GET This method shall support the request data structures specified in Table 10.3.5.4.3.1-1 and the response data structures, and response codes specified in Table 10.3.5.4.3.1-2. Table 10.3.5.4.3.1-1: Data structures supported by the HTTP GET request body on this resource Data type P Cardinality Description N/A There is no object in the message content of a GET request. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 137 Table 10.3.5.4.3.1-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinalit y Response codes Description TrainingJobStatus M 1 200 OK The status of the AI/ML model training job. ProblemDetails O 0..1 4xx/5xx Detailed problem description. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.5.4.4 Resource Custom Methods | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.7 Notifications | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.7.1 Notify training job status change | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.7.1.1 Description | The notification informs the receiver about the updated status of an AI/ML model training job. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.7.1.2 Resource Definition | The Resource URI {notificationDestination} is a callback URI provided when creating an AI/ML model training job. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.7.1.3 Resource Standard Methods | 10.3.7.1.3.1 POST This method shall support the request data structures specified in Table 10.3.7.1.3.1-1 and the response data structure and response codes specified in Table 10.3.7.1.3.1-2. Table 10.3.7.1.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description TrainingJobStatusChangeNotification M 1 Notify a status changes of an AI/ML model training job. Table 10.3.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 | 10.3.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.1.1 Overview | The following clauses define the data types and attributes to be used by the AI/ML model training API. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 138 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.1.2 Data type: TrainingJobInfo | Table 10.3.8.1.2-1: Definition of type TrainingJobInfo Attribute Name Data type P Cardinality Description modelId ModelId M 1 The model identifier which contains model name, model version, and artifact version. See clause 10.1.8.1.3. modelLocation Uri O 0..1 Location of the AI/ML model. trainingDataset Uri O 0..1 Information for reference to the training dataset. trainingConfig Object O 0..1 trainingConfig provided by the training service producer. notificationDestination Uri O 0..1 Callback URI where the notification should be delivered to. trainingProducerId String O 0..1 Identifier of training producer "apfId" as specified in SME. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.2.1 Overview | The following clauses define simple data types and enumerations that can be referenced from data structure defined in the previous clauses. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.2.2 Simple data types | No simple data types are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.8.2.3 Enumerations | No enumerations are defined in the present document.. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.9.1 General | For the AI/ML model training API, HTTP error responses shall be supported as specified in 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 AI/ML model training API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.3.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4 AI/ML model deployment API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.1 Introduction | This API enables the API Consumer to request the deployment of an AI/ML model based on the AI/ML model deployment request service defined in R1GAP [5]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 139 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.2 API version | For the AI/ML model deployment 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". The AI/ML model deployment API is under development and consequently the API version shall include the pre-release version "alpha.1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.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 " ai-ml-model-deployment". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 10.4.5. Figure 10.4.3-1 shows the overall resource URI structure defined for the AI/ML model deployment API. Figure 10.4.3-1: Resource URI structure of the AI/ML model deployment API Table 10.4.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 10.4.3-1: Resource and methods overview of the AI/ML model deployment API Resource name Resource URI HTTP method Service Operation All AI/ML model deployments …/model-deployments POST Request AI/ML model deployment. Individual AI/ML deployment status …/model-deployments/{ modelDeploymentId }/status GET Query AI/ML model deployment status. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.4.1 Request AI/ML model deployment | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.4.1.1 Operation definition | The API Consumer uses this operation to request AI/ML model deployment. The operation to request AI/ML model deployment is based on HTTP POST. {apiRoot}/ai-ml-model-deployment/<apiVersion> /model-deployments /{modelDeploymentId} /status ETSI ETSI TS 104 231 V8.0.0 (2026-03) 140 Figure 10.4.4.1.1-1: Request AI/ML model deployment 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 "/modeldeployments", the message content shall carry a ModelDeploymentInformation which includes information for deployment. 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 generate the deployment 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 resource. The message content shall carry a ModelDeploymentInformation 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 | 10.4.4.1.2 Referenced procedures | 10.4.4.1.2.1 Request AI/ML model deployment procedure The request AI/ML model deployment operation illustrated in Figure 10.4.4.1.1-1 is based on the request AI/ML model deployment procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.4.2 Notify AI/ML model deployment status change | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.4.2.1 Operation definition | The API Producer uses this operation to notify the change of an AI/ML model deployment status. The operation to notify AI/ML model deployment status change is based on HTTP POST. Figure 10.4.4.2.1-1: Notify AI/ML model deployment status change operation The service operation is as follows: 1) The API Producer shall send an HTTP POST request to the API Consumer. The target URI {notificationDestination} may be provided by API Consumer during the ai/ml model deployment request, where the message content shall carry a DeploymentStatusChangeNotification which includes the updated AI/ML model deployment status. The API Consumer shall process the request received in the HTTP POST message and determine if the request sent by the API Producer is authorized or not. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 141 2) The API Consumer shall return the HTTP POST 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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.4.2.2 Referenced procedures | 10.4.4.2.2.1 Notify AI/ML model deployment status change procedure The notify AI/ML model deployment status change operation illustrated in Figure 10.4.4.2.1-1 is based on the AI/ML model deployment procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5.1 Overview | This clause defines the resource for the AI/ML model deployment API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5.2 Resource: "All AI/ML model deployment" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5.2.1 Description | The resource represents all AI/ML model deployment in the Non-RT RIC. The methods defined in clause 10.4.5.2.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5.2.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-deployment/<apiVersion> The resource URI variables supported by the resource is defined in Table 10.4.5.2.2-1. Table 10.4.5.2.2-1: Resource URI variable for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.4.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5.2.3 Resource Standard Methods | 10.4.5.2.3.1 POST This method shall support the request data structures specified in Table 10.4.5.2.3.1-1 and the response data structures and response codes specified in Table 10.4.5.2.3.1-2. Table 10.4.5.2.3.1-1: Data structures supported by the HTTP POST Request Body on this resource Data type P Cardinality Description ModelDeploymentInformation M 1 Information related to the deployment of the AI/ML model. Table 10.4.5.2.3.1-2: Data structures supported by the HTTP POST Response Body on this resource Data type P Cardinality Response codes Description ModelDeploymentInformation 201 Created The operation was successful. The message content of the POST response carries ModelDeploymentInformation. ProblemDetails O 0..1 4xx/5xx Detailed problem description. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 142 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.5.2.4 Resource Custom Methods | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.7 Notifications | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.7.1 Notify AI/ML model deployment status change | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.7.1.1 Overview | The notification informs the receiver about the AI/ML model deployment status. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.7.1.2 Resource Definition | The Resource URI {notificationDestination} is a callback URI provided when requesting deployment of an AI/ML model. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.7.1.3 Resource Standard Methods | 10.4.7.1.3.1 POST This method shall support the request data structures specified in Table 10.4.7.1.3.1-1 and the response data structure and response codes specified in Table 10.4.7.1.3.1-2. Table 10.4.7.1.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description DeploymentStatusChangeNotification M 1 Notify a status changes of an AI/ML model deployment status. Table 10.4.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 | 10.4.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.8.1.1 Overview | The following clauses define the structured data types and their attributes to be used by the AI/ML model deployment API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.4.8.1.2 Data type: ModelDeploymentInformation | The ModelDeploymentInformation data type represents deployment information for an AI/ML model. It contains the attributes defined in Table 10.4.8.1.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 143 Table 10.4.8.1.2-1: Definition of type ModelDeploymentInformation Attribute Name Data type P Cardinality Description modelId ModelId M 1 Identifier of a model. See clause 10.1.8.1.3. notificationDestination Uri O 0..1 Callback URI where the notification would be delivered to, once the deployment status changes. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.5 AI/ML model retrieve API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.5.1 Introduction | This API enables the API Consumer to request the retrieve of an AI/ML model based on the AI/ML model retrieve request service defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.5.2 API version | For the AI/ML model retrieve 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 segment shall be set to "v1". The AI/ML model retrieve API is under development and consequently the API version shall include the pre-release version "alpha.1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.5.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 "ai-ml-model-retrieve". Figure 10.5.3-1 shows the overall resource URI structure defined for the AI/ML model retrieve API. Figure 10.5.3-1: Resource URI structure of AI/ML model retrieve API Table 10.5.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 10.5.3-1: Resource and methods overview of the AI/ML model retrieve API Resource name Resource URI HTTP method Service Operation AI/ML model retrieve …/model-retrieve GET Retrieve AI/ML model {apiRoot}/ai-ml-model-retrieve/<apiVersion> /model-retrieve ETSI ETSI TS 104 231 V8.0.0 (2026-03) 144 Annex A (normative): OpenAPI specifications A.1 General A.1.1 Overview This annex formally specifies the RESTful R1 service APIs by defining OpenAPI documents in YAML format that comply with the OpenAPI Specification v3.0.3 [3]. The Open API specifications of the RESTful R1 service APIs provided in this annex are versioned as described in clause 5.2. The OpenAPIs defined in this annex has references to the common definitions defined in clause A.1.2 of the present document. A.1.2 Common schemas for general use A.1.2.1 Introduction The Open API specified in clause A.1.2.2 provides schemas for general data types and responses for usage across the R1 APIs. A.1.2.2 Common definitions openapi: 3.0.3 info: title: 'R1 Common definitions' version: 1.0.0 description: | R1 Common definitions - O-RAN.WG2.R1AP_Common.yaml. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' paths: {} components: schemas: Uri: description: 'A string formatted according to IETF RFC 3986 [8].' type: string ProblemDetails: description: 'A problem detail to carry details in an HTTP response according to IETF RFC 7807' type: object properties: type: description: 'a URI reference according to IETF RFC 3986 that identifies the problem type' type: string title: description: 'human-readable summary of the problem type' type: string status: description: 'the HTTP status code' type: number detail: description: 'human-readable explanation ' type: string instance: description: 'URI reference that identifies the specific occurrence of the problem' type: string responses: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 145 '400': description: 'Bad Request' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: 'Unauthorized' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: 'Forbidden' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: 'Not Found' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '405': description: 'Method Not Allowed' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '406': description: 'Not Acceptable' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: 'Conflict' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '411': description: 'Length Required' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '413': description: 'Payload Too Large' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '414': description: 'URI Too Large' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '415': description: 'Unsupported Media Type' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '429': description: 'Too Many Requests' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: 'Internal Server Error' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 146 '502': description: 'Bad Gateway' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '503': description: 'Service Unavailable' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' A.2 Service management and exposure service A.2.1 Service registration API A.2.1.1 Introduction The Open API for this service is reusing the CAPIF_Publish_Service_API as specified in clause A.2.1.2 with exceptions specified in clause A.2.1.3 below. A.2.1.2 CAPIF_Publish_Service_API The Open API for the SME service registration API specified in clause 6.1 reuses the CAPIF_Publish_Service_API as specified in ETSI TS 129 222 [9], clause A.3. The API version of the Service registration API as specified in clause 6.1.2 shall use the CAPIF_Publish_Service_API OpenAPI version as specified in Table A.2.1.2-1. Table A.2.1.2-1 API name API version CAPIF OpenAPI version Service registration API 1.2.0 1.3.0 A.2.1.3 Adaptations and Exceptions The OpenAPI code below represents the "VersionExtensions" data type which needs to be added to the OpenAPI definitions of the CAPIF_Publish_Service_API defined in ETSI TS 129 222 [9]. components: schemas: VersionExtensions: Description: ' The VersionExtensions data structure specified in table B.3.4.1-1 in R1AP defines O-RAN extensions to the CAPIF Version data type which allows to signal the versions supported for an interface endpoint.' type: object properties: fullApiVersions: description: ' List of version strings, as defined in R1GAP clause 5.2, to signal the API versions supported by the API Producer for a particular major API version.' type: array items: type: string minItems: 1 The OpenAPI code below represents the "ServiceProperties" data type which needs to be added to the OpenAPI definitions of the CAPIF_Publish_Service_API defined in ETSI TS 129 222 [9]. components: schemas: ServiceProperties: description: 'Defines a container that can be used by individual service APIs to register and discover service-specific properties.' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 147 type: object properties: serviceCapabilities: description: ' Service capabilities. The content of this attribute is service-specific and is defined per service.' type: object Table A.2.1.3-1 below lists exceptions and adaptations related to certain attributes in certain CAPIF data types when re-using the CAPIF_Publish_Service_API in the context of the present document. Table A.2.1.3-1: Message content exceptions and adaptations when reusing the CAPIF_Publish_Service_API Data type Reference Attributes Adaptations/Exceptions ServiceAPIDescription ETSI TS 129 222 [9], clause A.3 supportedFeatures Not required to be supported. shareableInfo Not required to be supported. serviceAPICategory Not required to be supported. ccfId Not required to be supported. apiSuppFeats Not required to be supported. Not required to be supported. vendorSpecific-o- ran.org This additional attribute shall be present if service-specific registration information is available for the service API. It shall have the type ServiceProperties as specified in clause B.3.4.2 and defined in clause A.2.1.3. AefProfile ETSI TS 129 222 [9], clause A.3 aefId Shall be set to the value of "rAppId" if an rApp produces the API. aefLocation Not required to be supported. domainName Not required to be supported. serviceKpis Not required to be supported. ueIpRange Not required to be supported. Version ETSI TS 129 222 [9] clause A.3 vendorSpecific-o- ran.org This additional attribute shall be supported and shall have the type VersionExtensions as specified in clause B.3.4.1 and defined above. A.2.2 Service discovery API A.2.2.1 Introduction The Open API for this service is reusing the CAPIF_Discover_Service_API in as specified in clause A.2.2.2 with exceptions specified in clause A.2.2.3 below. A.2.2.2 CAPIF_Discovery_Service_API The Open API for the SME service discovery API specified in clause 6.2reuses the CAPIF_Discover_Service_API as specified in ETSI TS 129 222 [9], clause A.2. The API version of the Service discovery API as specified in clause 6.2.2 shall use the CAPIF_Discover_Service_API OpenAPI version as specified in Table A.2.2.2-1. Table A.2.2.2-1 API name API version CAPIF OpenAPI version Service discover API 1.2.0 1.3.0 ETSI ETSI TS 104 231 V8.0.0 (2026-03) 148 A.2.2.3 Adaptations and Exceptions Table A.2.2.3-1 lists exceptions and adaptations related to CAPIF message content when re-using the CAPIF_Discover_Service _API in the context of the present document. Table A.2.2.3-1 lists exceptions and adaptations related to CAPIF URI query parameters when re-using the CAPIF_Discover_Service_API in the context of the present document. Table A.2.2.3-1: Message content exceptions and adaptations when reusing the CAPIF_Discover_Service_API Data type Reference Attributes Exceptions/Adaptations ServiceAPIDescription ETSI TS 129 222 [9], clause A.3 supportedFeatures Not required to be supported. shareableInfo Not required to be supported. serviceAPICategory Not required to be supported. ccfId Not required to be supported. apiSuppFeats Not required to be supported. pubApiPath Not required to be supported. vendorSpecific-o-ran.org This additional attribute shall be present if service-specific registration information is available for the service API. It shall have the type ServiceProperties as specified in clause B.3.4.2 and defined in clause A.2.1.3. ue-ip-addr Not required to be supported. service-kpis Not required to be supported. AefProfile ETSI TS 129 222 [9], clause A.3 aefId Shall be set to the value of "rAppId" if an rApp produces the API. Shall be set to an identifier related to the SMO/Non-RT RIC functions if these produce the API. See note. aefLocation Not required to be supported. domainName Not required to be supported. Version ETSI TS 129 222 [9], clause A.3 vendorSpecific-o-ran.org This additional attribute shall be supported and shall have the type VersionExtensions as specified in clause B.3.4.1 and defined in clause A.2.1.3. NOTE: It is out of scope of the present document whether each SMO/Non-RT RIC framework function is identifiable by a separate identifier value or whether such decomposition information is hidden from the rApps. However, the SMO/Non-RT RIC framework shall ensure that the identifiers used for rApps as AEFs and the identifiers used for SMO/Non-RT RIC framework functions as AEFs do not collide. The Query parameters in Table A.2.2.3-2 below are not required to be supported when the CAPIF_Discover_Service_API is reused. Table A.2.2.3-2: Query parameters exceptions and adaptations when reusing the CAPIF_Discover_Service_API Resource Reference Exceptions Comment /allServiceAPIs ETSI TS 129 222 [9], clause A.2 api-invoker-id Shall be set to the value of "rAppId" for an API-consuming rApp. ETSI TS 129 222 [9], clause A.2 comm-type Not required to be supported. ETSI TS 129 222 [9], clause A.2 protocol Not required to be supported. ETSI TS 129 222 [9], clause A.2 aef-id Not required to be supported. ETSI TS 129 222 [9], clause A.2 data-format Not required to be supported. ETSI TS 129 222 [9], clause A.2 api-cat Not required to be supported. ETSI TS 129 222 [9], clause A.2 preferred-aef-loc Not required to be supported. ETSI TS 129 222 [9], clause A.2 supported-features Not required to be supported. ETSI TS 129 222 [9], clause A.2 api-supported- features Not required to be supported. ETSI TS 129 222 [9], clause A.2 ue-ip-addr Not required to be supported. ETSI TS 129 222 [9], clause A.2 service-kpis Not required to be supported. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 149 A.2.3 Service events subscription API A.2.3.1 Introduction The Open API for this service is reusing the CAPIF_Events_API as specified in clause A.2.3.2 with exceptions specified in clause A.2.3.3 below. A.2.3.2 CAPIF_Events_API The Open API for the SME service events subscription API specified in clause 6.3 reuses the CAPIF_Events_API as specified in ETSI TS 129 222 [9], clause A.4. The API version of the SME service events subscription API as specified in clause 6.3.2 shall use the CAPIF_Events_API OpenAPI version as specified in Table A.2.3.2-1 Table A.2.3.2-1 API name API version CAPIF OpenAPI version Service events subscription API 1.2.0 1.3.0 A.2.3.3 Adaptations and Exceptions Table A.2.3.3-1 lists exceptions and adaptations related to CAPIF message content when re-using the CAPIF_Events_API in the context of the present document. Table A.2.3.3-1: Message content exceptions and adaptations when reusing the CAPIF_Events_API Data type Reference Attributes Exceptions/Adaptations AccessControlPolicyListExt ETSI TS 129 222 [9], clause A.4 Not required to be supported. CAPIFEvent ETSI TS 129 222 [9], clause A.4 See clause B.3.5. CAPIFEventDetail ETSI TS 129 222 [9], clause A.4 accCtrlPolList Not required to be supported. invocationLogs Not required to be supported. apiTopoHide Not required to be supported. CAPIFEventFilter ETSI TS 129 222 [9], clause A.4 apiInvokerIds Shall be set to the value of "rAppId" for an API-consuming rApp. aefIds Shall be set to the value of "rAppId" if an rApp -produces the API. Shall be set to an identifier related to the SMO/Non-RT RIC framework functions if these produce the API. See Table A.2.2.3-1. ReportingInformation Not required to be supported. EventNotification ETSI TS 129 222 [9], clause A.4 invocationLogs Not required to be supported. apiTopoHide Not required to be supported. EventSubscription ETSI TS 129 222 [9], clause A.4 supportedFeatures Not required to be supported. eventReq Not required to be supported. TopologyHiding ETSI TS 129 222 [9], clause A.4 Not required to be supported. A.2.4 Bootstrap API A.2.4.1 Introduction The Open API for this service as specified in clause A.2.4.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 150 A.2.4.2 Bootstrap API openapi: 3.0.3 info: title: 'BootStrap' version: 1.0.0 description: | API for BootStrap service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/bootstrap/v1/' variables: apiRoot: description: 'apiRoot as defined in clause 5.3 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: '/bootstrap-info': get: description: 'To discover the entry points into Service management and exposure ' responses: '200': description: '.' content: application/json: schema: $ref: '#/components/schemas/BootstrapInformation' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: BootstrapInformation: type: object properties: apiEndpoints: type: array items: $ref: '#/components/schemas/ApiEndpointInformation' ApiEndpointInformation: type: object properties: apiName: type: string description: 'Name of the API ("service-apis" or "published-apis")' tokenEndpoint: $ref: 'TS29122_CAPIF_publish_Service_API.yaml#/components/schemas/InterfaceDescription' description: 'Token endpoint shall be provided if the API requires authorization over OAuth2.0' nullable: true apiEndPoint: $ref: 'TS29122_CAPIF_publish_Service_API.yaml#/components/schemas/InterfaceDescription' description: 'End point of the API' nullable: true required: - apiName - apiEndPoint ETSI ETSI TS 104 231 V8.0.0 (2026-03) 151 A.3 Data management and exposure service A.3.1 Data registration API A.3.1.1 Introduction The Open API for the Data Registration API is specified in clause A.3.1.2. A.3.1.2 Data registration API openapi: 3.0.3 info: title: 'Data registration service' version: 2.0.0-alpha.2 description: | API for Data registration service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/data-registration/v2/' variables: apiRoot: description: 'apiRoot as defined in clause 5.3 in O-RAN.WG2.R1AP' default: 'https://example.com' apiConsumerId: description: Identifier of the API consumer that registers its data production capabilities default: '' paths: '/production-capabilities': post: description: 'To register DME type production capabilities' tags: - Registered DME type production capabilities requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DmeTypeRelatedCapabilities' responses: '201': description: 'Success case 201 created' content: application/json: schema: $ref: '#/components/schemas/DmeTypeRelatedCapabilities' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 152 '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/production-capabilities/{registrationId}': parameters: - name: registrationId in: path required: true schema: $ref: '#/components/schemas/registrationId' put: description: 'To update DME type production capabilities that it has previously registered' tags: - Individual registered DME type production capability requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DmeTypeRelatedCapabilities' responses: '200': description: 'Success case 200 with updated information' content: application/json: schema: $ref: '#/components/schemas/DmeTypeRelatedCapabilities' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '411': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/411' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' get: description: 'To query DME type production capabilities that it has previously registered' tags: - Individual registered DME type production capability responses: '200': description: 'Success case 200 with queried information' content: application/json: schema: $ref: '#/components/schemas/DmeTypeRelatedCapabilities' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 153 '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' delete: description: 'To deregister DME type production capabilities' tags: - Individual registered DME type production capability responses: '204': description: 'The registration was deleted' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: registrationId: description: 'A successful registration identified by registrationId ' type: string DmeTypeRelatedCapabilities: description: 'Information related to the registration as producer of a DME type' type: object properties: dmeTypeDefinition: $ref: '#/components/schemas/DmeTypeDefinition' constraints: description: 'Formulates producer constraints or constraints applicable to the consumption related to the DME type based on the dataProductionSchema' type: object dataAccessEndpoint: $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription' dataDeliveryModes: type: array items: $ref: 'O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/DataDeliveryMode' required: [dmeTypeDefinition, dataDeliveryModes, dataAccessEndpoint] DmeTypeDefinition: description: 'Information of the DME type' type: object properties: dmeTypeId: $ref: '#/components/schemas/DmeTypeIdStruct' metadata: $ref: '#/components/schemas/Metadata' dataProductionSchema: type: object description: 'Schema that defines the information necessary to formulate a data request or data subscription. If this attribute is not present, the schema is assumed to be known from the DME type definition that is referenced by dmeTypeId' dataDeliverySchemas: description: 'List of delivery schemas supported by the producer for the DME type being registered.' type: array items: $ref: '#/components/schemas/DeliverySchema' dataDeliveryMechanisms: description: 'Defining the delivery mechanism supported by Data Producer ' type: array items: $ref: '#/components/schemas/DataDeliveryMechanism' required: ["dmeTypeId", "metadata", "dataDeliverySchemas", "dataDeliveryMechanisms"] ETSI ETSI TS 104 231 V8.0.0 (2026-03) 154 DmeTypeIdStruct: description: 'Defining the attributes of DME type identifier' type: object properties: namespace: type: string description: 'Indicating the entity responsible for the DME type definition.' name: type: string description: 'Name of the DME type. The string can be any character except ":" (colon)' pattern: '^[^:]{1,}$' version: type: string description: 'Version of the DME type. The versioning and allowed characters are according to SemVer [11]' required: ["namespace","name","version"] DeliverySchema: description: 'Delivery schema for a DME type' type: object properties: type: $ref: '#/components/schemas/SchemaTypes' deliverySchemaId: type: string description: A Data Producer may support one or more delivery schemas and for each supported schema type a delivery schema identifier is assigned. A Data Consumer uses this attribute while creating a data job and request to deliver the data using specific schema type which is identified by this attribute. schema: type: string description: 'The schema serialized to string. If this attribute is not present, the schema is assumed to be known from the DME type definition that is referenced by dmeTypeId' required: ["type","deliverySchemaId"] DataDeliveryMechanism: description: 'Defining the attributes of delivery mechanism supported' type: object properties: dataDeliveryMethod: description: 'Delivery Method supported' ref: 'O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/DataDeliveryMethod' kafkaDeliveryConfiguration: $ref: '#/components/schemas/KafkaDeliveryConfiguration' required: - dataDeliveryMethod oneOf: - required: ["kafkaDeliveryConfiguration"] Metadata: description: 'Metadata that can be used in discovering the DME type' properties: dataCategory: description: 'Defines the category of the DME type e.g. PM counters' type: array items: type: string minItems: 1 rat: description: 'Defines the radio access technology e.g. 5G' type: array items: type: string minItems: 1 required: ["dataCategory"] SchemaTypes: description: 'Type of the schema supported by Data Producers' type: string enum: - JSON_SCHEMA - XML_SCHEMA KafkaDeliveryConfiguration: description: 'These configuration will be applied if STREAMING_KAFKA is selected as delivery method' type: object properties: numPartitions: description: 'Number of partitions' type: integer cleanUpPolicy: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 155 description: 'cleanUpPolicy is based on cleanup.policy defined in the Kafka Documentation [15]. ' type: string compressionType: description: ' compressionType is based on compression.type defined in the Kafka Documentation [15] .' type: string retentionBytes: description: ' retentionBytes is based on retention.bytes defined in the Kafka Documentation [15] . This attribute is applicable ONLY when cleanUpPolicy is set to DELETE' type: integer retentionMs: description: ' retentionMs is based on retention.ms defined in the Kafka Documentation [15] . This attribute is applicable ONLY when cleanUpPolicy is set to DELETE' type: integer required: ["cleanUpPolicy", "compressionType"] A.3.2 Data discovery API A.3.2.1 Introduction The Open API for the Data Discovery API is specified in clause A.3.2.2. A.3.2.2 Data discovery API openapi: 3.0.3 info: title: 'Data discovery service' version: 2.0.0 description: | API for Data discovery service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/data-discovery/v2/' variables: apiRoot: description: 'apiRoot as defined in clause 5.3 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: /dme-types: get: description: 'To discover the available DME types' parameters: - name: identity-namespace in: query description: 'Identity namespace to match the "namespace" part of the "dmeTypeId" attribute' schema: type: string - name: identity-name in: query description: 'Identity name to match the "name" part of the "dmeTypeId" attribute.' schema: type: string - name: data-category in: query description: 'Set of data category entries, all of which to match entries of the "dataCategory" attribute.' schema: type: array explode: false items: type: string responses: '200': description: 'The response body contains the result of the search over the list of registered APIs.' content: application/json: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 156 schema: type: array items: $ref: 'O- RAN.WG2.R1AP_DataRegistration.yaml#/components/schemas/DmeTypeRelatedCapabilities' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '414': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/414' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' /dme-types/{dmeTypeId}: get: description: To obtain information about an individual DME type. parameters: - name: dmeTypeId in: path required: true schema: $ref: '#/components/schemas/dmeTypeId' responses: '200': description: The response body contains information about the DME type. content: application/json: schema: $ref: 'O- RAN.WG2.R1AP_DataRegistration.yaml#/components/schemas/DmeTypeRelatedCapabilities' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '414': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/414' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: dmeTypeId: type: string description: 'The DmeTypeId is constructed based on the three parts separated by ":" (colon) {dmeTypeId} = {namespace}:{name}:{version}. See O- RAN.WG2.R1AP_DataRegistration.yaml#/components/schemas/DmeTypeIdStruct for the definition of "namespace", "name" and "version".' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 157 A.3.3 Data access API A.3.3.1 Introduction The Open API for the Data access API is specified in clause A.3.3.2. A.3.3.2 Data access API openapi: 3.0.3 info: title: 'Data access service' version: 2.0.0-alpha.2 description: | API for Data access service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/data-access/v1/' variables: apiRoot: description: 'apiRoot as defined in clause 5.3 in O-RAN.WG2.R1AP' default: 'https://example.com' apiConsumerId: description: 'Identifier of the API consumer ' default: '' paths: '/data-jobs': post: description: 'To create a data job' tags: - Create all data jobs requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataJobInfo' responses: '201': description: 'Success case 201 created' content: application/json: schema: $ref: '#/components/schemas/DataJobInfo' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': ETSI ETSI TS 104 231 V8.0.0 (2026-03) 158 $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' callbacks: DataAvailabilityNotification: '{$request.body.dataAvailabilityNotificationUri}': post: description: 'Notification on the availability of requested data' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataAvailabilityNotification' responses: '204': description: 'The notification was delivered' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/data-jobs/{dataJobId}': parameters: - name: dataJobId in: path required: true schema: $ref: '#/components/schemas/dataJobId' delete: description: 'To delete the created data job' tags: - Individual data job responses: '204': description: 'The data job was deleted' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: dataJobId: description: 'A successful created data job is identified by dataJobId ' type: string DataJobInfo: description: 'Information related to a data job' allOf: - type: object properties: dataDeliveryMode: $ref: '#/components/schemas/DataDeliveryMode' dmeTypeId: $ref: 'O-RAN.WG2.R1AP_DataDiscovery.yaml#/components/schemas/dmetypeId' productionJobDefinition: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 159 description: 'Job description based on the DME type specific dataProductionSchema' type: object dataDeliveryMethod: $ref: '#/components/schemas/DeliveryMethod' dataDeliverySchemaId: description: 'A delivery schema identifier provided by a Data Producer during the data registration procedure' type: string required: [dataDeliveryMode, dmeTypeId, productionJobDefinition, dataDeliveryMethod, dataDeliverySchemaId] - type: object oneOf: - properties: pullDeliveryDetailsHttp: $ref: '#/components/schemas/PullDeliveryDetailsHttp' required: [pullDeliveryDetailsHttp] - properties: dataAvailabilityNotificationUri: $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/schemas/Uri' required: [dataAvailabilityNotificationUri] - properties: pushDeliveryDetailsHttp: $ref: '#/components/schemas/PushDeliveryDetailsHttp' required: [pushDeliveryDetailsHttp] - properties: streamingConfigurationKafka: $ref: '#/components/schemas/StreamingConfigurationKafka' required: [streamingConfigurationKafka] DataDeliveryMode: description: 'This indicates whether the data instance is created in a one-time data delivery (data request) or continuously (data subscription)' type: string enum: - ONE_TIME - CONTINUOUS DataDeliveryMethod: description: 'This indicates supported delivery method' type: string enum: - PULL_HTTP - PUSH_HTTP - STREAMING_KAFKA PullDeliveryDetailsHttp: description: 'The PullDeliveryDetailsHttp data type signals how to pull data using the HTTP protocol.' readOnly: true type: object properties: dataPullUri: $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/schemas/Uri' required: [dataPullUri] PushDeliveryDetailsHttp: description: 'The PushDeliveryDetailsHttp data type signals how to push data using the HTTP protocol.' type: object properties: dataPushUri: $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/schemas/Uri' required: [dataPushUri] StreamingConfigurationKafka: description: 'The StreamingConfigurationKafka data type signals a data streaming configuration for the Kafka protocol.' type: object properties: topicName: description: 'Name of the Kafka topic' type: string kafkaBootstrapServers: description: 'Server configuration' type: array items: $ref: '#/components/schemas/ServerAddressWithPort' required: [topicName, kafkaBootstrapServers] ServerAddressWithPort: description: 'Server configuration' type: object properties: hostname: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 160 description: 'string identifying a hostname shall be formatted according to clause 2.3.1 as defined in IETF RFC 1035 [19]' type: string portAddress: description: 'Port address, e.g. 9092' type: integer minimum: 1 maximum: 65535 required: [hostname, portAddress] DataAvailabilityNotification: description: 'Availability of the data' type: object properties: dataJobId: description: 'data job identifier' type: string pullDeliveryDetailsHttp: $ref: '#/components/schemas/PullDeliveryDetailsHttp' A.3.4 HTTP based Push data API Deliberately, no OpenAPI is specified for this API in the present document. NOTE: OpenAPI requires the definition of the valid content types for the request message content. However, this API is agnostic with respect to the content type of the data carried in the request message. Within the DME services, the valid content types are defined as part of separate data message schemas which specify the structure of the data to be carried over the API. Because of the requirement to fix the content types that can be carried over the API, defining an OpenAPI would restrict the versatility of the API. A.3.5 HTTP based Pull data API Deliberately, no OpenAPI is specified for this API in the present document. NOTE: OpenAPI requires the definition of the valid content types for the response message content. However, this API is agnostic with respect to the content type of the data carried in the response message. Within the DME services, the valid content types are defined as part of a separate data message schema which specifies the structure of the data to be carried over the API. Because of the requirement to fix the content types that can be carried over the API, defining an OpenAPI would restrict the versatility of the API. A.3.6 Data offer API A.3.6.1 Introduction The Open API for the Data offer API is specified in clause A.3.6.2. A.3.6.2 Data offer API openapi: 3.0.3 info: title: 'Data offer service' version: 1.0.0 description: | API for Data offer service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/data-offer/v1' variables: apiRoot: description: 'apiRoot as defined in clause 5.3 in O-RAN.WG2.R1AP' default: 'https://example.com' apiConsumerId: description: 'Identifier of API Consumer' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 161 default: '' paths: '/offers': post: description: 'Allows to create a new data offer' tags: - All data offers requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataOfferInfo' responses: '201': description: 'Success case 201 created' content: application/json: schema: $ref: '#/components/schemas/DataOfferInfo' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' callbacks: DataAvailabilityNotification: '{$request.body.dataAvailabilityNotificationUri}': post: description: 'Notification on the availability of offered data' requestBody: required: true content: application/json: schema: $ref: ' O-RAN.WG2.R1AP_DataAccess.yaml #/components/schemas/DataAvailabilityNotification' responses: '204': description: 'The notification was delivered' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': ETSI ETSI TS 104 231 V8.0.0 (2026-03) 162 $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' DataOfferTerminationNotification: '{$request.body.dataOfferTerminationNotificationUri}': post: description: 'Notification on termination of data offer by the API producer' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataOfferTerminationNotification' responses: '204': description: 'The notification was delivered' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/offers/{dataOfferId}': parameters: - name: dataOfferId in: path required: true schema: type: string delete: description: 'To delete the data offer' tags: - Individual data offer responses: '204': description: 'The data offer was deleted.' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: DataOfferInfo: description: 'Information related to a data offer' type: object properties: dataDeliveryMode: $ref: 'O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/DataDeliveryMode' dmeTypeId: $ref: 'O-RAN.WG2.R1AP_DataDiscovery.yaml#/components/schemas/DmeTypeId' productionJobDefinition: description: 'Job description based on the DME type specific dataProductionSchema' type: object dataDeliveryMethods: type: array items: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 163 $ref: ' O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/DataDeliveryMethod' dataDeliverySchemaIds: description: 'A delivery schema identifier provided by a Data Producer during the data registration procedure' type: array items: type: string pullDeliveryDetailsHttp: $ref: ' O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/PullDeliveryDetailsHttp' dataAvailabilityNotificationUri: $ref: '/components/schemas/DataOfferAvailabilityNotification' dataOfferTerminationNotificationUri: $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/schemas/Uri' pushDeliveryDetailsHttp: $ref: 'O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/PushDeliveryDetailsHttp' streamingConfigurationKafka: $ref: 'O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/StreamingConfigurationKafka' required: [ "dataDeliveryMode", "dmeTypeId", "productionJobDefinition", " dataDeliveryMethods ", "dataDeliverySchemaIds", "dataOfferTerminationNotificationUri"] DataOfferTerminationNotification: description: 'Termination of a data offer by the API producer' type: object properties: dataOfferId: description: 'Identifies the deleted data offer' type: string required: ["dataOfferId"] DataOfferAvailabilityNotification: description: 'Availability of the data' type: object properties: dataOfferId: description: 'data offer identifier' type: string pullDeliveryDetailsHttp: $ref: 'O-RAN.WG2.R1AP_DataAccess.yaml#/components/schemas/PullDeliveryDetailsHttp' required: ['dataOfferId', 'pullDeliveryDetailsHttp']: description: 'Identifies the deleted data offer' type: string required: ["dataOfferId"] A.4 RAN OAM related services A.4.1 Configuration management API A.4.1.1 Introduction The Open API for this service is reusing the provisioning management service API as specified in clause A.4.1.2 with exceptions specified in clause A.4.1.3 below. A.4.1.2 Configuration management API The Open API for the Configuration management API specified in clause 8.1 reuses the Provisioning management service API (TS28532_ProvMnS.yaml) as specified in ETSI TS 128 532 [20], clause A.1.1. The API version of the Configuration management API as specified in clause 8.1.2 shall use the Provisioning management service OpenAPI version as specified in Table A.4.1.2-1. Table A.4.1.2-1 API name API version ProvMnS OpenAPI version Configuration management API 1.0.0 17.5.0 ETSI ETSI TS 104 231 V8.0.0 (2026-03) 164 A.4.1.3 Adaptations and Exceptions Table A.4.1.3-1 lists exceptions and adaptations related to HTTP methods when re-using the TS28532_ProvMnS_API in the context of the present document. Table A.4.1.3-1: HTTP methods exceptions and adaptations when reusing the TS28532_ProvMnS_API HTTP Methods Reference Attributes Exceptions/Adaptations PUT ETSI TS 128 532 [20], clause A.1.1 HTTP operation not required to be supported in current version. POST ETSI TS 128 532 [20], clause A.1.1 HTTP operation not required to be supported in current version. DELETE ETSI TS 128 532 [20], clause A.1.1 HTTP operation not required to be supported in current version. A.4.2 Fault management API A.4.2.1 Introduction The Open API for this service is reusing the provisioning management service API as specified in clause A.4.2.2 with exceptions specified in clause A.4.2.3 below. A.4.2.2 Fault management API The Open API for the fault management API specified in clause 8.1 reuses the Provisioning management service API (TS28111_FaultNrm.yaml) as specified in ETSI TS 128 111 [26], clause A.1.3. The API version of the fault management API as specified in clause 8.2.2 shall use the FaultNRM service OpenAPI version as specified in Table A.4.2.2-1. Table A.4.2.2-1 API name API version FaultNrm OpenAPI Fault management API 1.0.0 18.1.0 A.4.2.3 Adaptations and Exceptions NOTE: The adaptations and exceptions are not specified in the present document. A.4.3 Configuration schema information API A.4.3.1 Introduction The Open API for the Configuration schema information API is specified in clause A.4.3.2. A.4.3.2 Configuration schema information API openapi: 3.0.3 info: title: 'Configuration Schema information API' version: 1.0.0-alpha.1 description:This API enables the API Consumer to retrieve configuration schema information based on the procedure defined in R1GAP [5]. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 165 url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/ran-oam-cm-schema-info/v1' variables: apiRoot: description: 'apiRoot as defined in clause 10.3 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: '/schemas': get: summary: Get all schema information description: 'Retrieves configuration schema information' responses: '200': description: 'The results with the schema information' content: application/json: schema: type: array items: $ref:'#/components/schemas/Schema' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/schemas/{schemaId}': get: summary: Get individual schema information parameters: - name: schemaId in: path required: true description: Where schemaId = "name" (for latest revision or if revision is not available) or "name@revision" for a specific revision. schema: type: string responses: '200': description: The results with the schema information matching the request. content: application/json: schema: $ref: '#/components/schemas/Schema' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 166 '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: Schema: type: object required: - name - location - type properties: name: type: string description: The unique name of the schema. revision: type: string description: The unique revision of the schema. location: type: string format: uri description: Location of where to find the schema content. type: $ref: '#/components/schemas/SchemaType' description:This data type is designed to provide extensibility. As specified in clause 8.3.8.2.3.1, Only YANG is supported in the present version of the present document. namespace: type: string description: The namespace of the schema, (See NOTE 1, clause 8.3.8.2.3.1, only applicable if type is YANG). features: type: array items: type: string description: List of supported features (See NOTE 1,clause 8.3.8.2.3.1, only applicable if type is YANG). deviations: type: array items: type: string description: List of schema deviation(s) (See NOTE 1,clause 8.3.8.2.3.1, only applicable if type is YANG). SchemaType: type: string enum: - YANG description: Enumeration of schema types. A.5 A1 related service A.5.1 A1 policy management API A.5.1.1 Introduction The Open API for the A1 policy management API is specified in clause A.5.1.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 167 A.5.1.2 A1 policy management API openapi: 3.0.3 info: title: 'A1 policy management API' version: 1.0.0 description: | API for A1 policy management service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/a1-policy-management/v1' variables: apiRoot: description: 'apiRoot as defined in clause 5.3 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: '/policy-types': get: description: 'To query A1 policy type identifier' tags: - All A1 policy types parameters: - name: nearRtRicId in: query description: 'The identifier of Near-RT RIC' schema: type: string - name: typeName in: query description: 'The unique label of the policy type' schema: type: string responses: '200': description: 'Success case 200 with queried information' content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyTypeInformation' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/policy-types/{policyTypeId}': parameters: - name: policyTypeId in: path required: true schema: $ref: '#/components/schemas/policyTypeId' get: description: 'To query A1 policy type' tags: - Individual A1 policy type responses: '200': description: 'Success case 200 with queried information' content: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 168 application/json: schema: $ref: '#/components/schemas/PolicyTypeObject' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/policies': get: description: 'To query A1 policy type' tags: - All A1 policies parameters: - name: nearRtRicId in: query description: 'The identifier of Near-RT RIC' schema: type: string - name: policyTypeId in: query description: 'The identifier of the policy' schema: type: string responses: '200': description: 'Success case 200 with queried information' content: application/json: schema: type: array items: $ref: '#/components/schemas/PolicyInformation' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' post: description: 'To create A1 policies' tags: - All A1 policies requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PolicyObjectInformation' responses: '201': description: 'Success case 201 created' content: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 169 application/json: schema: $ref: '#/components/schemas/PolicyObjectInformation' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/policies/{policyId}': parameters: - name: policyId in: path required: true schema: $ref: '#/components/schemas/policyId' put: description: 'To update a created policy' tags: - Individual A1 policy requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/PolicyObject" responses: 200: description: 'The policy was updated' content: application/json: schema: "$ref": "#/components/schemas/PolicyObject" '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '411': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/411' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': ETSI ETSI TS 104 231 V8.0.0 (2026-03) 170 $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' get: description: 'To query created A1 policy' tags: - Individual A1 policy responses: '200': description: 'Success case 200 with queried information' content: application/json: schema: $ref: '#/components/schemas/PolicyObject' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' delete: description: 'To delete the created A1 policy' tags: - Individual A1 policy responses: '204': description: 'The created A1 policy was deleted' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/policies/subscriptions': post: summary: Create a new A1 policy status subscription description: This operation creates a new subscription for receiving A1 policy status notifications. tags: - A1 policy status subscription requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PolicyStatusSubscription' responses: '201': description: 'Success case 201 created' content: application/json: schema: $ref: '#/components/schemas/PolicyStatusSubscription' headers: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 171 Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/policies/subscriptions/{subscriptionId}': parameters: - name: subscriptionId in: path required: true schema: $ref: '#/components/schemas/subscriptionId' get: summary: Get details of an A1 policy status subscription description: This operation retrieves information about a specific subscription. tags: - A1 policy status subscription responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyStatusSubscription' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' put: description: 'This operation modifies an existing subscription.' tags: - A1 policy status subscription requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/PolicyStatusSubscription" responses: 200: description: 'The policy was updated' content: application/json: schema: "$ref": "#/components/schemas/PolicyObject" '400': ETSI ETSI TS 104 231 V8.0.0 (2026-03) 172 $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '411': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/411' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' delete: summary: Delete an A1 policy status subscription description: This operation removes a subscription. tags: - A1 policy status subscription responses: '204': description: No Content components: schemas: policyTypeId: description: 'Policy Type identifier as defined in A1AP [23], clause 6.2.3.1.3' type: string policyId: description: 'Policy Identifier of a policy' type: string NearRtRicId: description: 'Near-RT RIC identifier' type: string subscriptionId: description: 'subscription identity of the policy' type: string PolicyObject: description: 'Policy Object is a JSON representation of an A1 policy; the A1 policies are specified in A1TD [24]' type: object PolicyTypeObject: description: 'policy type object as defined in A1TD' type: object PolicyTypeInformation: description: 'Available policy types and for each policy type identifier the Near-RT RIC identifiers of those Near-RT RICs that support the related A1 policy type' type: object properties: policyTypeId: description: 'Identity of the policy type' type: string nearRtRicId: $ref: '#/components/schemas/NearRtRicId' required: ["policyTypeId","nearRtRicId"] PolicyInformation: description: 'Near-RT RIC identifiers where A1 policies exist and for each Near-RT RIC identifier the policy identifiers of those policies that exist in that Near-RT RIC' type: object properties: policyId: description: $ref: '#/components/schemas/policyId' nearRtRicId: $ref: '#/components/schemas/NearRtRicId' required: ["policyId","nearRtRicId"] PolicyObjectInformation: description: 'Information related to the creation of the policy' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 173 type: object properties: policyObject: description: 'Policy Object is a JSON representation of an A1 policy; the A1 policies are specified in A1TD [24]' type: object nearRtRicId: $ref: '#/components/schemas/NearRtRicId' policyTypeId: $ref: "#/components/schemas/policyTypeId" required: ["policyObject","nearRtRicId"] PolicyStatusSubscription: description: 'PolicyStatusSubscription data type represents the subscription information of A1 policy status' type: object properties: subscriptionScope: $ref: '#/components/schemas/QueryFilter' notificationDestination: type: URI description: URI for policy status notifications policyIdList: type: array items: $ref: '#/components/schemas/policyId' policyTypeIdList: type: array items: $ref: '#/components/schemas/ policyTypeId nearRtRicIdList: type: array items: $ref: '#/components/schemas/ nearRtRicId QueryFilter: type: string enum: - OWN #'indicate the A1 policies created by API Consumer ' - OTHERS #'indicate the A1 policies created other API Consumers' - ALL #'indicate the A1 policies created by any API Consumers' A.6 AI/ML workflow service A.6.1 AI/ML model registration API A.6.1.1 Introduction The Open API for the AI/ML model registration API is specified in clause A.6.1.2. A.6.1.2 AI/ML model registration API openapi: 3.0.3 info: title: 'AI/ML Model registration API ' version: 1.0.0 description: API for registering an AI/ML model| API for AI/ML Model registration service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/ai-ml-model-registration/{apiVersion}' paths: '/model-registrations': post: description: 'Register a new AI/ML model' tags: - Registered AI/ML Model registration details requestBody: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 174 required: true content: application/json: schema: $ref: '#/components/schemas/ModelRelatedInformation' responses: '201': description: 'Success case 201 created' content: application/json: schema: $ref: '#/components/schemas/ModelRelatedInformation' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/model-registrations/{modelRegistrationId}': get: summary: Get details of a registered AI/ML model parameters: - in: path name: modelRegistrationId required: true schema: type: string responses: '200': description: AI/ML model details retrieved successfully content: application/json: schema: $ref: '#/components/schemas/ModelRelatedInformation' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': ETSI ETSI TS 104 231 V8.0.0 (2026-03) 175 $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' put: summary: Update information of a registered AI/Ml model parameters: - in: path name: modelRegistrationId required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ModelRelatedInformation' responses: '200': description: AI/ML model information updated successfully content: application/json: schema: $ref: '#/components/schemas/ModelRelatedInformation' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' delete: summary: Deregister an AI/ML model parameters: - in: path name: modelRegistrationId required: true schema: type: string responses: '204': description: AI/ML model deregistered successfully '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 176 components: schemas: ModelRelatedInformation: type: object properties: modelId: $ref: '#/components/schemas/ModelId' description: type: string modelInformation: $ref: '#/components/schemas/ModelInformation' modelLocation: type: string format: uri required: - modelId - description - modelInformation ModelId: type: object description: 'Identifier of a model' properties: modelName: type: string description: 'name of AI/ML model as specified in R1GAP' modelVersion: type: string description: 'version of AI/ML model as specified in R1GAP' artifactVersion: type: string format: uri description: 'artifact version of AI/ML model as specified in R1GAP' required: - modelName - modelVersion ModelInformation: type: object properties: metadata: description: 'Meta data of AI/Ml Model' $ref: '#/components/schemas/MetaData' inputDataType: type: array description: 'Input data type for the model, the structure of dataTypeId is specified in clause 7.1.8' items: $ref: 'O-RAN.WG2.R1AP_DataRegistration.yaml#/components/schemas/DataTypeId' # DataTypeId is specified (clause 7.1.8) outputDataType: type: array description: 'Output data type for the model, the structure of dataTypeId is specified in (clause 7.1.8)' items: $ref: 'O-RAN.WG2.R1AP_DataRegistration.yaml#/components/schemas/DataTypeId' # DataTypeId is specified (clause 7.1.8) targetEnvironment: type: array description: 'Information on the target environment is required for deployment of an AI/ML model' items: $ref: '#/components/schemas/TargetEnvironment' required: - metadata - inputDataType - outputDataType MetaData: type: object properties: author: type: string description: 'Author of an AI/ML model' owner: type: string required: - author TargetEnvironment: type: object properties: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 177 platformName: type: string description: 'Name of the platform' environmentType: type: string description: 'Name of the platform execution service type, and this is dependent on the platformName' dependencyList: type: string format: uri description: 'Location to the template that has all the list of dependencies platform must provide needs to be installed for the model. (for example, scikit-learn 0.21.3)' required: - platformName - environmentType - dependencyList A.6.2 AI/ML model discovery API A.6.2.1 Introduction The Open API for the AI/ML model discovery API is specified in clause A.6.2.2. A.6.2.2 AI/ML model discovery API openapi: 3.0.3 info: title: 'AI/ML Model discovery API' version: 1.0.0 description: | API for AI/Ml Model discovery service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/ai-ml-model-discovery/v1' variables: apiRoot: description: 'apiRoot as defined in clause 10.3 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: '/models': get: description: 'This operation retrieves all registered AI/ML models' parameters: - name: model-name in: query description: 'name of the model as specified in R1GAP[5]' schema: type: string - name: model-version in: query description: 'name of the model as specified in R1GAP[5]' schema: type: string responses: '200': description: 'The response body contains the result of the search over the list of ModelRelatedInformation that includes the modelId and metadata..' content: application/json: schema: type: array items: $ref: '#/components/schemas/ModelRelatedInformation' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': ETSI ETSI TS 104 231 V8.0.0 (2026-03) 178 $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '414': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/414' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' tags: - AI/ML Model Discovery components: schemas: ModelRelatedInformation: type: object description: "The ModelRelatedInformation data type represents registration information for an AI/ML model." required: - modelId - metadata properties: modelId: $ref: 'O-RAN.WG2.R1AP_AI/Ml_model_registrtaion_API.yaml/components/schemas/ModelId' description: "Identifier of a model as specified in clause 10.1.8.1.3" metadata: type: string description: "Description of the AIML model that includes the AI/ML model related information and training related information." A.6.3 AI/ML model training API A.6.3.1 Introduction The Open API for the AI/Ml model API is specified in clause A.6.3.2. A.6.3.2 AI/ML model training API openapi: 3.0.3 info: title: 'AI/ML Model Training API' version: 1.0.0-alpha.1 description: | API for AI/Ml Model training service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/ai-ml-model-training/v1' variables: apiRoot: description: 'apiRoot as defined in clause 10.3 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: '/training-jobs': post: summary: Create a new AI/ML model training job tags: - Creation of AI/ML model training job requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/TrainingJobDescription" ETSI ETSI TS 104 231 V8.0.0 (2026-03) 179 responses: '201': description: 'Success case 201 created' content: application/json: schema: $ref: '#/components/schemas/TrainingJobInfo' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '405': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/405' '409': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/409' '413': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/413' '415': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/415' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/training-jobs/{trainingJobId}': delete: summary: 'Delete an AI/ML model training job' tags: - Delete AI/ML model training job responses: '204': description:'The AI/ML model training job wasI/ML deleted' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' '/training-jobs/{trainingJobId}/status': get: summary: Get the status of an AI/ML model training job tags: - Status of AI/ML model training job parameters: - in: path name: trainingJobId required: true schema: type: string responses: '200': description: 'Training job status retrieved successfully' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 180 content: application/json: schema: type: array items: $ref: '#/components/schemas/TrainingJobStatus' '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '406': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/406' '429': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/429' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' '502': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/502' '503': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/503' components: schemas: TrainingJobDescription: type: object properties: modelId: $ref: "#O-RAN.WG2.R1AP_ai_ml_model_registration.yaml/components/schemas/modelId" description: "The model identifier which contains model name, model version, and artifact version see clause 10.1.8.1.3-1 in R1AP." modelLocation: type: string format: uri description: "Location of the AI/ML model." trainingDataset: type: string format: uri description: "Information for reference to the training dataset." validationDataset: type: string format: uri description: "Information for reference to the validation dataset." trainingConfig: type: object description: "Configuration of AI/ML model training based on training service producer specific trainingConfigSchema." notificationDestination: type: string format: uri description: "Callback URI where the notification should be delivered to." consumerRAppId: type: string description: "rAppId of the training service consumer rApp." producerRAppId: type: string description: "rAppId of the training service producer rApp." required: - modelId A.6.4 AI/ML model deployment API A.6.4.1 Introduction The Open API for the AI/Ml model deployment API is specified in clause A.6.4.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 181 A.6.4.2 AI/ML model deployment API openapi: 3.0.3 info: title: 'AI/ML Model Deployment API' version: 1.0.0-alpha.1 description: | API for AI/ML Model Deployment service. © 2025, O-RAN ALLIANCE. All rights reserved. externalDocs: description: 'O-RAN.WG2.R1AP-v08.00' url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/ai-ml-model-deployment/v1' variables: apiRoot: description: 'apiRoot as defined in clause 5.2 in O-RAN.WG2.R1AP' default: 'https://example.com' paths: '/model-deployments': post: summary: Request AI/ML model deployment tags: - Request AI/ML model deployment requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ModelDeploymentInformation' responses: '201': description: 'AI/ML model deployment created successfully' content: application/json: schema: $ref: '#/components/schemas/ModelDeploymentInformation' headers: Location: description: 'URI of the created deployment resource' required: true schema: type: string '400': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/400' '401': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/401' '403': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/403' '404': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/404' '500': $ref: 'O-RAN.WG2.R1AP_Common.yaml#/components/responses/500' components: schemas: ModelDeploymentInformation: type: object properties: modelId: $ref: '#/components/schemas/ModelId' description: 'Unique identifier for the AI/ML model.' deploymentLocation: type: string format: uri description: 'URI for the deployment location.' deploymentConfig: type: object description: 'Configuration parameters for AI/ML model deployment. required: - modelId - deploymentLocation DeploymentStatus: type: object properties: ETSI ETSI TS 104 231 V8.0.0 (2026-03) 182 deploymentId: type: string description: 'Identifier for the AI/ML model deployment.' status: type: string description: 'Current status of the deployment.' details: type: string description: 'Additional details about the deployment status.' ETSI ETSI TS 104 231 V8.0.0 (2026-03) 183 Annex B (normative): Common data types for R1 service APIs B.1 Introduction In the subsequent clauses, common data types for the following areas are defined: • Generic usage. • Service management and exposure. • Data management and exposure. • RAN OAM. B.2 Common data types for generic usage B.2.1 Introduction This clause defines common data types for generic usage. B.2.2 Simple data types Table B.2.2-1: Simple data types for generic use Type name Type Definition Description Uri string A string formatted according to IETF RFC 3986 [8]. B.2.3 Enumeration B.2.3.1 Void B.2.4 Structured data types B.2.4.1 Data type: ProblemDetails The ProblemDetails structure is specified in Table B.2.4.1-1. It is based on IETF RFC 7807 [10] and shall comply with the provisions defined there. Table B.2.4.1-1: Definition of type ProblemDetails Attribute name Data type P Cardinality Description type string O 0..1 URI reference according to IETF RFC 3986 [8] that identifies the problem type. title string O 0..1 Human-readable summary of the problem type. status number O 0..1 The HTTP status code. detail string O 0..1 Human-readable explanation. instance string O 0..1 URI reference that identifies the specific occurrence of the problem. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 184 B.2.4.2 Void B.2.4.3 Void B.2.4.4 Void B.2.5 Re-used data types Re-used data types are not defined in the present document. B.3 Common data types for Service management and exposure B.3.1 Introduction This clause defines common data types for usage in the service management and exposure APIs. Clause B.3.5 references and profiles data types defined in external specifications and defines restrictions on and adaptations of these data type for their usage within the context of the service management and exposure APIs. B.3.2 Simple data types None. B.3.3 Enumerations None. B.3.4 Structured data types B.3.4.1 Data type: VersionExtensions The VersionExtensions data structure specified in Table B.3.4.1-1 defines extensions to the CAPIF "Version" data type which allows to signal the versions supported for an interface endpoint. Table B.3.4.1-1: Definition of type VersionExtensions Attribute name Data type P Cardinality Description fullApiVersions array(string) M 1..N List of version strings, as defined in clause 5.2, to signal the API versions supported by the API Producer for a particular major API version. B.3.4.2 Data type: ServiceProperties The ServiceProperties data structure specified in Table B.3.4.2-1 defines a container to be used to register and discover service-specific properties of individual service APIs. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 185 Table B.3.4.2-1: Definition of type ServiceProperties Attribute name Data type P Cardinality Description serviceCapabilities object M 0..1 Service capabilities. The content of this attribute is service-specific and is defined per service. B.3.5 Re-used data types Table B.3.5-1 references data types that are reused from external documents by the service management and exposure APIs and defines restrictions on and adaptations of these data type for their usage within the context of the service management and exposure APIs. NOTE: All externally-defined data types that are directly used in request or response message content of the service management and exposure APIs (such as ServiceAPIDescription) are listed below. In addition, those externally-defined data types are listed that are descendants of a directly used data type and for which restrictions and adaptations are defined in the present document. Other external descendant data types are not listed, as they are referenced directly in the external specification. Table B.3.5-1: Re-used data types Data type Reference Comments Applicability ServiceAPIDescription ETSI TS 129 222 [9], clause 8.2.4.2.2 The following attributes are not applicable in the context of the R1 SME services and therefore need not be supported: "supportedFeatures", "shareableInfo", "serviceAPICategory", "ccfId", "apiSuppFeats", "pubApiPath". InterfaceDescription ETSI TS 129 222 [9], clause 8.2.4.2.3 The CAPIF feature "ExtendedIntfDesc" shall be supported. AefProfile ETSI TS 129 222 [9], clause 8.2.4.2.4 The AEF profile holds information related to the discoverable APIs produced by a single API Producer. In case the API Producer is an rApp, the "aefId" attribute shall contain the value of the rAppID. The following attributes are not applicable in the context of the R1 SME services and need therefore not be supported: "aefLocation", "domainName""serviceKpis", and "ueIpRange". Version ETSI TS 129 222 [9], clause 8.2.4.2.5 The following additional attribute shall be supported: "vendorSpecific-o-ran.org" of type VersionsList as specified in clause B.3.4.1, to signal the full API versions supported. CAPIFEvent ETSI TS 129 222 [9], clause 8.3.4.3.3 The enumeration values "SERVICE_API_AVAILABLE", "SERVICE_API_UNAVAILABLE" and "SERVICE_API_UPDATE" shall be supported. The remaining enumeration values are not applicable in the context of the R1 SME services and therefore need not be supported. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 186 B.4 Common data types for Data Management and Exposure B.4.1 Introduction This clause defines common data types for DME usage. B.4.2 Simple data types Table B.4.2-1: Simple data types Type Name Type Definition Description DmeTypeId string A DME type Id is constructed based on the three parts separated by ":" (colon): {dataTypeId} = {namespace}:{name}:{version}. See clause B.4.4.1 for the definition of "namespace", "name" and "version". B.4.3 Enumerations B.4.3.1 Enumeration: DataDeliveryMethod Table B.4.3.1-1: Enumeration: DataDeliveryMethod Enumeration value Description STREAMING_KAFKA Kafka based streaming delivery mechanism as defined in R1TP [7], clause 6. PULL_HTTP HTTP based pull delivery mechanism as defined in clause 7.5. PUSH_HTTP HTTP based push delivery mechanism as defined in clause 7.4. B.4.4 Structured data types B.4.4.1 Data type: DmeTypeIdStruct The DmeTypeIdStruct data type contains the attributes defined in Table B.4.4.1-1. Table B.4.4.1-1: Definition of type DmeTypeIdStruct Attribute Name Data type P Cardinality Description namespace string M 1 Indicating the entity responsible for the DME type definition. name string M 1 Name of the DME type. The string shall not contain the colon ":" character. version string M 1 Version of the DME type. The versioning and allowed characters are according to SemVer [11]. B.4.4.2 Data type: DataDeliveryMechanism The DataDeliveryMechanism data type contains the attributes defined in Table B.4.4.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 187 Table B.4.4.2-1: Definition of type DataDeliveryMechanism Attribute Name Data type P Cardinality Description dataDeliveryMethod DataDeliveryMethod M 1 Delivery method supported by a Data Producer. See clause B.4.3.1. kafkaDeliveryConfiguration KafkaDeliveryConfiguration C 0..1 See clause B.4.4.3 (see note). NOTE: This attribute shall be presented if the "deliveryMethod" attribute is set to STREAMING_KAFKA. B.4.4.3 Data type: KafkaDeliveryConfiguration The KafkaDeliveryConfiguration data type contains the attributes defined in Table B.4.4.3-1. Table B.4.4.3-1: Definition of type KafkaDeliveryConfiguration Attribute Name Data type P Cardinality Description numPartitions integer O 0..1 Number of partitions. cleanUpPolicy string M 1 cleanUpPolicy is based on cleanup.policy defined in the Kafka Documentation [15]. compressionType string M 1 compressionType is based on compression.type defined in the Kafka Documentation [15]. retentionBytes integer C 0..1 retentionBytes is based on retention.bytes defined in the Kafka Documentation [15]. retentionMs integer C 0..1 retentionMs is based on retention.ms defined in the Kafka Documentation [15]. NOTE: Presence condition "C" this attribute may be included when cleanUpPolicy is set to DELETE. B.4.5 Re-used data types Re-used data types are not defined in the present document. B.5 Common data types for RAN OAM related services B.5.1 Introduction This clause defines common data types for usage in the RAN OAM related service APIs. Clause B.5.5 references and profiles data types defined in external specifications and defines restrictions on and adaptations of these data type for their usage within the context of the RAN OAM related APIs. B.5.2 Simple data types None. B.5.3 Enumerations None. B.5.4 Structured data types None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 188 B.5.5 Re-used data types Table B.5.5-1 references data types that are reused from external documents by the RAN OAM related service APIs and defines restrictions on and adaptations of these data type for their usage within the context of the RAN OAM related APIs. NOTE: All externally defined data types that are directly used in request or response message content of the RAN OAM related service APIs are listed below. In addition, those externally defined data types are listed that are descendant of a directly used data type and for which restrictions and adaptations are defined in the present document. Other external ancestor data types are not listed, as they are referenced directly in the external specification. Table B.5.5-1: Re-used data types Data type Reference Comments Applicability Resource ETSI TS 128 532 [20], clause 12.1.1.4.1a.1 All the attributes are supported. Scope ETSI TS 128 532 [20], clause 12.1.1.4.1a.2 All the attributes are supported. PatchItem ETSI TS 128 532 [20], clause 12.1.1.4.1a.9 All the attributes are supported. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 189 Annex C (informative): Bibliography • ETSI GS NFV-SOL 015 (V1.2.1): "Protocols and Data Models; Specification of Patterns and Conventions for RESTful NFV-MANO APIs". ETSI ETSI TS 104 231 V8.0.0 (2026-03) 190 Annex D (informative): Change history Date Version Information about changes 2025.03.14 V08.00 Published with updating the Bootstrap API, RAN OAM CM API's, RAN OAM FM API's, Adding Configuration schema information API, AI/ML Model deployment API, AI/Ml model retrieve API, Updates to AI/ML model registration API, AI/Ml model discovery API and AI/ML model training API. 2024.11.21 V07.00 Published with migration of all API's from Release 17 to Release 18 of 3GPP, Updated the A1 Policy management API and Model discovery API and moved the same to release version, Updated the Data registration API, Data access API and Data offer API by removing the consumerId from the uri structure. 2024.07.18 V06.00 Published with addition of Bootstrap API in SME, AI/ML model registration, AI/ML model discovery, AI/ML model training API in AI/ML workflow service, Updated A1 policy management API, Uplifted all the DME, AI/ML,A1 policy management APIs in compliance with 29.501 URI Structure, and generalized the DME API to support further enhancements. Updated the naming of data type to DME type. 2024.03.18 V05.00 Published with addition of A1 policy management API, RAN OAM CM and FM API, updates to data registration API and removing alpha indicator for data registration API. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 191 History Version Date Status V8.0.0 March 2026 Publication |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.