hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.8 Query A1 policy status | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.8.1 Operation definition | The API Consumer uses this operation to query A1 policy status. The operation to query A1 policy status is based on HTTP GET. Figure 9.1.4.8.1-1: Query A1 policy 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 "…/policies/{policyId}/status". 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. 2) The API Producer shall return the HTTP GET response. On success, "200 OK" shall be returned. The message content shall carry a PolicyStatusObject representing the status of the A1 policy. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.8.2 Referenced procedures | 9.1.4.8.1.1 Query A1 policy status procedure The Query A1 policy status operation illustrated in Figure 9.1.4.8.1-1 is based on the Query A1 policy enforcement status procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.9 Subscribe A1 policy status | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.9.1 Operation definition | The API Consumer uses this operation to subscribe to notifications for status changes of A1 policies. The operation to subscribe to A1 policy status is based on HTTP POST. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 103 Figure 9.1.4.9.1-1: Subscribe to A1 policy status 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 "/policies/subscriptions" under which the new subscription is requested to be created. The message content shall carry a PolicyStatusSubscription structure. 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 return the HTTP POST response. On success, "201 Created" shall be returned. The location header shall be present and shall carry the URI of new subscription resource with subscriptionId assigned by the API producer. The message content shall carry a PolicyStatusSubscription structure that represents the new resource. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.9.2 Referenced procedures | 9.1.4.9.2.1 Subscribe A1 policy status procedure The Subscribe A1 policy status operation illustrated in Figure 9.1.4.9.1-1 is based on the Subscribe A1 policy status procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.10 Update A1 policy status subscription | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.10.1 Operation definition | The API Consumer uses this operation to update a subscription for A1 policy status notifications. The operation to update an individual A1 policy status subscription is based on HTTP PUT. Figure 9.1.4.10.1-1: Update A1 policy status subscription 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 (…/policies/subscriptions /{subscriptionId}). The message content shall carry the updated PolicyStatusSubscription structure. The API Producer shall process the request received in the HTTP PUT 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) 104 2) The API Producer shall return the HTTP PUT response. On success, "200 OK" shall be returned. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.10.2 Referenced procedures | 9.1.4.10.2.1 Update A1 policy status subscription procedure The Update A1 policy status subscription operation illustrated in Figure 9.1.4.10.1-1 is based on the Update A1 policy status procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.11 Query A1 policy status subscription | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.11.1 Operation definition | The API Consumer uses this operation to query a subscription for A1 policy status. The operation to query an individual A1 policy status subscription is based on HTTP GET. Figure 9.1.4.11.1-1: Query A1 policy status subscription 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 "/policies/subscriptions/{subscriptionId}". 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. 2) The API Producer shall return the HTTP GET response. On success, "200 OK" shall be returned. The message content shall carry the PolicyStatusSubscription representing the queried policy status subscription. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.11.2 Referenced procedures | 9.1.4.11.2.1 Query A1 policy status subscription procedure The Query A1 policy status subscription operation illustrated in Figure 9.1.4.11.1-1 is based on the Query A1 policy status subscription procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.12 Unsubscribe A1 policy status | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.12.1 Operation definition | The API Consumer uses this operation to unsubscribe from notifications on status changes of A1 policies. The operation to unsubscribe from A1 policy status notifications is based on HTTP DELETE. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 105 Figure 9.1.4.12.1-1: Unsubscribe from A1 policy status 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 "/policies/subscriptions/{subscriptionId}". 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. 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 | 9.1.4.12.2 Referenced procedures | 9.1.4.12.2.1 Unsubscribe A1 policy status procedure The Unsubscribe A1 policy status operation illustrated in Figure 9.1.4.12.1-1 is based on the Unsubscribe A1 policy status procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.13 Notify A1 policy status changes | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.13.1 Operation definition | The API Producer uses this operation to notify the API Consumer about status changes of an A1 policy. The operation to notify A1 policy status is based on HTTP POST. Figure 9.1.4.13.1-1: Notify A1 policy status changes API 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) identifies the sink for policy status change notifications. The message body shall contain a A1PolicyStatusChangeNotifications. 2) The API Consumer shall return the HTTP POST response with "204 No Content". The message body shall be empty. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 106 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.13.2 Referenced procedures | 9.1.4.13.2.1 Notify A1 policy status procedure The Notify A1 policy status changes operation illustrated in Figure 9.1.4.13.1-1 is based on the Notify A1 policy status changes procedure defined in R1GAP [5]. 9.1.5 Resources |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.1 Overview | This clause defines the resources for the A1 policy management API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.2 Resource: "All A1 policy types" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.2.1 Description | The resource All A1 policy types represents all A1 policy types that are available in all Near-RT RIC's over the A1 Interface. The methods defined in clause 9.1.5.2.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.2.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policy-types The resource URI variables supported by the resource are defined in Table 9.1.5.2.2-1. Table 9.1.5.2.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.2.3 Resource Standard Methods | 9.1.5.2.3.1 GET This method shall support the URI query parameters specified in Table 9.1.5.2.3.1-1, the request data structure specified in Table 9.1.5.2.3.1-2 and the response data structures, and response code specified in Table 9.1.5.2.3.1-3. Table 9.1.5.2.3.1-1: URI query parameters supported by the GET method on this resource Name Data type P Cardinality Description Applicability nearRtRicId string O 0..1 The identifier of Near-RT RIC (see note). typeName string O 0..1 The unique label of the policy type (see note). NOTE: If multiple query parameters are provided these shall be combined with AND when evaluating the query. Table 9.1.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. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 107 Table 9.1.5.2.3.1-3: Data structures supported by the GET response body on this resource Data Type P Cardinality Response codes Description array(PolicyTypeInformation) M 0.. N 200 OK The operation is successful, the policy type information (see notes 1, 2 and 3). ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. NOTE 1: If a Near-RT RIC identifier has been provided as query parameter, the response body shall contain only entries for policy types supported by the related Near-RT RIC. NOTE 2: If a policy type identifier has been provided as query parameter, the response body shall contain only entries for the related policy type. NOTE 3: If both a Near-RT RIC identifier and a policy type identifier have been provided as query parameters, the response body shall contain only entries for the related policy type supported by the related Near-RT RIC. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.3 Resource: "Individual A1 policy type" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.3.1 Description | The resource individual A1 policy type represents the A1 policy type that are available in the A1 policy management service. Only the methods defined in clause 9.1.5.3.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.3.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policy-types/{policyTypeId} The resource URI variables supported by the resource are defined in Table 9.1.5.3.2-1. Table 9.1.5.3.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 9.1.2. policyTypeId The policy type identifier as defined in A1TD [24]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.3.3 Resource Standard Methods | 9.1.5.3.3.1 GET This method shall support the URI query parameters specified in Table 9.1.5.3.3.1-1, and the response data structure and response code specified in Table 9.1.5.3.3.1-2. Table 9.1.5.3.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) 108 Table 9.1.5.3.3.1-2: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description PolicyTypeObject M 1 200 OK Requested policy type object as defined in A1TD [24]. ProblemDetails O 0..1 4xx/5xx Detailed problem description. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.3.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.4 Resource: "All A1 policies" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.4.1 Description | The resource All A1 policies represents the A1 policy that are available in the A1 policy management service. Only the methods defined in clause 9.1.5.4.3 shall be supported by these resources. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.4.2 Resource Definition | Resource URI: {apiRoot}/a1-policy-management /<apiVersion>/policies The resource URI variables supported by the resource are defined in Table 9.1.5.4.2-1. Table 9.1.5.4.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.4.3 Resource Standard Methods | 9.1.5.4.3.1 GET This method shall support the URI query parameters specified in Table 9.1.5.4.3.1-1, the request data structure specified in Table 9.1.5.4.3.1-2 and the response data structure and response code specified in Table 9.1.5.4.3.1-3. Table 9.1.5.4.3.1-1: URI query parameters supported by the GET method on this resource Name Data type P Cardinality Description Applicability nearRtRicId string O 0..1 The identifier of Near-RT RIC (see note). policyTypeId string O 0..1 The identifier of the policy (see note). NOTE: If multiple query parameters are provided these shall be combined with AND when evaluating the query. Table 9.1.5.4.3.1-2: 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) 109 Table 9.1.5.4.3.1-3: Data structures supported by the HTTP GET response body on this resource Data type P Cardinality Response codes Description array(PolicyInformation) M 0..N 200 OK The operation is successful, and the response body carries a list of policy information entries. ProblemDetails O 0..1 4xx/5xx Detailed problem description. NOTE 1: If a Near-RT RIC identifier has been provided as query parameter, the response body shall contain only entries for policies existing in the related Near-RT RIC. NOTE 2: If a policy type identifier has been provided as query parameter, the response body shall contain only entries for policies of the related policy type. NOTE 3: If both a Near-RT RIC identifier and a policy type identifier have been provided as query parameters, the response body shall contain only entries for policies of the related policy type existing in the related Near-RT RIC. 9.1.5.4.3.2 POST This method shall support the request data structures specified in Table 9.1.5.4.3.2-1 and the response data structures and response codes specified in Table 9.1.5.4.3.2-2 and the HTTP headers specified in Table 9.1.5.4.3.2-3. Table 9.1.5.4.3.2-1: Data structures supported by the HTTP POST request body on this resource Data type P Cardinality Description PolicyObjectInformation M 1 Information related to the creation of the policy. Table 9.1.5.4.3.2-2: Data structures supported by the HTTP POST response body on this resource Data type P Cardinality Response codes Description PolicyObjectInformation M 1 201 Created Confirmation of creation of the policy. ProblemDetails O 0..1 4xx/5xx Detailed problem description. Table 9.1.5.4.3.2-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" A1 policy resource, as defined in clause 9.1.5.3, with the policyId in the URI. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.5.4.4 Resource Custom Operations | None. |
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. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.