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
86 - name: subscriptionId
88 description: The subscriptionId received in the Subscription Response
93 description: Operation done successfully
95 description: Invalid subscriptionId supplied
97 description: Internal error
119 $ref: '#/definitions/EventTriggerList'
120 ReportActionDefinitions:
121 $ref: '#/definitions/ReportActionDefinition'
143 $ref: '#/definitions/EventTrigger'
148 - ActionParameterValue
152 ActionParameterValue:
154 Format1ActionDefinition:
165 $ref: '#/definitions/ActionParameters'
166 ReportActionDefinition:
169 ActionDefinitionFormat1:
170 $ref: '#/definitions/Format1ActionDefinition'
178 - PolicyActionDefinitions
187 $ref: '#/definitions/EventTriggerList'
188 PolicyActionDefinitions:
189 $ref: '#/definitions/PolicyActionDefinition'
190 PolicyActionDefinition:
193 ActionDefinitionFormat2:
194 $ref: '#/definitions/Format2ActionDefinition'
195 Format2ActionDefinition:
198 - RANUeGroupParameters
200 RANUeGroupParameters:
203 $ref: '#/definitions/RANUeGroupList'
208 - RANUeGroupDefinition
209 - RANImperativePolicy
213 RANUeGroupDefinition:
214 $ref: '#/definitions/RANUeGroupParams'
216 $ref: '#/definitions/ImperativePolicyDefinition'
225 RANParameterTestCondition:
235 ImperativePolicyDefinition:
239 - PolicyParameterValue
243 PolicyParameterValue:
245 SubscriptionResponseItem:
258 SubscriptionResponse:
261 $ref: '#/definitions/SubscriptionResponseItem'
275 description: A list of subscriptions
277 $ref: '#/definitions/SubscriptionData'