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
25 description: successful query of xApp config
27 $ref: '#/definitions/XappConfigList'
29 description: Internal error
32 summary: Returns list of subscriptions
35 operationId: getAllSubscriptions
40 description: successful query of subscriptions
42 $ref: '#/definitions/SubscriptionList'
44 description: Internal error
48 operationId: Subscribe
49 summary: Subscribe a list of X2AP event triggers to receive messages sent by RAN
55 - name: SubscriptionParams
57 description: Subscription parameters
59 $ref: '#/definitions/SubscriptionParams'
62 description: Subscription successfully created
64 $ref: '#/definitions/SubscriptionResponse'
66 description: Invalid input
68 description: Internal error
69 '/subscriptions/{subscriptionId}':
73 summary: Unsubscribe X2AP events from Subscription Manager
74 operationId: Unsubscribe
80 - name: subscriptionId
82 description: The subscriptionId received in the Subscription Response
87 description: Operation done successfully
89 description: Invalid subscriptionId supplied
91 description: Internal error
101 description: Name of the xApp
104 description: The type of the content
116 $ref: '#/definitions/ConfigMetadata'
119 description: Configuration in JSON format
123 $ref: '#/definitions/XAppConfig'
126 description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
131 description: SubsequentAction is an OPTIONAL IE
134 - SubsequentActionType
137 SubsequentActionType:
180 $ref: '#/definitions/ActionDefinition'
182 $ref: '#/definitions/SubsequentAction'
186 $ref: '#/definitions/ActionToBeSetup'
187 EventTriggerDefinition:
189 description: E2SM Octet string
196 - XappEventInstanceId
198 - ActionToBeSetupList
205 $ref: '#/definitions/EventTriggerDefinition'
207 $ref: '#/definitions/ActionsToBeSetup'
208 SubscriptionDetailsList:
211 $ref: '#/definitions/SubscriptionDetail'
218 - SubscriptionDetails
222 description: Optional subscription ID (Submgr allocates if not given)
225 description: xApp service address and port
229 xApp service address name like
230 'service-ricxapp-xappname-http.ricxapp'
233 description: xApp HTTP service address port
238 description: xApp RMR service address port
249 $ref: '#/definitions/SubscriptionDetailsList'
250 SubscriptionResponse:
254 - SubscriptionInstances
258 SubscriptionInstances:
261 $ref: '#/definitions/SubscriptionInstance'
262 SubscriptionInstance:
265 - XappEventInstanceId
278 description: Empty string when no error.
291 SubscriptionInstances:
294 $ref: '#/definitions/SubscriptionInstance'
297 description: A list of subscriptions
299 $ref: '#/definitions/SubscriptionData'