hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.9.3 Application Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3 Configuration schema information API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.1 Introduction | This API enables the API Consumer to retrieve configuration schema information based on the procedure defined in R1GAP [5]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 91 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.2 API version | For the configuration schema information API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 0 and the PATCH version field shall be 0 (see clause 4.3.1.1 of ETSI TS 129 501 [1] for a definition of the version fields). Consequently, the <apiVersion> URI path segment shall be set to "v1". The configuration schema information API is under development and consequently the API version shall include the pre-release version "alpha.1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.3 Resource structure and methods | The request URIs used in HTTP requests from the API Consumer towards the API Producer shall have the resource URI structure as defined in clause 5.2. The <apiName> resource URI variable shall be "ran-oam-cm-schema-info". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 8.3.5. Figure 8.3.3-1 shows the overall resource URI structure defined for the retrieving configuration information API. Figure 8.3.3-1: Resource URI structure of the configuration schemas information API Table 8.3.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. Table 8.3.3-1: Resource and methods overview of the configuration schemas information API Resource Name Resource URI HTTP method Service Operation All schema information …/schemas GET Get all schema information Individual schema information …/schemas/{schemaId} GET Get Individual schema information |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.1 Get all schema information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.1.1 Operation definition | An API consumer uses the Get all schema information operation to get Schemas. {apiRoot}/ran-oam-cm-schema-info/<apiVersion> /schemas /{schemaId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 92 Figure 8.3.4.1.1-1: Get all schema information operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to API Producer. The target URI shall identify the resource (…/schemas). 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 schema. On failure, the appropriate error code shall be returned, and the message response body may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.1.2 Referenced procedures | 8.3.4.1.2.1 Get schemas procedure The Get all schema information operation illustrated in Figure 8.3.4.1.1-1 is based on Get schemas procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.2 Get Individual schema information | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.2.1 Operation definition | An API consumer uses the Get Individual schema information to get one or more schemas of interest for a schemaId. Figure 8.3.4.2.1-1: retrieving specific schema API operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to API Producer. The target URI shall identify the resource (…/schemas/{schemaId}), 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 and the message content shall carry the Schema matching the API Consumer HTTP GET request URI and schemaId. On failure, the appropriate error code shall be returned, and the message response body may contain additional error information. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 93 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.4.2.2 Referenced procedures | 8.3.4.2.2.1 Get Schemas procedure The Get individual schema information operation illustrated in Figure 8.3.4.2.1-1 is based on Get schemas procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.1 Overview | This clause defines the resources for the retrieving configuration schemas API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.2 Resource: "All schema information" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.2.1 Description | The resource represents a collection of configuration schema information. Only the methods defined in clause 8.3.3 shall be supported by this resource. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.2.2 Resource Definition | Resource URI: {apiRoot}/ran-oam-cm-schema-info/<apiVersion>/schemas The resource URI variables supported by the resource is defined in Table 8.3.5.2.2-1. Table 8.3.5.2.2-1: Resource URI variables Name Definition apiRoot See clause 5.2. apiVersion See clause 8.3.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.2.3 Resource Standard Methods | 8.3.5.2.3.1 HTTP GET Table 8.3.5.2.3.1-1: Data structures supported by the GET Response Body on this resource Data Type P Cardinality Response codes Description array(Schema) O 0..N 200 OK The results with the schema information. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.2.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.3 Resource: "Individual schema information" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.3.1 Description | The resource represents a schema definition. Only the methods defined in clause 8.3.3 shall be supported by this resource. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 94 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.3.2 Resource Definition | Resource URI: {apiRoot}/ran-oam-cm-schema-info/<apiVersion>/schemas/{schemaId} The resource URI variables supported by the resource is defined in Table 8.3.5.3.2-1. Table 8.3.5.3.2-1: Resource URI variables Name Definition apiRoot See clause 5.2. apiVersion See clause 8.3.2. schemaId Where schemaId = "name" (for latest revision or if revision is not available) or "name@revision" for a specific revision. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.3.3 Resource Standard Methods | 8.3.5.3.3.1 HTTP GET This method shall support the response data structure and response codes as specified in Table 8.3.5.3.3.1-1. Table 8.3.5.3.3.1-1: Data structures supported by the GET Response Body on this resource Data Type P Cardinality Response codes Description Schema M 1 200 OK The results with the schema information matching the request. ProblemDetails O 0..1 4xx/5xx The operation has failed, and the message content may contain Problem description details. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.5.3.4 Resource Custom Operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.6 Custom operations without associated resources | None |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.7 Notifications | None |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.8 Data model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.8.0 Overview | The following clause specifies the application data model supported by the retrieving configuration schemas API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.8.1 Data Type: Schema | The Schema data type contains the attributes defined in Table 8.3.8.1-1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 95 Table 8.3.8.1-1: Definition of type Schema Attribute Name Data type P Cardinality Description name string M 1 The unique name of the schema. revision string O 0..1 The unique revision of the schema. location Uri M 1 Location of where to find the schema content. type SchemaType M 1 See clause 8.3.8.2.3.1 (see note 2). namespace string O 0..1 The namespace of the schema (see note 1). features Array(string) O 0..N List of supported features (see note 1). deviations Array(string) O 0..N List of schema deviation(s) (see note 1). NOTE 1: Only applicable if type is YANG. NOTE 2: 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. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.8.2 Simple data types and enumerations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.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 | 8.3.8.2.2 Simple data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.8.2.3 Enumerations | 8.3.8.2.3.1 Enumeration: SchemaTypes Table 8.3.8.2.3.1-1: Enumeration SchemaTypes Enumeration value Description YANG YANG schema |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.8.3 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.9 Error Handling | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.9.1 General | In addition to the general provisions in clause 5.4.3, the requirements in the following clauses are applicable for the retrieving configuration schema API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.9.2 Protocol Errors | No specific protocol errors are defined in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.3.9.3 Application Errors | No specific protocol errors are defined in the present document. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 96 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9 A1 related services | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1 A1 policy management API | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.1 Introduction | This API allows the API Consumer to Query policy types and create, query, update and delete A1 policies based on the procedures for "A1 policy management" defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.2 API version | For the A1 policy management API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 0, and the PATCH version field shall be 0 (see ETSI TS 129 501 [1] for a definition of the version fields). Consequently, the <apiVersion> URI path segment shall be set to "v1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.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 "a1-policy-managment". The <apiSpecificResourceUriPart> for each resource shall be set as described in clause 9.1.5. Figure 9.1.3-1 shows the overall resource URI structure defined for the A1 policy management API for querying policy types and policies, for life cycle management of policies, and for subscriptions to A1 policy status notifications. Figure 9.1.3-1: Resource URI structure of the A1 policy management API Table 9.1.3-1 lists the individual resources defined for the API, the applicable HTTP methods, and the associated service operations. {apiRoot}/a1-policy-managment/<apiVersion>/ /policy-types /{policyTypeId} /policies /{policyId} /status /subscriptions /{subscriptionId} ETSI ETSI TS 104 231 V8.0.0 (2026-03) 97 Table 9.1.3-1: Resources and methods overview of the A1 policy management API Resource name Resource URI HTTP method Service Operation All A1 policy types …/policy-types GET Query A1 policy type identifiers. Individual A1 policy type …/policy-types/{policyTypeId} GET Query A1 policy type. All A1 policies …/policies GET Query A1 policy identifiers. POST Create A1 policy. Individual A1 policy …/policies/{policyId} GET Query A1 policy. PUT Update A1 policy. DELETE Delete A1 policy. Individual A1 policy status …/policies/{policyId}/status GET Query A1 policy status. All A1 policy status subscriptions …/policies/subscriptions POST Subscribe A1 policy status. Individual A1 policy status subscription …/policies/subscriptions/{subscriptionId} PUT Update A1 policy status subscription. GET Query A1 policy status subscription. DELETE Unsubscribe A1 policy status. Policy status change notifications {notificationDestination} POST Notify A1 policy status changes. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.1 Query A1 policy type identifiers | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.1.1 Operation definition | The API Consumer uses this operation to query available A1 policy type identifiers. The operation to query available A1 policy type identifiers is based on HTTP GET. Figure 9.1.4.1.1-1: Query A1 policy type identifiers 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 "/policy-types" and optionally query parameters, 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 an array of policy type information representing 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. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. NOTE: The behaviour of the query parameters is specified in Table 9.1.5.2.3.1-3. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 98 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.1.2 Referenced procedures | 9.1.4.1.2.1 Query A1 policy type identifiers procedure The Query A1 policy type identifiers API operation illustrated in Figure 9.1.4.1.1-1 is based on the Query A1 policy type identifiers procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.2 Query A1 policy type | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.2.1 Operation definition | The API Consumer uses this operation to query an A1 policy type. The Query A1 policy type operation is based on HTTP GET. Figure 9.1.4.2.1-1: Query A1 policy type 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 policy type to be read based on the policyTypeId under the resource "/policy-types". 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 PolicyTypeObject representing the read policy type. 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.2.2 Referenced procedures | 9.1.4.2.2.1 Query A1 policy type procedure The Query A1 policy type API operation illustrated in Figure 9.1.4.2.1-1 is based on the Query A1 policy type procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.3 Query A1 policy identifiers | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.3.1 Operation definition | The API Consumer uses this operation to query A1 policy identifiers. The operation to query A1 policy identifiers is based on HTTP GET. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 99 Figure 9.1.4.3.1-1: Query A1 policy identifiers 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" and optionally query parameters. 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 an array of policy information which includes 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. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. NOTE: The behaviour of the query parameters is specified in Table 9.1.5.2.3.1-3. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.3.2 Referenced procedures | 9.1.4.3.2.1 Query A1 policy identifiers procedure The Query A1 policy identifiers API operation illustrated in Figure 9.1.4.3.1-1 is based on the Query A1 policy identifiers procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.4 Create A1 policy | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.4.1 Operation definition | The API Consumer uses this operation to create an A1 policy. The Create A1 policy operation is based on HTTP POST. Figure 9.1.4.4.1-1: Create A1 policy 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" under which the A1 policy shall be created. The message content shall carry a PolicyObjectInformation which includes a nearRtRicId and a PolicyObject. The API Producer shall process the HTTP POST 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) 100 2) The API Producer shall return the HTTP POST response. On success, "201 Created" shall be returned. The message content shall carry the PolicyObjectInformation, and the "Location" HTTP header shall be present and shall carry the URI for the newly created service resource with policyId assigned by the API Producer. On failure, the appropriate error code shall be returned, and the message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.4.2 Referenced procedures | 9.1.4.4.2.1 Create A1 policy procedure The Create A1 policy API operation illustrated in Figure 9.1.4.4.1-1 is based on the Create A1 policy procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.5 Query A1 policy | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.5.1 Operation definition | The API Consumer uses this operation to query an A1 policy. The Query A1 policy operation is based on HTTP GET. Figure 9.1.4.5.1-1: Query A1 policy 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 policy to be read based on the policyId under the resource "/policies". 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 PolicyObject representing the read 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.5.2 Referenced procedures | 9.1.4.5.2.1 Query A1 policy procedure The Query A1 policy API operation illustrated in Figure 9.1.4.5.1-1 is based on the Query A1 policy procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.6 Update A1 policy | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.6.1 Operation definition | The API Consumer uses this operation to update an A1 policy. The Update A1 policy operation is based on HTTP PUT. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 101 Figure 9.1.4.6.1-1: Update A1 policy 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 policy to be updated based on the policyId under the resource "/policies". The message content shall contain a PolicyObject. 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 content shall carry a PolicyObject representing the updated 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.6.2 Referenced procedures | 9.1.4.6.2.1 Update A1 policy procedure The Update A1 policy API operation illustrated in Figure 9.1.4.6.1-1 is based on the Update A1 policy procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.7 Delete A1 policy | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.7.1 Operation definition | The API Consumer uses this operation to delete an A1 policy. The Delete A1 policy operation is based on HTTP GET. Figure 9.1.4.7.1-1: Delete A1 policy 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 policy to be deleted based on the policyId under the resource "/policies". The message content shall be empty. The API Producer shall process 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. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 102 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 9.1.4.7.2 Referenced procedures | 9.1.4.7.2.1 Delete A1 policy procedure The Delete A1 policy API operation illustrated in Figure 9.1.4.7.1-1 is based on the Delete A1 policy procedure defined in R1GAP [5]. |
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. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.