3 description: This is the initial REST API for RIC subscription
5 title: RIC subscription
8 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
16 summary: Returns the configuration of all xapps
19 operationId: getXappConfigList
24 description: successful query of xApp config
26 $ref: '#/definitions/XappConfigList'
28 description: Internal error
31 summary: Returns list of subscriptions
34 operationId: getAllSubscriptions
39 description: successful query of subscriptions
41 $ref: '#/definitions/SubscriptionList'
43 description: Internal error
44 /subscriptions/report:
48 summary: Subscribe a list of X2AP event triggers to receive "REPORT" messages sent by RAN or Subscribe to receive the content of gNB NRT table in REPORT message sent by RAN
49 operationId: subscribeReport
57 description: Subscription report parameters
59 $ref: '#/definitions/ReportParams'
62 description: Subscription successfully created
64 $ref: '#/definitions/SubscriptionResponse'
66 description: Invalid input
68 description: Internal error
69 /subscriptions/policy:
73 summary: Subscribe and send "POLICY" message to RAN to execute a specific POLICY during call processing in RAN after each occurrence of a defined SUBSCRIPTION
74 operationId: subscribePolicy
82 description: Subscription policy parameters
84 $ref: '#/definitions/PolicyParams'
87 description: Subscription successfully created
89 $ref: '#/definitions/SubscriptionResponse'
91 description: Invalid input
93 description: Internal error
94 /subscriptions/{subscriptionId}:
98 summary: Unsubscribe X2AP events from Subscription Manager
99 operationId: Unsubscribe
105 - name: subscriptionId
107 description: The subscriptionId received in the Subscription Response
112 description: Operation done successfully
114 description: Invalid subscriptionId supplied
116 description: Internal error
125 $ref: '#/definitions/ConfigMetadata'
128 description: Configuration in JSON format
132 $ref: '#/definitions/XAppConfig'
153 $ref: '#/definitions/EventTriggerList'
154 ReportActionDefinitions:
155 $ref: '#/definitions/ReportActionDefinition'
177 $ref: '#/definitions/EventTrigger'
182 - ActionParameterValue
186 ActionParameterValue:
188 Format1ActionDefinition:
199 $ref: '#/definitions/ActionParameters'
200 ReportActionDefinition:
203 ActionDefinitionFormat1:
204 $ref: '#/definitions/Format1ActionDefinition'
212 - PolicyActionDefinitions
221 $ref: '#/definitions/EventTriggerList'
222 PolicyActionDefinitions:
223 $ref: '#/definitions/PolicyActionDefinition'
224 PolicyActionDefinition:
227 ActionDefinitionFormat2:
228 $ref: '#/definitions/Format2ActionDefinition'
229 Format2ActionDefinition:
232 - RANUeGroupParameters
234 RANUeGroupParameters:
237 $ref: '#/definitions/RANUeGroupList'
242 - RANUeGroupDefinition
243 - RANImperativePolicy
247 RANUeGroupDefinition:
248 $ref: '#/definitions/RANUeGroupParams'
250 $ref: '#/definitions/ImperativePolicyDefinition'
259 RANParameterTestCondition:
269 ImperativePolicyDefinition:
273 - PolicyParameterValue
277 PolicyParameterValue:
279 SubscriptionInstance:
289 SubscriptionResponse:
293 - SubscriptionInstances
297 SubscriptionInstances:
300 $ref: '#/definitions/SubscriptionInstance'
314 description: A list of subscriptions
316 $ref: '#/definitions/SubscriptionData'