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: 'Query policies, only IDs returned'
492 operationId: getPolicyIdsUsingGET
513 description: Policy ids
519 description: Unauthorized
521 description: Forbidden
523 description: RIC or type not found
530 - A1 Policy Management
531 summary: Returns one policy type schema definition
532 operationId: getPolicySchemaUsingGET
543 description: Policy schema
547 description: Unauthorized
549 description: Forbidden
551 description: RIC is not found
558 - A1 Policy Management
559 summary: Returns policy type schema definitions
560 operationId: getPolicySchemasUsingGET
571 description: Policy schemas
577 description: Unauthorized
579 description: Forbidden
581 description: RIC is not found
588 - A1 Policy Management
589 summary: Returns a policy status
590 operationId: getPolicyStatusUsingGET
596 description: instance
601 description: Policy status
605 description: Unauthorized
607 description: Forbidden
609 description: Policy is not found
616 - A1 Policy Management
617 summary: Query policy type names
618 operationId: getPolicyTypesUsingGET
629 description: Policy type names
635 description: Unauthorized
637 description: Forbidden
639 description: RIC is not found
647 summary: Returns the name of a RIC managing one Mananged Element
648 operationId: getRicUsingGET
652 - name: managedElementId
654 description: managedElementId
659 description: RIC is fond
663 description: Unauthorized
665 description: Forbidden
667 description: RIC is not fond
675 summary: Query NearRT RIC information
676 operationId: getRicsUsingGET
682 description: policyType
691 $ref: '#/definitions/RicInfo'
693 description: Unauthorized
695 description: Forbidden
697 description: Policy type is not found
704 - Service registry and supervision
705 summary: Register a service
706 operationId: putServiceUsingPUT
713 name: registrationInfo
714 description: registrationInfo
717 $ref: '#/definitions/ServiceRegistrationInfo'
726 description: Cannot parse the ServiceRegistrationInfo
730 description: Unauthorized
732 description: Forbidden
734 description: Not Found
739 - Service registry and supervision
740 summary: Returns service information
741 operationId: getServicesUsingGET
756 $ref: '#/definitions/ServiceStatus'
758 description: Unauthorized
760 description: Forbidden
762 description: Service is not found
768 - Service registry and supervision
769 summary: Delete a service
770 operationId: deleteServiceUsingDELETE
789 description: Unauthorized
791 description: Forbidden
793 description: Service not found
800 - Service registry and supervision
801 summary: Heartbeat from a serice
802 operationId: keepAliveServiceUsingPOST
815 description: 'Service supervision timer refreshed, OK'
821 description: Unauthorized
823 description: Forbidden
825 description: 'The service is not found, needs re-registration'
831 summary: Returns status and statistics of this service
832 operationId: getStatusUsingGET
837 description: Service is living
841 description: Unauthorized
843 description: Forbidden
845 description: Not Found
858 title: 'Map«string,Link»'
859 additionalProperties:
860 $ref: '#/definitions/Link'
861 Mono«ResponseEntity«object»»:
863 title: Mono«ResponseEntity«object»»
864 Mono«ResponseEntity«string»»:
866 title: Mono«ResponseEntity«string»»
872 description: identity of the policy
875 description: the configuration of the policy
878 description: 'timestamp, last modification time'
881 description: identity the target NearRT RIC
884 description: the name of the service owning the policy
887 description: name of the policy type
894 description: O1 identities for managed entities
899 description: supported policy types
904 description: identity of the ric
906 ServiceRegistrationInfo:
913 description: callback for notifying of RIC synchronization
914 keepAliveIntervalSeconds:
917 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.'
920 description: identity of the service
921 title: ServiceRegistrationInfo
927 description: callback for notifying of RIC synchronization
928 keepAliveIntervalSeconds:
931 description: policy keep alive timeout
934 description: identity of the service
935 timeSinceLastActivitySeconds:
938 description: time since last invocation by the service