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
17 - name: operation-handler
18 description: Operation Handler
19 - name: web-mvc-links-handler
20 description: Web Mvc Links Handler
25 - web-mvc-links-handler
27 operationId: linksUsingGET
29 - application/vnd.spring-boot.actuator.v3+json
31 - application/vnd.spring-boot.actuator.v2+json
40 $ref: '#/definitions/Link'
42 description: Unauthorized
44 description: Forbidden
46 description: Not Found
53 operationId: handleUsingGET_1
55 - application/vnd.spring-boot.actuator.v3+json
57 - application/vnd.spring-boot.actuator.v2+json
73 description: Unauthorized
75 description: Forbidden
77 description: Not Found
84 operationId: handleUsingGET
86 - application/vnd.spring-boot.actuator.v3+json
88 - application/vnd.spring-boot.actuator.v2+json
104 description: Unauthorized
106 description: Forbidden
108 description: Not Found
115 operationId: handleUsingGET_2
117 - application/vnd.spring-boot.actuator.v3+json
119 - application/vnd.spring-boot.actuator.v2+json
127 additionalProperties:
135 description: Unauthorized
137 description: Forbidden
139 description: Not Found
146 operationId: handleUsingGET_3
148 - text/plain;charset=UTF-8
156 additionalProperties:
164 description: Unauthorized
166 description: Forbidden
168 description: Not Found
175 operationId: handleUsingGET_5
177 - application/vnd.spring-boot.actuator.v3+json
179 - application/vnd.spring-boot.actuator.v2+json
187 additionalProperties:
195 description: Unauthorized
197 description: Forbidden
199 description: Not Found
201 '/actuator/loggers/{name}':
206 operationId: handleUsingGET_4
208 - application/vnd.spring-boot.actuator.v3+json
210 - application/vnd.spring-boot.actuator.v2+json
218 additionalProperties:
226 description: Unauthorized
228 description: Forbidden
230 description: Not Found
236 operationId: handleUsingPOST
238 - application/vnd.spring-boot.actuator.v3+json
240 - application/vnd.spring-boot.actuator.v2+json
250 additionalProperties:
260 description: Unauthorized
262 description: Forbidden
264 description: Not Found
271 operationId: handleUsingGET_7
273 - application/vnd.spring-boot.actuator.v3+json
275 - application/vnd.spring-boot.actuator.v2+json
283 additionalProperties:
291 description: Unauthorized
293 description: Forbidden
295 description: Not Found
297 '/actuator/metrics/{requiredMetricName}':
302 operationId: handleUsingGET_6
304 - application/vnd.spring-boot.actuator.v3+json
306 - application/vnd.spring-boot.actuator.v2+json
314 additionalProperties:
322 description: Unauthorized
324 description: Forbidden
326 description: Not Found
331 - A1 Policy Management
332 summary: Query policies
333 operationId: getPoliciesUsingGET
354 description: Policies
358 $ref: '#/definitions/PolicyInfo'
360 description: Unauthorized
362 description: Forbidden
364 description: RIC or type not found
371 - A1 Policy Management
372 summary: Returns a policy configuration
373 operationId: getPolicyUsingGET
379 description: instance
384 description: Policy found
388 description: Unauthorized
390 description: Forbidden
392 description: Policy is not found
396 - A1 Policy Management
397 summary: Put a policy
398 operationId: putPolicyUsingPUT
406 description: instance
411 description: jsonBody
432 description: Policy updated
436 description: Policy created
440 description: Unauthorized
442 description: Forbidden
444 description: RIC or policy type is not found
448 description: RIC is locked
454 - A1 Policy Management
455 summary: Delete a policy
456 operationId: deletePolicyUsingDELETE
462 description: instance
471 description: Policy deleted
475 description: Unauthorized
477 description: Forbidden
479 description: Policy is not found
483 description: RIC is locked
490 - A1 Policy Management
491 summary: Returns one policy type schema definition
492 operationId: getPolicySchemaUsingGET
503 description: Policy schema
507 description: Unauthorized
509 description: Forbidden
511 description: RIC is not found
518 - A1 Policy Management
519 summary: Returns policy type schema definitions
520 operationId: getPolicySchemasUsingGET
531 description: Policy schemas
537 description: Unauthorized
539 description: Forbidden
541 description: RIC is not found
548 - A1 Policy Management
549 summary: Returns a policy status
550 operationId: getPolicyStatusUsingGET
556 description: instance
561 description: Policy status
565 description: Unauthorized
567 description: Forbidden
569 description: Policy is not found
576 - A1 Policy Management
577 summary: Query policy type names
578 operationId: getPolicyTypesUsingGET
589 description: Policy type names
595 description: Unauthorized
597 description: Forbidden
599 description: RIC is not found
607 summary: Returns the name of a RIC managing one Mananged Element
608 operationId: getRicUsingGET
612 - name: managedElementId
614 description: managedElementId
619 description: RIC is fond
623 description: Unauthorized
625 description: Forbidden
627 description: RIC is not fond
635 summary: Query NearRT RIC information
636 operationId: getRicsUsingGET
642 description: policyType
651 $ref: '#/definitions/RicInfo'
653 description: Unauthorized
655 description: Forbidden
657 description: Policy type is not found
664 - Service registry and supervision
665 summary: Register a service
666 operationId: putServiceUsingPUT
673 name: registrationInfo
674 description: registrationInfo
677 $ref: '#/definitions/ServiceRegistrationInfo'
686 description: Cannot parse the ServiceRegistrationInfo
690 description: Unauthorized
692 description: Forbidden
694 description: Not Found
699 - Service registry and supervision
700 summary: Returns service information
701 operationId: getServicesUsingGET
716 $ref: '#/definitions/ServiceStatus'
718 description: Unauthorized
720 description: Forbidden
722 description: Service is not found
728 - Service registry and supervision
729 summary: Delete a service
730 operationId: deleteServiceUsingDELETE
749 description: Unauthorized
751 description: Forbidden
753 description: Service not found
760 - Service registry and supervision
761 summary: Heartbeat from a serice
762 operationId: keepAliveServiceUsingPOST
775 description: 'Service supervision timer refreshed, OK'
781 description: Unauthorized
783 description: Forbidden
785 description: 'The service is not found, needs re-registration'
791 summary: Returns status and statistics of this service
792 operationId: getStatusUsingGET
797 description: Service is living
801 description: Unauthorized
803 description: Forbidden
805 description: Not Found
818 title: 'Map«string,Link»'
819 additionalProperties:
820 $ref: '#/definitions/Link'
821 Mono«ResponseEntity«object»»:
823 title: Mono«ResponseEntity«object»»
824 Mono«ResponseEntity«string»»:
826 title: Mono«ResponseEntity«string»»
832 description: identity of the policy
835 description: the configuration of the policy
838 description: 'timestamp, last modification time'
841 description: identity the target NearRT RIC
844 description: the name of the service owning the policy
847 description: name of the policy type
854 description: O1 identities for managed entities
859 description: supported policy types
864 description: identity of the ric
866 ServiceRegistrationInfo:
873 description: callback for notifying of RIC synchronization
874 keepAliveIntervalSeconds:
877 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.'
880 description: identity of the service
881 title: ServiceRegistrationInfo
887 description: callback for notifying of RIC synchronization
888 keepAliveIntervalSeconds:
891 description: policy keep alive timeout
894 description: identity of the service
895 timeSinceLastActivitySeconds:
898 description: time since last invocation by the service