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
117 description: transient
128 description: Policy updated
132 description: Policy created
136 description: Unauthorized
138 description: Forbidden
140 description: RIC or policy type is not found
144 description: RIC is not operational
150 - A1 Policy Management
151 summary: Delete a policy
152 operationId: deletePolicyUsingDELETE
167 description: Policy deleted
171 description: Unauthorized
173 description: Forbidden
175 description: Policy is not found
179 description: RIC is not operational
186 - A1 Policy Management
187 summary: 'Query policies, only IDs returned'
188 operationId: getPolicyIdsUsingGET
209 description: Policy ids
215 description: Unauthorized
217 description: Forbidden
219 description: RIC or type not found
226 - A1 Policy Management
227 summary: Returns one policy type schema definition
228 operationId: getPolicySchemaUsingGET
239 description: Policy schema
243 description: Unauthorized
245 description: Forbidden
247 description: RIC is not found
254 - A1 Policy Management
255 summary: Returns policy type schema definitions
256 operationId: getPolicySchemasUsingGET
267 description: Policy schemas
273 description: Unauthorized
275 description: Forbidden
277 description: RIC is not found
284 - A1 Policy Management
285 summary: Returns a policy status
286 operationId: getPolicyStatusUsingGET
297 description: Policy status
301 description: Unauthorized
303 description: Forbidden
305 description: Policy is not found
312 - A1 Policy Management
313 summary: Query policy type names
314 operationId: getPolicyTypesUsingGET
325 description: Policy type names
331 description: Unauthorized
333 description: Forbidden
335 description: RIC is not found
343 summary: Returns the name of a RIC managing one Mananged Element
344 operationId: getRicUsingGET
348 - name: managedElementId
350 description: managedElementId
355 description: RIC is found
359 description: Unauthorized
361 description: Forbidden
363 description: RIC is not found
371 summary: Query Near-RT RIC information
372 operationId: getRicsUsingGET
378 description: policyType
387 $ref: '#/definitions/RicInfo'
389 description: Unauthorized
391 description: Forbidden
393 description: Policy type is not found
400 - Service registry and supervision
401 summary: Register a service
402 operationId: putServiceUsingPUT
409 name: registrationInfo
410 description: registrationInfo
413 $ref: '#/definitions/ServiceRegistrationInfo'
416 description: Service updated
420 description: Service created
424 description: The ServiceRegistrationInfo is not accepted
428 description: Unauthorized
430 description: Forbidden
432 description: Not Found
437 - Service registry and supervision
438 summary: Returns service information
439 operationId: getServicesUsingGET
454 $ref: '#/definitions/ServiceStatus'
456 description: Unauthorized
458 description: Forbidden
460 description: Service is not found
466 - Service registry and supervision
467 summary: Delete a service
468 operationId: deleteServiceUsingDELETE
487 description: Unauthorized
489 description: Forbidden
491 description: Service not found
498 - Service registry and supervision
499 summary: Heartbeat from a serice
500 operationId: keepAliveServiceUsingPUT
513 description: 'Service supervision timer refreshed, OK'
519 description: Unauthorized
521 description: Forbidden
523 description: 'The service is not found, needs re-registration'
529 summary: Returns status and statistics of this service
530 operationId: getStatusUsingGET
535 description: Service is living
539 description: Unauthorized
541 description: Forbidden
543 description: Not Found
546 Mono«ResponseEntity«object»»:
548 title: Mono«ResponseEntity«object»»
549 Mono«ResponseEntity«string»»:
551 title: Mono«ResponseEntity«string»»
557 description: identity of the policy
560 description: the configuration of the policy
563 description: 'timestamp, last modification time'
566 description: identity of the target Near-RT RIC
569 description: the name of the service owning the policy
572 description: name of the policy type
579 description: O1 identities for managed entities
584 description: supported policy types
589 description: identity of the ric
592 description: state info
594 ServiceRegistrationInfo:
601 description: callback for notifying of RIC synchronization
602 keepAliveIntervalSeconds:
605 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.'
608 description: identity of the service
609 title: ServiceRegistrationInfo
615 description: callback for notifying of RIC synchronization
616 keepAliveIntervalSeconds:
619 description: policy keep alive timeout
622 description: identity of the service
623 timeSinceLastActivitySeconds:
626 description: time since last invocation by the service