hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.6.2 Delete EI job procedure | The procedure to delete EI job is based on the Delete EI job operation illustrated in figure 5.3.4.6.1-1. |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.7 Query EI job status | |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.7.1 General | The A1-EI Consumer uses the Query EI job status operation to query the status of an EI job. The operation to query status for an EI job is based on HTTP GET. The EI job for which status is to be read is identified with a URI that includes the eiJobId while the message body is empty, and the response returns an EI job s... |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.7.2 Query EI job status procedure | The procedure to query EI job status is based on the Query EI job status operation illustrated in figure 5.3.4.7.1-1. |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.8 Notify EI job status | |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.8.1 General | The A1-EI Producer uses the Notify EI job status operation to notify the A1-EI Consumer about changes in status of an EI job. All notifications are sent to the URI for notification handling provided during EI job creation and the EiJobStatusObject contains the information about the status of the EI job. The operation t... |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.4.8.2 Notify EI job status procedure | The procedure to notify EI job status is based on the Notify EI job status operation illustrated in figure 5.3.4.8.1-1. |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.5 Service operations for A1 EI job result | |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.5.1 Introduction | Table 5.3.5.1-1 describes the mapping between the A1 EI job result operations, and the HTTP methods used to realize them, and the mandatory HTTP status codes. Table 5.3.5.1-1: A1 EI operations to HTTP methods mapping. Service operation HTTP method HTTP status codes Deliver EI job result POST 204, 400 The following clau... |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.5.2 Deliver EI job result | |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.5.2.1 General | The A1-EI Producer uses the Deliver EI job result operation to deliver EI job results using push-based method. The push-based delivery method of EI is based on subscribe-notify paradigm where the EI job creation corresponds to the subscription and the delivery of EI job result is made using HTTP POST in the same way as... |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.3.5.2.2 Deliver EI job result procedure | The procedure to deliver EI job result is based on the Deliver EI job result operation illustrated in figure 5.3.5.2.1-1. |
5802553197ba1f74584a28028e719a90 | 103 987 | 5.4 ML model management service | No explicit ML model service operations are defined in the present document. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6 API Definitions | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.1 Introduction | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.1.1 Encoding of attributes in A1 data types | Identifiers and parameters that have been defined as integers are, when used over the A1 interface, encoded as JSON "number". Identifiers and parameters that have a hexadecimal or octet string representation are, when used over the A1 interface, encoded as JSON "string" with character ordering preserved and zeros filli... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.1.2 Compatibility of API versions for A1 services | The API version and API name for each of the A1 services are defined in the following clauses. The API version is a single digit that corresponds to the major version of the corresponding OpenAPI document in Annex A. Based on the versioning rules for the OpenAPI documents defined in the OpenAPI Specification [12], this... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2 A1-P (policy management) | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.1 Introduction | This clause contains the definition of the REST based API for the A1 policy management service referred to as A1-P. The present document defines API version 2 (v2) of the A1-P API. Based on the URI structure defined in clause 4.4.1 of ETSI TS 129 501 [6], the request URI used in HTTP request from the A1-P consumer towa... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.2 Usage of HTTP | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.2.1 General | The A1 Transport, HTTP protocol and security requirements, is described in A1TP [3]. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.2.2 HTTP standard headers | Encodings and applicable MIME media type for the related Content-Type header are not specified in this version of the present document. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.2.3 HTTP custom headers | No HTTP custom headers are specified in this version of the present document. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3 Resources | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.1 Overview | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.1.1 Resource URI structure | The resource URI structure for the A1-P API is illustrated in figure 6.2.3.1.1-1. {apiRoot}/A1-P/v2 /{policyTypeId} /{policyId} /policytypes /status /policies Figure 6.2.3.1.1-1: Resource URI structure of the A1-P API |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.1.2 Resources and methods | Table 6.2.3.1.2-1 provides an overview of the resources and HTTP methods defined for the A1-P API. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 33 Table 6.2.3.1.2-1: Resources and methods overview Resource name Resource URI HTTP method or custom operation Description All Policy Type Identifiers /policytypes GET Query all poli... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.1.3 Policy type identifier | The PolicyTypeId is constructed based on two parts separated by "_" (underscore): typename_version where typename is the unique label of the policy type; version is the version of the policy type defined as major.minor.patch as described in SemVer [8]. The typename and version is assigned, and their uniqueness ensured,... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.2 Individual Policy Object | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.2.0 General | The name of the resource is the PolicyId assigned by the A1-P Consumer when the policy is created. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.2.1 Description | The resource represents an A1 policy. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.2.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 34 |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.2.3 Resource Standard Methods | 6.2.3.2.3.1 HTTP PUT This method shall support the request data structures specified in table 6.2.3.2.3.1-1 and the response data structures and response codes specified in table 6.2.3.2.3.1-2. Table 6.2.3.2.3.1-1: Data structures supported by the HTTP PUT Request Body on this resource Data type P Cardinality Descripti... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.3 Individual Policy Status Object | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.3.1 Description | The resource represents the status of an A1 policy. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.3.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.3.3 Resource Standard Methods | 6.2.3.3.3.1 HTTP PUT Method is not supported on this resource. 6.2.3.3.3.2 HTTP GET This method shall support the request data structures specified in table 6.2.3.3.3.2-1 and the response data structures and response codes specified in table 6.2.3.3.3.2-2. Table 6.2.3.3.3.2-1: Data structures supported by the HTTP GET ... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.3.4 Resource Custom Operations | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.4 All Policy Identifiers | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.4.1 Description | The resource represents A1 policy identifiers. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.4.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.4.3 Resource Standard Methods | 6.2.3.4.3.1 HTTP PUT Method is not supported on this resource. 6.2.3.4.3.2 HTTP GET This method shall support the request data structures specified in table 6.2.3.6.3.2-1 and the response data structures and response codes specified in table 6.2.3.6.3.2-2. Table 6.2.3.4.3.2-1: Data structures supported by the HTTP GET ... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.4.4 Resource Custom Operations | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.5 All Policy Type Identifiers | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.5.1 Description | The resource represents A1 policy type identifiers. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.5.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 37 |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.5.3 Resource Standard Methods | 6.2.3.5.3.1 HTTP PUT Method is not supported on this resource. 6.2.3.5.3.2 HTTP GET This method shall support the request data structures specified in table 6.2.3.5.3.2-1 and the response data structures and response codes specified in table 6.2.3.5.3.2-2. Table 6.2.3.5.3.2-1: Data structures supported by the HTTP GET ... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.5.4 Resource Custom Operations | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.6 Individual Policy Type Object | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.6.1 Description | The resource represents an A1 policy type. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.6.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.6.3 Resource Standard Methods | 6.2.3.6.3.1 HTTP PUT Method is not supported on this resource. 6.2.3.6.3.2 HTTP GET This method shall support the request data structures specified in table 6.2.3.6.3.2-1 and the response data structures and response codes specified in table 6.2.3.6.3.2-2. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 38 Table 6.2.3.6.3.2-1: D... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.3.6.4 Resource Custom Operations | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.4 Custom Operations without associated resources | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.5 Notifications | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.5.1 Notify Policy Status | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.5.1.1 Description | The resource represents the destination for policy status notifications. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.5.1.2 Resource Definition | The Resource URI is a callback URI provided as a query parameter in URL when creating a policy. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.5.1.3 Resource Standard Methods | 6.2.5.1.3.1 HTTP PUT Method is not supported on this resource. 6.2.5.1.3.2 HTTP GET Method is not supported on this resource. 6.2.5.1.3.3 HTTP DELETE Method is not supported on this resource. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 39 6.2.5.1.3.4 HTTP POST This method shall support the request data structures specified i... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.6 Data Model | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.6.1 Introduction | This clause specifies the application protocol data model supported by the A1-P API. The data model for the data types transported in the A1-P procedures is defined in A1TD [4]. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.6.2 Simple data types and enumerations | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.6.2.1 Simple data types | The resource identifiers defined in clause 5.2.2.4 include policy type identifier and policy identifier based on the simple data types specified in table 6.2.6.2.1-1. Table 6.2.6.2.1-1: General definition of simple data types Type Name Type Definition Description Applicability PolicyTypeId string policy type identifier... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.6.3 Structured data types | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.6.3.1 Problem details | In case a policy request is not accepted, additional information can be provided in the response in addition to the HTTP error status code. The ProblemDetails statement specified in table 6.2.6.3.1-1 contains attributes defined in IETF RFC 7807 [10]: ETSI ETSI TS 103 987 V4.3.0 (2025-05) 40 Table 6.2.6.3.1-1: Definitio... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.7 Error Handling | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.7.1 General | HTTP error handling shall be supported as specified in clause 5.2.4 of ETSI TS 129 500 [11] and according to the principles in ETSI TS 129 501 [6]. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.7.2 Protocol Errors | No protocol errors are described in the present document. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.2.7.3 Application Errors | The application errors defined for the A1-P service are listed in table 6.2.7.3-1. Table 6.2.7.3-1: Application errors Application Error HTTP status code Description Bad Request 400 Used when the Near-RT RIC or the Non-RTR RIC cannot or will not process a request, e.g. when the validation of PolicyObject towards a poli... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3 A1-EI (enrichment information) | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.1 Introduction | This clause contains the definition of the REST based API for the A1 enrichment information Service referred to as A1- EI. The present document defines API version 1 (v1) of the A1-EI API. Based on the URI structure defined in clause 4.4.1 of ETSI TS 129 501 [6], the request URI used in HTTP request from the A1-EI cons... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.2 Usage of HTTP | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.2.1 General | The A1 Transport, HTTP protocol and security requirements, is described in A1TP [3]. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.2.2 HTTP standard headers | Encodings and applicable MIME media type for the related Content-Type header are not specified in this version of the present document. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.2.3 HTTP custom headers | No HTTP custom headers are specified in the present document. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3 Resources | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.1 Overview | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.1.1 Resource URI structure | The resource URI structure for the A1-EI API is illustrated in figure 6.3.3.1.1-1. {apiRoot}/A1-EI/v1 /{eiTypeId} /eiTypes /eiJobs /{eiJobId} /status Figure 6.3.3.1.1-1: Resource URI structure of the A1-EI API ETSI ETSI TS 103 987 V4.3.0 (2025-05) 42 |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.1.2 Resources and methods | Table 6.3.3.1.2-1 provides an overview of the resources and HTTP methods defined for the A1-EI API. Table 6.3.3.1.2-1: Resources and methods overview Resource name Resource URI HTTP method or custom operation Description All EI Type Identifiers /eitypes GET Query all EI type identifiers Individual EI Type /eitypes/{eiT... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.1.3 EI type identifier | The EiTypeId is constructed based on two parts separated by "_" (underscore): typename_version where typename is the unique label of the EI type; version is the version of the EI type defined as major.minor.patch as described in SemVer [8]. The typename and version is assigned, and their uniqueness ensured, by the orga... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.2 All EI Type Identifiers | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.2.1 Description | The resource represents EI type identifiers. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.2.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 43 |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.2.3 Resource Standard Methods | 6.3.3.2.3.1 HTTP GET This method shall support the request data structures specified in table 6.3.3.2.3.1-1 and the response data structures and response codes specified in table 6.3.3.2.3.1-2. Table 6.3.3.2.3.1-1: Data structures supported by the HTTP GET Request Body on this resource Data type P Cardinality Descripti... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.2.4 Resource Custom Operations | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.3 Individual EI Type | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.3.1 Description | The resource represents an EI type. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.3.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.3.3 Resource Standard Methods | 6.3.3.3.3.1 HTTP GET This method shall support the request data structures specified in table 6.3.3.3.3.1-1 and the response data structures and response codes specified in table 6.3.3.3.3.1-2. Table 6.3.3.3.3.1-1: Data structures supported by the HTTP GET Request Body on this resource Data type P Cardinality Descripti... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.3.4 Resource Custom Operations | No custom operations are defined. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 44 |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.4 All EI Jobs | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.4.1 Description | The resource represents EI job identifiers. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.4.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.4.3 Resource Standard Methods | 6.3.3.4.3.1 HTTP GET This method shall support the request data structures specified in table 6.3.3.4.3.1-1 and the response data structures and response codes specified in table 6.3.3.4.3.1-2. Table 6.3.3.4.3.1-1: Data structures supported by the HTTP GET Request Body on this resource Data type P Cardinality Descripti... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.5 Individual EI Job | |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.5.1 Description | The resource represents an EI job. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.5.2 Resource Definition | The Resource URI and the supported resource variables are as defined in previous clauses. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.5.3 Resource Standard Methods | 6.3.3.5.3.1 HTTP PUT This method shall support the request data structures specified in table 6.3.3.5.3.1-1 and the response data structures and response codes specified in table 6.3.3.5.3.1-2. ETSI ETSI TS 103 987 V4.3.0 (2025-05) 45 Table 6.3.3.5.3.1-1: Data structures supported by the HTTP PUT Request Body on this r... |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.5.4 Resource Custom Operations | No custom operations are defined. |
5802553197ba1f74584a28028e719a90 | 103 987 | 6.3.3.6 Individual EI Job Status |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.