hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.6 Custom operations without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.7 Notifications | NOTE: The notifications are not specified in the present document. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8 Data model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.1 General | The application data model is defined in ETSI TS 128 532 [20], clause 12.1.1.4, apply to this API. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.2 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.3 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.4 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.1.8.5 Service-specific registration information | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2 Fault management API | 8.2.1 Introduction This API allows the API Consumer to read information about alarms and to acknowledge alarms based on the procedures for the "Fault Management (FM) service" defined in R1GAP [5]. The API is based on the AlarmList IOC as specified in ETSI TS 128 111 [26], clause 7.3.2. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.2 API version | For the fault management API as specified in the present document, the MAJOR version field shall be 1, the MINOR version field shall be 0 and the PATCH version field shall be 0 (see ETSI TS 129 501 [1]for a definition of the version fields). Consequently, the <apiVersion> URI variable shall be set to "v1". |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.3 Resource structure and methods | The request URIs used in HTTP requests from the API Consumer towards the API Producer shall have the resource URI structure as defined for the Generic provisioning management service API (see ETSI TS 128 532 [20], Figure 12.1.1.3.1.1-1 in clause 12.1.1.3.1.1). Table 8.2.3-1 lists the individual resources defined for the API, the applicable HTTP methods as defined in ETSI TS 128 532 [20], clause 12.1.1, and the associated service operations. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 87 Table 8.2.3-1: Resources and methods overview of the fault management API Resource Name ETSI TS 128 532 [20] Resource URI ETSI TS 128 532 [20] HTTP method ETSI TS 128 532 [20] Service Operation Alarm list .../{URI-LDN-first part}/{className}={id}/ AlarmList={alarmListId} GET Query alarms. PATCH Change alarm acknowledgement status. NOTE: FM service procedures related to M-Plane nodes, such as O-RUs, are not currently supported in this API resource structure and can be defined in future releases. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4 Service operations | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.1 Query alarms | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.1.1 Operation definition | A Service Consumer uses the Query alarms API operation as API Consumer to query alarm information from the API Producer. The operation is based on HTTP GET as per Figure 8.2.4.1.1-1. The HTTP GET response contains a list of alarm records matching the query of the API Consumer. Figure 8.2.4.1.1-1: Query alarms operation The service operation is as follows: 1) The API Consumer shall send an HTTP GET request to the API Producer that includes either "SubNetwork" or "ManagedElement" as the class name, the related object instance identifier, the alarm list identifier, and optional query criteria. The API Producer shall process the information received in the HTTP GET message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP GET response. On success "200 OK" shall be returned and the message content shall carry the representation of the alarm list. If query criteria were given, the content of the alarm entries in the returned alarm list shall match the query criteria. On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.1.2 Referenced procedures | 8.2.4.1.2.1 Query alarms procedure The procedure for querying alarm information illustrated in Figure 8.2.4.1.1-1 is based on the Query Alarms procedure defined in R1GAP [5]. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 88 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.2 Change alarm acknowledgement state | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.2.1 Operation definition | A Service Consumer uses the Change alarm acknowledgement state API operation as API Consumer to acknowledge or unacknowledge one or more alarms with the API Producer. The operation is based on HTTP PATCH as per Figure 8.2.4.2.1-1. Figure 8.2.4.2.1-1: Change alarm acknowledgement state operation The service operation is as follows: 1) The API Consumer shall send a PATCH request to the API Producer that includes in the resource URI either "SubNetwork" or "ManagedElement" as the class name, the related object instance identifier, and the alarm list identifier. Further, it shall include in the message content information about which alarms to be updated as well as information about the actual alarm acknowledgements / unacknowledgments. The API Producer shall process the information received in the HTTP PATCH message and determine if the request sent by the API Consumer is authorized or not. 2) The API Producer shall return the HTTP PATCH response. 3) On success, the API Producer should return a "204 No Content" response message with empty message content. 4) On success, the API Producer may alternatively return a "200 OK" response message with the representation of updated alarm list in the message content. 5) On failure, the appropriate error code shall be returned, and the response message content may contain additional error information. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.4.2.2 Referenced procedures | 8.2.4.2.2.1 Change alarm acknowledgement state procedure The procedure for changing the acknowledgement state of one or more alarms illustrated in Figure 8.2.4.2.1-1 is based on the Change alarm acknowledgement state procedure defined in R1GAP [5]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5 Resources | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.1 Overview | This clause defines the resources for the Fault Management (FM) service API based on the RESTful HTTP-based solution set for the Generic provisioning management service defined in ETSI TS 128 532 [20], clause 12.1.1. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 89 The Fault Management (FM) service Producer take the role of the Generic provisioning MnS Producer defined in ETSI TS 128 532 [20]. By consuming this API, an rApp as Fault Management (FM) service Consumer takes the role of the Generic provisioning MnS Consumer defined in ETSI TS 128 532 [20]. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2 Resource: "Alarm list" | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.1 Description | The "Alarm list" resource represents a list of alarms related to either a subnetwork or a managed element. It allows to query alarms and to change the acknowledgement state of alarms. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.2 Resource definition | The resource URI structure of the alarm list as managed by the Generic provisioning MnS is defined as per ETSI TS 128 532 [20], clause 12.1.1.3.1.1, for the AlarmList IOC as defined in ETSI TS 128 111 [26], clause 7.3.2, with the following URI: {apiRoot}/ProvMnS/<apiVersion>/{URI-LDN-first-part}/{className}={id}/AlarmList={alarmListId} The resource URI variables supported by the resource are defined in Table 8.2.5.2.2-1. Table 8.2.5.2.2-1: Resource URI variables for the resource Name Definition apiRoot See clause 5.2. apiVersion See clause 8.2.2. URI-LDN-first-part See ETSI TS 128 532 [20], clause 12.1.1.3.2.1.2. className Name of the object class (IOC) of the managed object instance to which the alarm list is attached. Shall be either "SubNetwork" or "ManagedElement" as defined in ETSI TS 128 622 [21], clause 4.3.26.1. id Identifier of the managed object instance to which the alarm list is attached. alarmListId Identifier of the managed object instance which is the alarm list. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.3 Resource Standard Methods | 8.2.5.2.3.1 GET This method shall support the URI query parameters, HTTP headers, response data structures and response codes specified in ETSI TS 128 532 [20], clause 12.1.1.3.2.1.3.2. EXAMPLE 1: This request queries the whole alarm list: GET /SubNetwork=SN123/AlarmList=AL123 HTTP/1.1. EXAMPLE 2: This request queries a single alarm: GET /SubNetwork=SN123/AlarmList=AL123?fields=/attributes/alarmRecords/ALARM456 HTTP/1.1. NOTE: Selection of alarm records in the query based on then values of other alarm attributes than alarm identifier is not supported in the present version. 8.2.5.2.3.2 PATCH This method shall support the URI query parameters, HTTP headers, response data structures and response codes specified in ETSI TS 128 532 [20], clause 12.1.1.3.2.1.3.3. To change the alarm state, the patch payload shall contain values for the "ackState" attribute ("ACKNOWLEDGED" or "UNACKNOWLEDGED") and the "ackUserId" attribute and may contain a value for the "ackSystemId" attribute, as defined in ETSI TS 128 111 [26], clause 7.3.1.2. ETSI ETSI TS 104 231 V8.0.0 (2026-03) 90 |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.5.2.4 Resource custom operations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.6 Custom operations without associated resources | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.7 Notifications | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8 Data model | |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.1 General | The application data model is defined in ETSI TS 128 111 [26], clause A.1.3. The key IOCs for this API are SubNetwork, ManagedElement and AlarmList. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.2 Structured data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.3 Simple data types and enumerations | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.4 Re-used data types | None. |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.8.5 Service-specific registration information | None. 8.2.9 Error Handling |
662b7254f1dd44e3e532d423d3335866 | 104 231 | 8.2.9.1 General | HTTP error handling is applicable for this API as specified in ETSI TS 128 111 [26], clause A.1.3. |
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]. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.