hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.5 Resource: "Individual A1 policy" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.5.1 Description | The resource Individual A1 policy represents an A1 policy created by the A1 policy management service. Only the methods defined in clause 9.1.5.5.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.5.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policies/{policyId} The resource URI variables supported by the resource are defined in Table 9.1.5.5.2-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 110 Table 9.1.5.5.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 9.1.2. policyId Policy Identifier of the policy as defined in A1AP [23]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.5.3 Resource Standard Methods | 9.1.5.5.3.1 PUT This method shall support the request data structures specified in Table 9.1.5.5.3.1-1 and the response data structure and response codes specified in Table 9.1.5.5.3.1-2. Table 9.1.5.5.3.1-1: Data structures supported by the HTTP PUT request body on this resource Data type P Cardinality Description PolicyObject M 1 Update the Policy. Table 9.1.5.5.3.1-2: Data structures supported by the HTTP PUT response body on this resource Data type P Cardinality Response codes Description PolicyObject M 1 200 OK Confirmation of updated policy. ProblemDetails O 0..1 4xx/5xx Detailed problem description. 9.1.5.5.3.2 GET This method shall support the request data structures specified in Table 9.1.5.5.3.2-1 and the response data structures and response codes specified in Table 9.1.5.5.3.2-2. Table 9.1.5.5.3.2-1: Data structures supported by the HTTP GET request body on this resource Data type P Cardinality Description N/A 0 There is no object in the message content of a GET request. Table 9.1.5.5.3.2-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description PolicyObject M 1 200 OK Requested policy object. ProblemDetails O 0..1 4xx/5xx Detailed problem description. 9.1.5.5.3.3 DELETE This method shall support the request data structures specified in Table 9.1.5.5.3.3-1 and the response data structures and response codes specified in Table 9.1.5.5.3.3-2. Table 9.1.5.5.3.3-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. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 111 Table 9.1.5.5.3.3-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 | 9.1.5.5.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.6 Resource: "Individual A1 policy status" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.6.1 Description | The resource Individual A1 policy status represents the status of an A1 policy that is available in the A1 policy management service. Only the methods defined in clause 9.1.5.6.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.6.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policies/{policyId}/status The resource URI variables supported by the resource are defined in Table 9.1.5.6.2-1. Table 9.1.5.6.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 9.1.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.6.3 Resource Standard Methods | 9.1.5.6.3.1 GET This method shall support the request data structures specified in Table 9.1.5.6.3.1-1 and the response data structures and response codes specified in Table 9.1.5.6.3.1-2. Table 9.1.5.6.3.1-1: Data structures supported by the HTTP GET request body on this resource Data type P Cardinality Description N/A 0 There is no object in the message content of a GET request. Table 9.1.5.6.3.1-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description PolicyStatusObject M 1 200 OK Requested policy status object as defined in A1TD [24], clause 6.4.2. ProblemDetails O 0..1 4xx/5xx Detailed problem description. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.6.4 Resource Custom Operations | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 112 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.7 Resource: "All A1 policy status subscriptions" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.7.1 Description | The resource represents the subscriptions for A1 policy status notifications. The methods defined in clause 9.1.5.7.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.7.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policies/subscriptions The resource URI variables supported by the resource are defined in Table 9.1.5.7.2-1. Table 9.1.5.7.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 9.1.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.7.3 Resource Standard Methods | 9.1.5.7.3.1 POST This method shall support the request data structures specified in Table 9.1.5.7.3.1-1 and the response data structures and response codes specified in Table 9.1.5.7.3.1-2 and the HTTP headers specified in Table 9.1.5.7.3.1-3. Table 9.1.5.7.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description PolicyStatusSubscription M 1 Information of A1 Policy status subscription information. Table 9.1.5.7.3.1-2: Data structures supported by the POST response body on this resource Data Type P Cardinality Response codes Description PolicyStatusSubscription M 1 201 Created The operation was successful. The message content of the POST response contains a PolicyStatusSubscriptionInfo representing the created resource. ProblemDetails O 0..1 4xx/5xx The operation was unsuccessful. Detailed problem description may be carried in the response message content. Table 9.1.5.7.3.1-3: Headers supported by the 201-response code on the resource Name Data type P Cardinality Description Location String M 1 Contains the URI of the newly created "Individual A1 policy status subscription" resource as defined in clause 9.1.5.5.2 with subscriptionId in the URI. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.7.4 Resource Custom Operations | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 113 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.8 Resource: "Individual A1 policy status subscription" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.8.1 Description | The resource represents a subscription for A1 policy status notifications. The methods defined in clause 9.1.5.8.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.8.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policies/subscriptions/{subscriptionId} The resource URI variables supported by the resource are defined in Table 9.1.5.8.2-1. Table 9.1.5.8.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 9.1.2. subscriptionId Identifier of subscription. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.8.3 Resource Standard Methods | 9.1.5.8.3.1 PUT This method shall support the request data structures specified in Table 9.1.5.8.3.1-1 and the response data structure and response codes specified in Table 9.1.5.8.3.1-2. Table 9.1.5.8.3.1-1: Data structures supported by the HTTP PUT request body on this resource Data type P Cardinality Description PolicyStatusSubscription M 1 Updated Policy status subscription information. Table 9.1.5.8.3.1-2: Data structures supported by the HTTP PUT response body on this resource Data type P Cardinality Response codes Description PolicyStatusSubscription M 1 200 OK Confirmation of updated policy status subscription. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. 9.1.5.8.3.2 GET This method shall support the request data structures specified in Table 9.1.5.8.3.2-1 and the response data structures and response codes specified in Table 9.1.5.8.3.2-2. Table 9.1.5.8.3.2-1: Data structures supported by the HTTP GET request body on this resource Data type P Cardinality Description N/A 0 There is no object in the message content of a GET request. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 114 Table 9.1.5.8.3.2-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description PolicyStatusSubscri ption M 1 200 OK Requested policy status subscription information associated with the subscriptionId has been queried successfully and the response contains the PolicyStatusSubscriptionInfo as representation of the queried resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. 9.1.5.8.3.3 DELETE This method shall support the request data structures specified in Table 9.1.5.8.3.3-1 and the response data structures and response codes specified in Table 9.1.5.8.3.3-2. Table 9.1.5.8.3.3-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 9.1.5.8.3.3-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 The operation has failed, and the message content may contain Problem description details. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.8.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.7 Notifications | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.7.1 Resource: Policy status change notifications | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.7.1.1 Description | The resource represents the destination for A1 policy status change notifications. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.7.1.2 Resource Definition | The resource URI (notificationDestination) is provided when subscribing to A1 policy status notifications. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.7.1.3 Resource Standard Methods | 9.1.7.1.3.1 POST This method shall support the request data structures specified in Table 9.1.7.1.3.1-1 and the response data structure and response codes specified in Table 9.1.7.1.3.1-2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 115 Table 9.1.7.1.3.1-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description A1PolicyStatusChange Notification M 1 Notify policy status change as specified in clause 9.1.8.1.6. Table 9.1.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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.1 Overview | The following clause defines the structured data types and their attributes to be used by the A1 policy management API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.2 Data type: PolicyTypeInformation | The PolicyTypeInformation data type represents a pair of policy type identifier and related Near-RT RIC identifier. It contains the attributes defined in Table 9.1.8.1.2-1. Table 9.1.8.1.2-1: Definition of type PolicyTypeInformation Attribute Name Data type P Cardinality Description policyTypeId string M 1 Policy Type identifier as defined in A1AP [23], clause 6.2.3.1.3. nearRtRicId NearRtRicId M 1 Near-RT RIC identifier. The data model for the data types transported is defined in A1TD [24]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.3 Data type: PolicyInformation | The PolicyInformation data type represents a pair of policy identifier and related Near-RT RIC identifier. It contains the attributes defined in Table 9.1.8.1.3-1. Table 9.1.8.1.3-1: Definition of type PolicyInformation Attribute Name Data type P Cardinality Description policyId string M 1 Policy Identifier of a policy as defined in A1AP [23]. nearRtRicId NearRtRicId M 1 Near-RT RIC identifier. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.4 Data type: PolicyObjectInformation | The PolicyObjectInformation data type represents a policy object, related Near-RT RIC identifier and optional policy type identifier. It contains the attributes defined in Table 9.1.8.1.4-1. Table 9.1.8.1.4-1: Definition of type PolicyObjectInformation Attribute Name Data type P Cardinality Description policyObject object M 1 Policy Object is a JSON representation of an A1 policy; the A1 policies are specified in A1TD [24]. nearRtRicId NearRtRicId M 1 Near-RT RIC identifier. policyTypeId PolicyTypeId O 0..1 policy type identifier as defined in A1AP [23]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 116 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.5 Data type: PolicyStatusSubscription | The PolicyStatusSubscription data type represents the subscription information of A1 policy status. It contains the attributes defined in Table 9.1.8.1.5-1. Table 9.1.8.1.5-1: Definition of type PolicyStatusSubscription Attribute Name Data type P Cardinality Description subscriptionScope QueryFilter C 1 See clause 9.1.8.3.3.1. See notes 2, 4, 6, 8 and 10. notificationDestination URI M 1 Call back URI for A1 policy status notifications policyIdList array(policyId) C 1..N List of identifiers of A1 policies as defined in clause 6.2.6 of A1AP [23]. See notes 1, 3 and 4. policyTypeIdList array(policyTypeId) C 1..N List of A1 policy type identifiers as defined in clause 9.1.5.4.3.1 See notes 1, 5, 6, 9 and 10. nearRtRicIdList array(NearRtRicId) C 1..N List of Near-RT RIC identifiers as defined in clause 9.1.5.4.3.1. See notes 1, 7, 8, 9 and 10. NOTE 1: It is conditionally optional to include either a policyIdList; or a policytypeIdList; or a nearRtRicIdList; or a policytypeIdList and a nearRtRicIdList; or none of the lists. NOTE 2: If neither policyidList nor policytypeIdList nor nearRtRicIdList is provided, then a subscriptionScope shall be provided. NOTE 3: If a policyIdList is provided, the subscription is for the status of the indicated A1 policies. NOTE 4: If a policyIdList is provided then subscriptionScope shall not be provided. NOTE 5: If a policytypeIdList is provided, the subscription is for the status of A1 policies of the indicated A1 policy types. NOTE 6: If both policytypeIdList and subscriptionScope are provided, then the subscription is for the status of A1 policies of the indicated A1 policy types that fulfill the subscriptionScope. NOTE 7: If a nearRtRicIdList is provided, the subscription is for the status of A1 policies created in the indicated Near- RT RICs. NOTE 8: If both nearRtRicIdList and subscriptionScope are provided, then the subscription is for the status of A1 policies created in the indicated Near-RT RICs that fulfill the subscriptionScope. NOTE 9: If both policytypeIdList and nearRtRicIdList are provided, then the subscription is for the status of A1 policies of the indicated A1 policy types created in the indicated Near-RT RICs. NOTE 10: If policytypeIdList, nearRtRicIdList and subscriptionScope are provided, then the subscription is for the status of A1 policies of the indicated A1 policy types created in the indicated Near-RT RICs that fulfill the subscriptionScope. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.6 Data type: A1PolicyStatusChangeNotification | Table 9.1.8.1.6-1: Definition of type A1PolicyStatusChangeNotification Attribute Name Data type P Cardinality Description subscriptionId SubscriptionId M 1 Identifier of Subscription as specified in clause 9.1.5.5.2. policyStates array(SubscriptionSta tusObject) M 1..N List of policy states to be notified about. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.1.7 Data type: SubscriptionStatusObject | Table 9.1.8.1.7-1: Definition of type SubscriptionStatusObject Attribute Name Data type P Cardinality Description policyId PolicyId M 1 Policy identifier as specified in clause 6.2.6 of A1AP [23]. policyStatusObject PolicyStatusObject M 1..N Policy status object as specified in clause 6.4.2 of A1TD [24]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 117 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.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 | 9.1.8.2.2 Simple data types | The resource identifiers defined in clause include policy type identifier and policy identifier based on the simple data types specified in Table 9.1.8.2.2-1. Table 9.1.8.2.2-1: General definition of simple data types Type Name Type Definition Description Applicability PolicyTypeId string policy type identifier as defined in A1TD [24]. PolicyId string policy identifier of an A1 policy as defined in A1 AP [23]. NearRtRicId string Near RT RIC identifier. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.2.3 Enumerations | 9.1.8.2.3.1 Enumeration: QueryFilter This indicates whether the request is for A1 policies created by the requesting API Consumer, for A1 policies created by other API Consumers, or for all A1 policies created by any API Consumer. Table 9.1.8.2.3.1-1: Enumeration type of QueryFilter Enumerations Value Description 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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.8.4 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.9.1 General | In addition to the general provisions in clause 5.4.3, the requirements in the following clauses are applicable for the A1 policy management API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.9.3 Application Errors | The application errors defined for the A1 policy management service are listed in Table 9.1.9.3-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 118 Table 9.1.9.3-1: Application errors Application Error HTTP status code Description Unauthorized 401 Used when the API consumer lacks proper authentication credentials or has provided invalid credentials. Forbidden 403 Used when the API Consumer has successfully authenticated the user, but the user is still denied access to the requested resource. Bad Request 400 Used when the A1 policy management service cannot or will not process a request, e.g. when the validation of PolicyObject towards a policy type schema, or the validation of PolicyStatusObject towards a policy status schema, fails. Not Found 404 Used when the Near-RT RIC did not find a current representation for the resource representing a policy type or a policy, e.g. for a policy type that is not available or a policy that does not exist. Method Not Allowed 405 Used when the HTTP method is not supported by the resource defined for the A1 policy management API. Conflict 409 Used if detecting that a policy requested to be created or updated may be overlapping or conflicting with a policy that exists in the Near-RT RIC. Application errors should be mapped to the most applicable 4xx/5xx HTTP error status code. If no such status code is applicable, one of the status codes 400 (Bad Request) or 500 (Internal Server Error) should be used. The HTTP status codes listed in Table 9.1.9.3-1 shall be used as defined in clause 5.4.3 for the A1 policy management procedures and clause 9.1.5 for the resources. Implementations may use additional HTTP error status codes in addition to those listed in Table 9.1.9.3-1, as long as they are valid HTTP status codes. A list of all valid HTTP status codes and their specification documents can be obtained from the HTTP status code registry [21]. In addition, the response body may contain a JSON representation of a "ProblemDetails" data structure in the payload body as defined in clause 9.1.8.2.2. In that case, as defined by IETF RFC 7807 [10], the "Content-Type" HTTP header shall be set to "application/problem+json". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10 AI/ML workflow services | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1 AI/ML model registration API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.1 Introduction | This API enables the API Consumer to register, query, update and deregister an AI/ML model based on the AI/Ml model registration service defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.2 API version | For the AI/ML model registration API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 0 and the PATCH version field shall be 0 (see ETSI TS 129 501 [1]for a definition of the version fields). Consequently, the <apiVersion> URI path segment shall be set to "v1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.3 Resource structure and methods | The request URIs used in HTTP requests from the API Consumer towards the API Producer shall have the resource URI structure as defined in clause 5.2. The <apiName> resource URI variable shall be "ai-ml-model-registration". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 10.1.5. Figure 10.1.3-1 shows the overall resource URI structure defined for the model registration API. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 119 Figure 10.1.3-1: Resource URI structure of the AI/ML model registration API Table 10.1.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 10.1.3-1: Resource and methods overview of the AI/ML model registration API Resource name Resource URI HTTP method Service Operation Registered model registrations …/ model-registrations POST Register model information. Individual registered model registration …/ model- registrations/{modelRegistrationId} GET Query model registration information. PUT Update model registration information. DELETE Deregister model registration information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.1 Register model information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.1.1 Operation definition | The API Consumer uses this operation to register AI/ML model information. The operation to register the model information is based on HTTP POST. Figure 10.1.4.1.1-1: Register model information 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 (…/model-registrations) under which the new registration is requested to be created. The message content shall carry a ModelRelatedInformation structure. {apiRoot}/ai-ml-model-registration/<apiVersion> /model-registrations /{modelRegistrationId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 120 2) The API Producer shall generate the model registration identifier and construct the URI for the created resource. The API Producer shall return the HTTP POST response. On success, "201 Created" shall be returned. The "Location" header shall be present and shall carry the URI of the new registration resource. The message content shall carry a ModelRelatedInformation 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.1.4.1.2 Referenced procedures | 10.1.4.1.2.1 Register AI/ML model procedure The Register model information operation illustrated in Figure 10.1.4.1.1-1 is based on the Register AI/ML model procedure defined for the AI/ML workflow services in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.2 Deregister model information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.2.1 Operation definition | The API Consumer uses this operation to delete the registered model information. The operation to deregister an AI/ML model information that was previously registered is based on HTTP DELETE. Figure 10.1.4.2.1-1: Deregister model information operation The service operation is as follows: 1) The API Consumer shall send an HTTP DELETE request to the API Producer. The target URI shall identify the resource to be deleted (…/model-registrations/{modelRegistrationId}). 2) The API Producer shall return the HTTP DELETE response. On success, "204 No Content" shall be returned and the response message content shall be empty. On failure, the appropriate error code shall be returned, and the message response content may contain additional error information. 10.1.4.2.2 Referenced procedures 10.1.4.2.2.1 Deregister AI/ML Model procedure The Deregister model information operation illustrated in Figure 10.1.4.2.1-1 is based on the Deregister AI/ML model procedure defined for the AI/ML workflow services in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.3 Update model information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.3.1 Operation definition | The API Consumer uses this operation to Update model information. The operation to update the model information is based on HTTP PUT. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 121 Figure 10.1.4.3.1-1: Update model information operation The service operation is as follows: 1) The API Consumer shall send an HTTP PUT request to the API Producer. The target URI shall identify the resource (…/model-registrations/{modelRegistrationId}). The message content shall carry an updated ModelRelatedInformation structure. The API producer shall process the HTTP PUT message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP PUT response. On success, "200 OK" shall be returned. The message body shall contain updated ModelRelatedInformation structure. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.3.2 Referenced procedures | 10.1.4.3.2.1 Update AI/ML model registration procedure The Update model information operation illustrated in Figure 10.1.4.1.1-1 is based on the Update AI/ML model registration procedure defined for the AI/ML workflow services in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.4 Query model information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.4.4.1 Operation definition | The API Consumer uses this operation to query model information that it has previously registered. The operation to query model information is based on HTTP GET. Figure 10.1.4.4.1-1: Query model information operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer. The target URI shall identify the resource (…/model-registrations/{modelRegistrationId}). The message content shall be empty. The API producer shall process the HTTP GET 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) 122 2) The API Producer shall return the HTTP GET response. On success, "200 OK" shall be returned. The message content shall carry the queried model related information. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. 10.1.4.4.2 Referenced procedures 10.1.4.4.2.1 Query AI/ML model registration procedure The Query model information operation illustrated in Figure 10.1.4.4.1-1 is based on the Query AI/ML model registration procedure defined for the AI/ML workflow services in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.1 Overview | The following clause defines the resources for the AI/ML model registration API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.2 Resource: "Registered model registrations" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.2.1 Description | The resource represents the model information of an rApp that it wants to register. Only the methods defined in clause 10.1.5.2.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.2.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-registration/<apiVersion>/model-registrations The resource URI variables supported by the resource is defined in Table 10.1.5.2.2-1. Table 10.1.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.1.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.2.3 Resource Standard Methods | 10.1.5.2.3.1 POST This method shall support the request data structure specified in Table 10.1.5.2.3.1-1 and the response data structure and response code specified in Table 10.1.5.2.3.1-2, and the HTTP headers specified in Table 10.1.5.2.3.1-3. Table 10.1.5.2.3.1-1: Data structures supported by the POST request body on this resource Data Type P Cardinality Description ModelRelatedInformation M 1 Information related to the model ETSI ETSI TS 104 231 V8.0.0 (2026-03) 123 Table 10.1.5.2.3.1-2: Data structures supported by the POST response body on this resource Data Type P Cardinality Response codes Description ModelRelatedInformation M 1 201 Created The operation was successful, and the message content of the POST response contains a ModelRelatedInformation structure as a representation of the created resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. Table 10.1.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 registered ModelInformation" resource, as defined in clause 10.1.5.3, with the registrationId in the URI. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.3 Resource: "Individual registered model registration" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.3.1 Description | The resource represents the model information of an rApp that it wants to update, deregister, and query. Only the methods defined in clause 10.1.5.3.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.3.2 Resource Definition | Resource URI: {apiRoot}/ai-ml-model-registration/<apiVersion>/model-registrations/{modelRegistrationId} The resource URI variables supported by the resource are defined in Table 10.1.5.3.2-1. Table 10.1.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 10.1.2. modelRegistrationId The registration identifier of the model. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.3.3 Resource Standard Methods | 10.1.5.3.3.1 DELETE This method shall support the request data structure specified in Table 10.1.5.3.3.1-1 and the response data structure and response code specified in Table 10.1.5.3.3.1-2. Table 10.1.5.3.3.1-1: Data structure supported by the DELETE request body on this resource Data type P Cardinality Description N/A A DELETE request has no message content. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 124 Table 10.1.5.3.3.1-2: Data structure supported by the DELETE response body on this resource Data type P Cardinality Response codes Description N/A 204 No Content The AI/ML model registration associated with the modelRegistrationId has been deleted successfully. The message content shall be empty. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. 10.1.5.3.3.2 PUT This method shall support the request data structure specified in Table 10.1.5.3.3.2-1 and the response data structure and response code specified in Table 10.1.5.3.3.2-2. Table 10.1.5.3.3.2-1: Data structures supported by the PUT request body on this resource Data Type P Cardinality Description ModelRelatedInformation M 1 Updated model related information. Table 10.1.5.3.3.2-2: Data structures supported by the PUT response body on this resource Data Type P Cardinality Response codes Description ModelRelatedInformation M 1 200 OK The model related information associated with the modelRegistrationId has been updated successfully and the response contain the ModelRelatedInformation as a representation of the updated resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. 10.1.5.3.3.3 GET This method shall support the request data structure specified in Table 10.1.5.3.3.3-1 and the response data structure and response code specified in Table 10.1.5.3.3.3-2. Table 10.1.5.3.3.3-1: Data structures supported by the GET request body on this resource Data Type P Cardinality Description N/A A GET request has no message content. Table 10.1.5.3.3.3-2: Data structures supported by the GET response body on this resource Data Type P Cardinality Response codes Description ModelRelatedInformation M 1 200 OK The model related information registration associated with the modelRegistrationId has been queried successfully and the response contain the ModelRelatedInformation as a representation of the query resource. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.5.3.4 Resource Custom Operations | None. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 125 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.6 Custom operation without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8 Data Model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.1 Structured data types | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.1.1 Overview | The following clauses define the structured data types and their attributes to be used by the AI/ML model registration API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.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.1.8.1.2-1. Table 10.1.8.1.2-1: Definition of type ModelRelatedInformation Attribute Name Data type P Cardinality Description modelId ModelId M 1 Identifier of a model. description string M 1 Description of the AIML model. modelInformation ModelInformation M 1 Information of the AIML model. modelLocation URI O 0..1 Location of the model stored in the runtime catalogue that can be discovered and referred to when using AI/ML workflow services. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.1.3 Data type: ModelId | The ModelId data type represents information of AI/ML model. It contains the attributes defined in Table 10.1.8.1.3-1. Table 10.1.8.1.3-1: Definition of type ModelId Attribute Name Data type P Cardinality Description modelName String M 1 Name of the model as specified in R1GAP[5] . modelVersion String M 1 Version of the model as specified in R1GAP [5]. artifactVersion String O 0..1 Artifact version of AIML model as specified in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.1.4 Data type: ModelInformation | The Model information data type contains the attributes defined in Table 10.1.8.1.4-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 126 Table 10.1.8.1.4-1: Definition of type ModelInformation Attribute Name Data type P Cardinality Description metadata MetaData M 1 Metadata of the model. inputDataType array(dataTypeId) M 1..N Input data type for the model, the structure of dataTypeId is specified in clause 7.1.8. outputDataType array(dataTypeId) M 1..N Output data type for the model, the structure of dataTypeId is specified in clause 7.1.8. targetEnvironment array(TargetEnvironment) O 0..N Information on the target environment is required for deployment of an AI/ML model. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.1.5 Data type: MetaData | The Metadata data type contains the attributes defined in Table 10.1.8.1.5-1. Table 10.1.8.1.5-1: Definition of type MetaData Attribute Name Data type P Cardinality Description author String M 1 Author of the AIML model. owner String O 0..1 Ownership of the AIML model to regulate how the model can be used in the Run-Time environment. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.1.6 TargetEnvironment | The TargetEnvironment data type contains the attributes defined in Table 10.1.8.1.6-1. Table 10.1.8.1.6-1: Definition of type TargetEnvironment Attribute Name Data type P Cardinality Description platformName String M 1 Name of the platform. environmentType String M 1 Name of the platform Execution service type, and this is dependent on the platformName. dependencyList URI M 1 Location to the template that has all the list of dependencies platform should provide needs to be installed for the model. (for example, scikit-learn 0.21.3). |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.8.2.1 Enumerations | For this AI/ML model registration API, no enumerations are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.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 Registration API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.9.2 Protocol Errors | No specific protocol errors are defined in the present document. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 127 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.1.9.3 Application Errors | No additional application errors defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2 AI/ML model discovery API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.1 Introduction | This API enables the API Consumer to discover an AI/ML model based on the AI/ML model discovery service defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.2 API version | For the AI/ML model discovery API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 0 and the PATCH version field shall be 0 (see ETSI TS 129 501 [1] for a definition of the version fields). Consequently, the <apiVersion> URI path segment shall be set to "v1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.3 Resource structure and methods | The request URIs used in HTTP requests from the API Consumer towards the API Producer shall have the resource URI structure as defined in clause 5.2. The <apiName> resource URI variable shall be "ai-ml-model-discovery". Figure 10.2.3-1 shows the overall resource URI structure defined for the AI/ML model discovery API. Figure 10.2.3-1: Resource URI structure of the AI/ML model discovery API Table 10.2.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 10.2.3-1: Resource and methods overview of the AI/ML model discovery API Resource name Resource URI HTTP method Service Operation ALL registered models …/models GET Discover registered AI/ML models. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.4.1 Discover AI/ML models | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.4.1.1 Operation definition | The API Consumer uses this operation to discover the registered AI/ML models. The operation to discover the AI/ML models is based on HTTP GET. {apiRoot}/ai-ml-model-discovery/<apiVersion> /models ETSI ETSI TS 104 231 V8.0.0 (2026-03) 128 Figure 10.2.4.1-1: Discover models 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 (…/models) and may also contain query parameters to discover the registered model identifiers. 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 and the message content shall carry an array of ModelRelatedInformation that shall include modelId and corresponding metadata. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.4.1.2 Referenced procedures | 10.2.4.1.2.1 Discover AI/ML model procedure The Discover AI/ML models operation illustrated in Figure 10.2.4.1-1 is based on the Discover AI/ML model procedure defined for the AI/ML workflow service in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5.1 Overview | This clause defines the resource for the AI/ML model discovery API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5.2 Resource: "All registered models" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 10.2.5.2.1 Description | The resource represents all registered AI/ML models in the Non-RT RIC. The methods defined in clause 10.2.5.2.3 shall be supported by this resource. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.