hash
stringlengths
32
32
doc_id
stringlengths
7
13
section
stringlengths
3
121
content
stringlengths
0
2.2M
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1 UE location and velocity information
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.1 EI type identifier
EiTypeId: ORAN_UEGeoandVel_3.0.1
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.2 Rationale
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.2.1 Use case
See use case 4: context-based dynamic handover management for V2X, use case 5: RAN slice SLA assurance, and use case 7: massive MIMO optimization in Non-RT RIC and A1/R1 interface: Use Cases and Requirements [1].
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.2.2 Statements, restrictions and extensions
A UEGeoandVelEIDescription statement can be applied together with ScopeIdentifier containing different combinations of identifiers. Not all combinations are relevant. Table 9.2.1.2.2-1 indicates the combinations that are allowed. Table 9.2.1.2.2-1: Allowed combinations of UEGeoandVelEIDescription with ScopeIdentifier S...
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.3 JSON schemas
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.3.1 EI job definition schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://schemas.o-ran.org/jsonschemas/a1td/oran_uegeoandvel_3.0.1", "description": "O-RAN standard UE geo-location and velocity EI job definition", "type": "object", "properties": { "scope": { "type": "object", "properties": { "ueId": {"$ref": "/a1td/...
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.3.2 EI job constraints schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "O-RAN standard UE geo-location and velocity EI job constraints", "type": "object", "properties": { "ueGeoandVelEIConstraints": { "type": "object", "properties": { "supportedGadShapes": { "type": "array", "items": { "$ref": "#/$defs/GadShapeTyp...
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.3.3 EI job status schema
The generic EI job status schema in clause 9.1.2.1 is used.
dd2f747decb51cf171473fa3c4dbb901
103 988
9.2.1.3.4 EI job result schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "O-RAN standard UE geo-location and velocity EI job results", "type": "array", "items": { "$ref": "#/$defs/UEGeoandVelEIResult" }, "minItems": 1, "$defs": { "UEGeoandVelEIResult": { "type": "object", "properties": { "timeStamp": {"$ref": "#/$de...
5802553197ba1f74584a28028e719a90
103 987
1 Scope
The present document specifies the application protocol of the A1 interface. It includes service definitions and API definitions for the A1 policy management service (A1-P) and the A1 enrichment information service (A1-EI).
5802553197ba1f74584a28028e719a90
103 987
2 References
5802553197ba1f74584a28028e719a90
103 987
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which a...
5802553197ba1f74584a28028e719a90
103 987
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks i...
5802553197ba1f74584a28028e719a90
103 987
3 Definition of terms, symbols and abbreviations
5802553197ba1f74584a28028e719a90
103 987
3.1 Terms
For the purposes of the present document, the terms given in A1GAP [2] and the following apply: EiJobId: Simple Data Type representing the EI job identifier EI job identifier: identifier of an EI job that is used for requesting and delivering A1 enrichment information EI job result: resulting enrichment information del...
5802553197ba1f74584a28028e719a90
103 987
3.2 Symbols
Void. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 10
5802553197ba1f74584a28028e719a90
103 987
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in A1GAP [2] and the following apply: Id Identifier ML Machine Learning REST REpresentational State Transfer URI Uniform Resource Identifier
5802553197ba1f74584a28028e719a90
103 987
4 A1 Application Protocol
5802553197ba1f74584a28028e719a90
103 987
4.1 Introduction
The present document specifies a REST realization of the A1 interface architecture, and the policy and EI procedures identified in A1GAP [2]. It is based on HTTP as defined in A1TP [3] and an application data model defined in A1TD [4]. This definition of the A1 Application Protocol (A1AP) is based on the 3GPP service f...
5802553197ba1f74584a28028e719a90
103 987
4.2 Compatibility of A1 versions
The version number of the present document indicates that there may be implications for the compatibility between A1 implementations in Non/Near-RT RICs that are based on different versions of this specification. An incremented first digit of this specification could indicate that a new major feature (e.g. new A1 servi...
5802553197ba1f74584a28028e719a90
103 987
5 A1 services
5802553197ba1f74584a28028e719a90
103 987
5.1 Introduction
The present document specifies the APIs for the following services defined in A1GAP [2]: A1-P: A1 policy management service; A1-EI: A1 enrichment information service NOTE: Service definition and API for A1-ML are not defined in the present document. The A1 application protocol is based on signalling between an A1 servi...
5802553197ba1f74584a28028e719a90
103 987
5.2 Policy management service
5802553197ba1f74584a28028e719a90
103 987
5.2.1 Introduction
The A1-P service defines service operations that are used with policy types defined in A1TD [4].
5802553197ba1f74584a28028e719a90
103 987
5.2.2 Service description
5802553197ba1f74584a28028e719a90
103 987
5.2.2.1 Functional elements
The A1 application protocol for A1-P is based on signalling between the A1-P Consumer residing in the Non-RT RIC and the A1-P Producer residing in the Near-RT RIC. Both the A1-P Consumer and the A1-P Producer contain an HTTP Client and an HTTP Server. HTTP Client A1-P Consumer HTTP Server HTTP Server HTTP Client A1-P P...
5802553197ba1f74584a28028e719a90
103 987
5.2.2.2 Policy representation
The following principles are used for A1 policies when JSON is used as resource representation format: • a policy corresponds to a resource (in the REST sense); • a policy is represented as a JSON object referred to as a PolicyObject; • a PolicyObject contains a scope identifier and at least one policy statement (e.g. ...
5802553197ba1f74584a28028e719a90
103 987
5.2.2.3 Representation objects
The following JSON objects are used within the service operations of the A1-P service: PolicyTypeObject The PolicyTypeObject contains the JSON schemas used to validate a PolicyObject and a PolicyStatusObject. PolicyObject The PolicyObject is the JSON representation of an A1 policy. PolicyStatusObject The PolicyStatusOb...
5802553197ba1f74584a28028e719a90
103 987
5.2.2.4 Resource identifiers
The URI for A1 policy types is: …/policytypes A single policy type is identified by adding the value of the policy type identifier to the URI: …/policytypes/{policyTypeId} The URI for A1 policies is: …/policytypes/{policyTypeId}/policies A single policy is identified by adding the value of the policy identifier to the ...
5802553197ba1f74584a28028e719a90
103 987
5.2.3 Service operations for A1 policy types
5802553197ba1f74584a28028e719a90
103 987
5.2.3.1 Introduction
Table 5.2.3.1-1 describes the mapping between the A1 policy type operations and the HTTP methods used to realize them, and the mandatory HTTP status codes for the operations. Table 5.2.3.1-1: A1 policy operations to HTTP methods mapping Service operation HTTP method HTTP status codes Query policy type identifiers GET 2...
5802553197ba1f74584a28028e719a90
103 987
5.2.3.2 Query policy type identifiers
5802553197ba1f74584a28028e719a90
103 987
5.2.3.2.1 General
The A1-P Consumer uses the Query policy type identifiers operation to discover policy types. The operation to query policy type identifiers is based on HTTP GET. The resource to be read is identified within the URI while the message body is empty, and the response returns an array of identifiers representing all availa...
5802553197ba1f74584a28028e719a90
103 987
5.2.3.2.2 Query all policy type identifiers procedure
The procedure to query all policy type identifiers is based on the Query policy type identifiers operation illustrated in figure 5.2.3.2.1-1. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 14
5802553197ba1f74584a28028e719a90
103 987
5.2.3.3 Query policy type
5802553197ba1f74584a28028e719a90
103 987
5.2.3.3.1 General
A1-P Consumer uses the Query policy type procedures to read the schemas for a specific policy type or for all policy types. The Query policy type operation is used in the following procedures: • Query single policy type; • Query multiple policy types; and • Query all policy types. The operation to query a policy type i...
5802553197ba1f74584a28028e719a90
103 987
5.2.3.3.2 Query single policy type procedure
The procedure to query single policy type is based on the Query policy type operation illustrated in figure 5.2.3.3.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.3.3.3 Query multiple policy types procedure
The procedure to query multiple policy types is a sequence of Query policy type operations.
5802553197ba1f74584a28028e719a90
103 987
5.2.3.3.4 Query all policy types procedure
The procedure to query all policy types is a sequence of Query policy type operations for each policy type identifier retrieved as described in clause 5.2.3.2.1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4 Service operations for A1 policies
5802553197ba1f74584a28028e719a90
103 987
5.2.4.1 Introduction
Table 5.2.4.1-1 describes the mapping between the A1 policy operations and the HTTP methods used to realize them, and the mandatory HTTP status codes for the operations. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 15 Table 5.2.4.1-1: A1 policy operations to HTTP methods mapping Service operation HTTP method HTTP status codes...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.2 Query policy identifiers
5802553197ba1f74584a28028e719a90
103 987
5.2.4.2.1 General
The A1-P Consumer uses the Query policy identifiers operation to discover policies for a specific policy type or for all policy types. The Query policy identifiers operation is used in the following procedures: • Query policy identifiers; and • Query all policy identifiers. The operation to query all policy identifiers...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.2.2 Query policy identifiers procedure
The procedure to query policy identifiers is based on the Query policy identifiers operation illustrated in figure 5.2.4.2.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.2.3 Query all policy identifiers procedure
The procedure to query all policy identifiers is based on the Query policy identifiers operation. The operation is performed for each policy type for which policies have been created, or for each policy type identifier discovered using the Query policy type identifiers operation defined in clause 5.2.3.2.1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.3 Create policy
5802553197ba1f74584a28028e719a90
103 987
5.2.4.3.1 General
The A1-P Consumer uses the Create policy procedure to create an A1 policy. The Create policy operation is used in the following procedures: • Create single policy; and • Create multiple policies. The operation to create a policy is based on HTTP PUT. The policy to be created is identified with a URI that includes the p...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.3.2 Create single policy procedure
The procedure to create single policy is based on the Create policy operation illustrated in figure 5.2.4.3.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.3.3 Create multiple policies procedure
The procedure to create multiple policies is a sequence of Create policy operations.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.4 Update policy
5802553197ba1f74584a28028e719a90
103 987
5.2.4.4.1 General
The A1-P Consumer uses the Update single policy procedure to update an A1 policy. The Update policy operation is used in the following procedures: • Update single policy; and • Update multiple policies. The operation to update a single policy is based on HTTP PUT. The policy to be updated is identified with a URI that ...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.4.2 Update single policy procedure
The procedure to update single policy is based on the Update policy operation illustrated in figure 5.2.4.4.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.4.3 Update multiple policies procedure
The procedure to update multiple policies is a sequence of Update policy operations.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.5 Query policy
5802553197ba1f74584a28028e719a90
103 987
5.2.4.5.1 General
The A1-P Consumer uses the Query policy operation to read an A1 policy. The Query policy operation is used in the following procedures: • Query single policy; • Query multiple policies; and • Query all policies. The operation to query a policy is based on HTTP GET. The policy to be read is identified with a URI that in...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.5.2 Query single policy procedure
The procedure to query single policy is based on the Query policy operation illustrated in figure 5.2.4.5.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.5.3 Query multiple policies procedure
The procedure to query multiple policies is a sequence of Query policy operations. NOTE: To query all policies applicable to e.g. a dynamically defined group of UEs, a slice or a cell, the A1-P Consumer identifies applicable policyId(s) and makes a sequence of single policy queries. ETSI ETSI TS 103 987 V4.3.0 (2025-05...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.5.4 Query all policies procedure
The procedure to query all policies is, for each policyTypeId retrieved as described in clause 5.2.3.2.1, a sequence of Query policy operations for each policyId retrieved as described in clause 5.2.4.2.1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.6 Delete policy
5802553197ba1f74584a28028e719a90
103 987
5.2.4.6.1 General
The A1-P Consumer uses the Delete policy procedure to delete an A1 policy. The Delete policy operation is used in the following procedures: • Delete single policy; and • Delete multiple policies. The operation to delete a policy is based on HTTP DELETE. The policy to be deleted is identified with a URI that includes th...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.6.2 Delete single policy procedure
The procedure to delete single policy is based on the Delete policy operation illustrated in figure 5.2.4.6.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.6.3 Delete multiple policies procedure
The procedure to delete multiple policies is a sequence of Delete policy operations.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.7 Query policy status
5802553197ba1f74584a28028e719a90
103 987
5.2.4.7.1 General
The A1-P Consumer uses the Query policy status operation to query the status of an A1 policy. The operation to query status for a policy is based on HTTP GET. The policy for which status is to be read is identified with a URI that includes the policyTypeId and the policyId while the message body is empty, and the respo...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.7.2 Query policy status procedure
The procedure to query policy status is based on the Query policy status operation illustrated in figure 5.2.4.7.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.2.4.8 Notify policy status
5802553197ba1f74584a28028e719a90
103 987
5.2.4.8.1 General
The A1-P Producer uses the Notify policy status operation to update the A1-P Consumer about changes of the status of an A1 policy. Notify policy status is an operation that requires the A1-P Producer to have a reduced feature HTTP Client for sending HTTP POST requests and receiving HTTP POST responses. Correspondingly,...
5802553197ba1f74584a28028e719a90
103 987
5.2.4.8.2 Notify policy status procedure
The procedure to notify policy status and feedback is based on the Notify policy status operation illustrated in figure 5.2.4.8.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.3 Enrichment information service
5802553197ba1f74584a28028e719a90
103 987
5.3.1 Introduction
The A1-EI service defines service operations that are used with EI types defined in A1TD [4].
5802553197ba1f74584a28028e719a90
103 987
5.3.2 Service description
5802553197ba1f74584a28028e719a90
103 987
5.3.2.1 Functional elements
The A1 application protocol for A1-EI is based on signalling between the A1-EI Consumer residing in the Near-RT RIC and the A1-EI Producer residing in the Non-RT RIC. Both the A1-EI Consumer and the A1-EI Producer contain an HTTP Client and an HTTP Server. HTTP Client A1-EI Producer HTTP Server HTTP Server HTTP Client ...
5802553197ba1f74584a28028e719a90
103 987
5.3.2.2 A1 EI representation
The following principles are used for A1 enrichment information when JSON is used as resource representation format: • the A1-EI Producer indicates the EI types that are available; ETSI ETSI TS 103 987 V4.3.0 (2025-05) 22 • an EI type is identified by an EI type identifier and the schemas for available EI types can be ...
5802553197ba1f74584a28028e719a90
103 987
5.3.2.3 Representation objects
The following JSON objects are used within the service operations of the A1-EI service: EiTypeObject The EI type object contains the JSON schemas used to formulate an EI job and interpret an EI job status object and an EI job result object. EiJobObject The EI job object is the JSON representation of an EI job. EiJobSta...
5802553197ba1f74584a28028e719a90
103 987
5.3.2.4 Resource identifiers
The URI for A1 enrichment information is: …/eitypes A single EI type is identified by adding the value of the EI type identifier to the URI: …/eitypes/{eiTypeId} The URI for A1 EI jobs is: …/eijobs A single EI job is identified by adding the value of the EI job identifier to the URI: ETSI ETSI TS 103 987 V4.3.0 (2025-0...
5802553197ba1f74584a28028e719a90
103 987
5.3.3 Service operations for A1 EI types
5802553197ba1f74584a28028e719a90
103 987
5.3.3.1 Introduction
Table 5.3.3.1-1 describes the mapping between the A1 EI types operations, and the HTTP methods used to realize them, and the mandatory HTTP status codes. Table 5.3.3.1-1: A1 EI operations to HTTP methods mapping Service operation HTTP method HTTP status codes Query EI type identifiers GET 200 Query EI type GET 200, 404...
5802553197ba1f74584a28028e719a90
103 987
5.3.3.2 Query EI type identifiers
5802553197ba1f74584a28028e719a90
103 987
5.3.3.2.1 General
The A1-EI Consumer uses the Query EI type identifiers operation to query which EI types that are currently supported. The operation to query EI type identifiers is based on HTTP GET. The resource to be read is identified within the URI while the message body is empty, and the response returns an array of identifiers re...
5802553197ba1f74584a28028e719a90
103 987
5.3.3.2.2 Query EI type identifiers procedure
The procedure to query EI type identifiers is based on the Query EI type identifiers operation illustrated in figure 5.3.3.2.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.3.3.3 Query EI type
5802553197ba1f74584a28028e719a90
103 987
5.3.3.3.1 General
The A1-EI Consumer uses the Query EI type operation to read the schemas for an EI type. The operation to query an EI type is based on HTTP GET. The EI type to be queried is identified with a URI that includes the eiTypeId while the message body is empty, and the response returns the EiTypeObject. A1-EI Producer A1-EI C...
5802553197ba1f74584a28028e719a90
103 987
5.3.3.3.2 Query EI type procedure
The procedure to query EI type is based on the Query EI type operation illustrated in figure 5.3.3.3.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.3.4 Service operations for A1 EI jobs
5802553197ba1f74584a28028e719a90
103 987
5.3.4.1 Introduction
Table 5.3.4.1-1 describes the mapping between the A1 EI jobs operations and the HTTP methods used to realize them, and the mandatory HTTP status codes. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 25 Table 5.3.4.1-1: A1 EI operations to HTTP methods mapping Service operation HTTP method HTTP status codes Query EI job identifi...
5802553197ba1f74584a28028e719a90
103 987
5.3.4.2 Query EI job identifiers
5802553197ba1f74584a28028e719a90
103 987
5.3.4.2.1 General
The A1-EI Consumer uses the Query EI job identifiers operation to check which EI jobs that exist. The operation to query EI job identifiers is based on HTTP GET. The resource to be read is identified within the URI while the message body is empty, and the response returns an array of identifiers representing all availa...
5802553197ba1f74584a28028e719a90
103 987
5.3.4.2.2 Query EI job identifiers procedure
The procedure to query EI job identifiers is based on the Query EI job identifiers operation illustrated in figure 5.3.4.2.1-1. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 26
5802553197ba1f74584a28028e719a90
103 987
5.3.4.3 Create EI job
5802553197ba1f74584a28028e719a90
103 987
5.3.4.3.1 General
The A1-EI Consumer uses the Create EI job operation to create an EI job. The operation to create an EI job is based on HTTP PUT. The EI job to be created is identified with a URI that includes the eiJobId and the message body contains the EiJobObject. The format of the EiJobObject is checked, and the request is either ...
5802553197ba1f74584a28028e719a90
103 987
5.3.4.3.2 Create EI job procedure
The procedure to create EI job is based on the Create EI job operation illustrated in figure 5.3.4.3.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.3.4.4 Update EI job
5802553197ba1f74584a28028e719a90
103 987
5.3.4.4.1 General
The A1-EI Consumer uses the Update EI job operation to update an EI job. The operation to update a single EI job is based on HTTP PUT. The EI job to be updated is identified with a URI that includes the eiJobId and the message body contains the EiJobObject for the updated EI job. NOTE: In case an EI job does not exist ...
5802553197ba1f74584a28028e719a90
103 987
5.3.4.4.2 Update EI job procedure
The procedure to update EI job is based on the Update EI job operation illustrated in figure 5.3.4.4.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.3.4.5 Query EI job
5802553197ba1f74584a28028e719a90
103 987
5.3.4.5.1 General
The A1-EI Consumer uses the Query EI job operation to read an EI job. The operation to query an EI job is based on HTTP GET. The EI job to be read is identified with a URI that includes the eiJobId while the message body is empty, and the response returns the EI job object. A1-EI Producer A1-EI Consumer A1-EI Producer ...
5802553197ba1f74584a28028e719a90
103 987
5.3.4.5.2 Query EI job procedure
The procedure to query EI job is based on the Query EI job operation illustrated in figure 5.3.4.5.1-1.
5802553197ba1f74584a28028e719a90
103 987
5.3.4.6 Delete EI job
5802553197ba1f74584a28028e719a90
103 987
5.3.4.6.1 General
The A1-EI Consumer uses the Delete EI job operation to delete an EI job. The operation to delete an EI job s based on HTTP DELETE. The EI job to be deleted is identified with a URI that includes the eiJobId. Neither request nor response contain any EI job object in the message body. A1-EI Producer A1-EI Consumer A1-EI ...