3 description: This page lists all the rest apis for the service.
5 title: A1 Policy management service
9 - name: A1 Policy Management
10 description: Policy Controller
12 description: Status Controller
13 - name: RIC Repository
14 description: Ric Repository Controller
15 - name: Service registry and supervision
16 description: Service Controller
21 - A1 Policy Management
22 summary: Query policies
23 operationId: getPoliciesUsingGET
48 $ref: '#/definitions/PolicyInfo'
50 description: Unauthorized
52 description: Forbidden
54 description: RIC or type not found
61 - A1 Policy Management
62 summary: Returns a policy configuration
63 operationId: getPolicyUsingGET
74 description: Policy found
78 description: Unauthorized
80 description: Forbidden
82 description: Policy is not found
86 - A1 Policy Management
88 operationId: putPolicyUsingPUT
101 description: jsonBody
122 description: Policy updated
126 description: Policy created
130 description: Unauthorized
132 description: Forbidden
134 description: RIC or policy type is not found
138 description: RIC is locked
144 - A1 Policy Management
145 summary: Delete a policy
146 operationId: deletePolicyUsingDELETE
152 description: instance
161 description: Policy deleted
165 description: Unauthorized
167 description: Forbidden
169 description: Policy is not found
173 description: RIC is locked
180 - A1 Policy Management
181 summary: 'Query policies, only IDs returned'
182 operationId: getPolicyIdsUsingGET
203 description: Policy ids
209 description: Unauthorized
211 description: Forbidden
213 description: RIC or type not found
220 - A1 Policy Management
221 summary: Returns one policy type schema definition
222 operationId: getPolicySchemaUsingGET
233 description: Policy schema
237 description: Unauthorized
239 description: Forbidden
241 description: RIC is not found
248 - A1 Policy Management
249 summary: Returns policy type schema definitions
250 operationId: getPolicySchemasUsingGET
261 description: Policy schemas
267 description: Unauthorized
269 description: Forbidden
271 description: RIC is not found
278 - A1 Policy Management
279 summary: Returns a policy status
280 operationId: getPolicyStatusUsingGET
286 description: instance
291 description: Policy status
295 description: Unauthorized
297 description: Forbidden
299 description: Policy is not found
306 - A1 Policy Management
307 summary: Query policy type names
308 operationId: getPolicyTypesUsingGET
319 description: Policy type names
325 description: Unauthorized
327 description: Forbidden
329 description: RIC is not found
337 summary: Returns the name of a RIC managing one Mananged Element
338 operationId: getRicUsingGET
342 - name: managedElementId
344 description: managedElementId
349 description: RIC is fond
353 description: Unauthorized
355 description: Forbidden
357 description: RIC is not fond
365 summary: Query NearRT RIC information
366 operationId: getRicsUsingGET
372 description: policyType
381 $ref: '#/definitions/RicInfo'
383 description: Unauthorized
385 description: Forbidden
387 description: Policy type is not found
394 - Service registry and supervision
395 summary: Register a service
396 operationId: putServiceUsingPUT
403 name: registrationInfo
404 description: registrationInfo
407 $ref: '#/definitions/ServiceRegistrationInfo'
410 description: Service updated
414 description: Service created
418 description: Cannot parse the ServiceRegistrationInfo
422 description: Unauthorized
424 description: Forbidden
426 description: Not Found
431 - Service registry and supervision
432 summary: Returns service information
433 operationId: getServicesUsingGET
448 $ref: '#/definitions/ServiceStatus'
450 description: Unauthorized
452 description: Forbidden
454 description: Service is not found
460 - Service registry and supervision
461 summary: Delete a service
462 operationId: deleteServiceUsingDELETE
481 description: Unauthorized
483 description: Forbidden
485 description: Service not found
492 - Service registry and supervision
493 summary: Heartbeat from a serice
494 operationId: keepAliveServiceUsingPOST
507 description: 'Service supervision timer refreshed, OK'
513 description: Unauthorized
515 description: Forbidden
517 description: 'The service is not found, needs re-registration'
523 summary: Returns status and statistics of this service
524 operationId: getStatusUsingGET
529 description: Service is living
533 description: Unauthorized
535 description: Forbidden
537 description: Not Found
540 Mono«ResponseEntity«object»»:
542 title: Mono«ResponseEntity«object»»
543 Mono«ResponseEntity«string»»:
545 title: Mono«ResponseEntity«string»»
551 description: identity of the policy
554 description: the configuration of the policy
557 description: 'timestamp, last modification time'
560 description: identity the target NearRT RIC
563 description: the name of the service owning the policy
566 description: name of the policy type
573 description: O1 identities for managed entities
578 description: supported policy types
583 description: identity of the ric
585 ServiceRegistrationInfo:
592 description: callback for notifying of RIC synchronization
593 keepAliveIntervalSeconds:
596 description: 'keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intevals must invoke a ''keepAlive'' REST call. When a service does not invoke this call within the given time, it is considered unavailble. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.'
599 description: identity of the service
600 title: ServiceRegistrationInfo
606 description: callback for notifying of RIC synchronization
607 keepAliveIntervalSeconds:
610 description: policy keep alive timeout
613 description: identity of the service
614 timeSinceLastActivitySeconds:
617 description: time since last invocation by the service