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'
127 description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
132 description: SubsequentAction is an OPTIONAL IE
135 - SubsequentActionType
138 SubsequentActionType:
181 $ref: '#/definitions/ActionDefinition'
183 $ref: '#/definitions/SubsequentAction'
187 $ref: '#/definitions/ActionToBeSetup'
188 EventTriggerDefinition:
190 description: E2SM Octet string
200 - ActionToBeSetupList
211 $ref: '#/definitions/EventTriggerDefinition'
213 $ref: '#/definitions/ActionsToBeSetup'
214 SubscriptionDetailsList:
217 $ref: '#/definitions/SubscriptionDetail'
224 - SubscriptionDetails
228 description: xApp service address and port
232 xApp service address name like 'service-ricxapp-xappname-http.ricxapp'
235 description: xApp HTTP service address port
240 description: xApp RMR service address port
251 $ref: '#/definitions/SubscriptionDetailsList'
252 SubscriptionResponse:
256 - SubscriptionInstances
260 SubscriptionInstances:
263 $ref: '#/definitions/SubscriptionInstance'
264 SubscriptionInstance:
280 description: Empty string when no error.
293 SubscriptionInstances:
296 $ref: '#/definitions/SubscriptionInstance'
299 description: A list of subscriptions
301 $ref: '#/definitions/SubscriptionData'