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 list of subscriptions
19 operationId: getAllSubscriptions
24 description: successful query of subscriptions
26 $ref: '#/definitions/SubscriptionList'
28 description: Internal error
29 /subscriptions/report:
33 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
34 operationId: subscribeReport
42 description: Subscription report parameters
44 $ref: '#/definitions/ReportParams'
47 description: Subscription successfully created
49 $ref: '#/definitions/SubscriptionResponse'
51 description: Invalid input
53 description: Internal error
54 /subscriptions/policy:
58 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
59 operationId: subscribePolicy
67 description: Subscription policy parameters
69 $ref: '#/definitions/PolicyParams'
72 description: Subscription successfully created
74 $ref: '#/definitions/SubscriptionResponse'
76 description: Invalid input
78 description: Internal error
79 /subscriptions/{subscriptionId}:
83 summary: Unsubscribe X2AP events from Subscription Manager
84 operationId: Unsubscribe
90 - name: subscriptionId
92 description: The subscriptionId received in the Subscription Response
97 description: Operation done successfully
99 description: Invalid subscriptionId supplied
101 description: Internal error
123 $ref: '#/definitions/EventTriggerList'
124 ReportActionDefinitions:
125 $ref: '#/definitions/ReportActionDefinition'
147 $ref: '#/definitions/EventTrigger'
152 - ActionParameterValue
156 ActionParameterValue:
158 Format1ActionDefinition:
169 $ref: '#/definitions/ActionParameters'
170 ReportActionDefinition:
173 ActionDefinitionFormat1:
174 $ref: '#/definitions/Format1ActionDefinition'
182 - PolicyActionDefinitions
191 $ref: '#/definitions/EventTriggerList'
192 PolicyActionDefinitions:
193 $ref: '#/definitions/PolicyActionDefinition'
194 PolicyActionDefinition:
197 ActionDefinitionFormat2:
198 $ref: '#/definitions/Format2ActionDefinition'
199 Format2ActionDefinition:
202 - RANUeGroupParameters
204 RANUeGroupParameters:
207 $ref: '#/definitions/RANUeGroupList'
212 - RANUeGroupDefinition
213 - RANImperativePolicy
217 RANUeGroupDefinition:
218 $ref: '#/definitions/RANUeGroupParams'
220 $ref: '#/definitions/ImperativePolicyDefinition'
229 RANParameterTestCondition:
239 ImperativePolicyDefinition:
243 - PolicyParameterValue
247 PolicyParameterValue:
249 SubscriptionInstance:
259 SubscriptionResponse:
263 - SubscriptionInstances
267 SubscriptionInstances:
270 $ref: '#/definitions/SubscriptionInstance'
284 description: A list of subscriptions
286 $ref: '#/definitions/SubscriptionData'