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: Not Found
68 description: Invalid input
70 description: Internal error
72 description: Service Unavailable
73 '/subscriptions/{subscriptionId}':
77 summary: Unsubscribe X2AP events from Subscription Manager
78 operationId: Unsubscribe
84 - name: subscriptionId
86 description: The subscriptionId received in the Subscription Response
91 description: Operation done successfully
93 description: Invalid subscriptionId supplied
95 description: Internal error
105 description: Name of the xApp
108 description: The type of the content
120 $ref: '#/definitions/ConfigMetadata'
123 description: Configuration in JSON format
127 $ref: '#/definitions/XAppConfig'
130 description: E2SM byte array. ActionDefinition is an OPTIONAL IE
134 description: SubsequentAction is an OPTIONAL IE
137 - SubsequentActionType
140 SubsequentActionType:
183 $ref: '#/definitions/ActionDefinition'
185 $ref: '#/definitions/SubsequentAction'
189 $ref: '#/definitions/ActionToBeSetup'
190 EventTriggerDefinition:
192 description: E2SM byte array
198 - XappEventInstanceId
200 - ActionToBeSetupList
207 $ref: '#/definitions/EventTriggerDefinition'
209 $ref: '#/definitions/ActionsToBeSetup'
210 SubscriptionDetailsList:
213 $ref: '#/definitions/SubscriptionDetail'
220 - SubscriptionDetails
224 description: Optional subscription ID (Submgr allocates if not given)
227 description: xApp service address and port
231 xApp service address name like
232 'service-ricxapp-xappname-http.ricxapp'
235 description: xApp HTTP service address port
240 description: xApp RMR service address port
250 E2SubscriptionDirectives:
251 description: Optional. If not set Submgr uses its default values
255 description: How long time response is waited from E2 node
260 description: How many times E2 subscription request is retried
265 description: Subscription needs RMR route from E2Term to xApp
268 $ref: '#/definitions/SubscriptionDetailsList'
269 SubscriptionResponse:
273 - SubscriptionInstances
277 SubscriptionInstances:
280 $ref: '#/definitions/SubscriptionInstance'
281 SubscriptionInstance:
284 - XappEventInstanceId
296 description: Descriptive error cause. Empty string when no error.
299 description: Source of error cause.
301 enum: [SUBMGR, RTMGR, DBAAS, ASN1, E2Node]
303 description: Type timeout. xApp should retry if timeout occurs.
305 enum: [E2-Timeout, RTMGR-Timeout, DBAAS-Timeout]
317 SubscriptionInstances:
320 $ref: '#/definitions/SubscriptionInstance'
323 description: A list of subscriptions
325 $ref: '#/definitions/SubscriptionData'