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
29 description: The name of the Near-RT RIC to get policies for.
32 allowEmptyValue: false
35 description: The name of the service to get policies for.
38 allowEmptyValue: false
41 description: The name of the policy type to get policies for.
44 allowEmptyValue: false
51 $ref: '#/definitions/PolicyInfo'
53 description: Unauthorized
55 description: Forbidden
57 description: RIC or type not found
64 - A1 Policy Management
65 summary: Returns a policy configuration
66 operationId: getPolicyUsingGET
72 description: The ID of the policy instance.
75 allowEmptyValue: false
78 description: Policy found
82 description: Unauthorized
84 description: Forbidden
86 description: Policy is not found
90 - A1 Policy Management
92 operationId: putPolicyUsingPUT
100 description: The ID of the policy instance.
103 allowEmptyValue: false
106 description: jsonBody
112 description: The name of the Near-RT RIC where the policy will be created.
115 allowEmptyValue: false
118 description: The name of the service creating the policy.
121 allowEmptyValue: false
124 description: If the policy is transient or not (boolean defaulted to false). A policy is transient if it will be forgotten when the service needs to reconnect to the Near-RT RIC.
128 allowEmptyValue: false
132 description: The name of the policy type.
135 allowEmptyValue: false
138 description: Policy updated
142 description: Policy created
146 description: Unauthorized
148 description: Forbidden
150 description: RIC or policy type is not found
154 description: RIC is not operational
160 - A1 Policy Management
161 summary: Delete a policy
162 operationId: deletePolicyUsingDELETE
168 description: The ID of the policy instance.
171 allowEmptyValue: false
178 description: Policy deleted
182 description: Unauthorized
184 description: Forbidden
186 description: Policy is not found
190 description: RIC is not operational
197 - A1 Policy Management
198 summary: 'Query policies, only IDs returned'
199 operationId: getPolicyIdsUsingGET
205 description: The name of the Near-RT RIC to get policies for.
208 allowEmptyValue: false
211 description: The name of the service to get policies for.
214 allowEmptyValue: false
217 description: The name of the policy type to get policies for.
220 allowEmptyValue: false
223 description: Policy ids
229 description: Unauthorized
231 description: Forbidden
233 description: RIC or type not found
240 - A1 Policy Management
241 summary: Returns one policy type schema definition
242 operationId: getPolicySchemaUsingGET
248 description: The ID of the policy type to get the definition for.
251 allowEmptyValue: false
254 description: Policy schema
258 description: Unauthorized
260 description: Forbidden
262 description: RIC is not found
269 - A1 Policy Management
270 summary: Returns policy type schema definitions
271 operationId: getPolicySchemasUsingGET
277 description: The name of the Near-RT RIC to get the definitions for.
280 allowEmptyValue: false
283 description: Policy schemas
289 description: Unauthorized
291 description: Forbidden
293 description: RIC is not found
300 - A1 Policy Management
301 summary: Returns a policy status
302 operationId: getPolicyStatusUsingGET
308 description: The ID of the policy.
311 allowEmptyValue: false
314 description: Policy status
318 description: Unauthorized
320 description: Forbidden
322 description: Policy is not found
329 - A1 Policy Management
330 summary: Query policy type names
331 operationId: getPolicyTypesUsingGET
337 description: The name of the Near-RT RIC to get types for.
340 allowEmptyValue: false
343 description: Policy type names
349 description: Unauthorized
351 description: Forbidden
353 description: RIC is not found
361 summary: Returns the name of a RIC managing one Mananged Element
362 operationId: getRicUsingGET
366 - name: managedElementId
368 description: managedElementId
373 description: RIC is found
377 description: Unauthorized
379 description: Forbidden
381 description: RIC is not found
389 summary: Query Near-RT RIC information
390 operationId: getRicsUsingGET
396 description: policyType
405 $ref: '#/definitions/RicInfo'
407 description: Unauthorized
409 description: Forbidden
411 description: Policy type is not found
418 - Service registry and supervision
419 summary: Register a service
420 operationId: putServiceUsingPUT
427 name: registrationInfo
428 description: registrationInfo
431 $ref: '#/definitions/ServiceRegistrationInfo'
434 description: Service updated
438 description: Service created
442 description: The ServiceRegistrationInfo is not accepted
446 description: Unauthorized
448 description: Forbidden
450 description: Not Found
455 - Service registry and supervision
456 summary: Returns service information
457 operationId: getServicesUsingGET
472 $ref: '#/definitions/ServiceStatus'
474 description: Unauthorized
476 description: Forbidden
478 description: Service is not found
484 - Service registry and supervision
485 summary: Delete a service
486 operationId: deleteServiceUsingDELETE
505 description: Unauthorized
507 description: Forbidden
509 description: Service not found
516 - Service registry and supervision
517 summary: Heartbeat from a serice
518 operationId: keepAliveServiceUsingPUT
531 description: 'Service supervision timer refreshed, OK'
537 description: Unauthorized
539 description: Forbidden
541 description: 'The service is not found, needs re-registration'
547 summary: Returns status and statistics of this service
548 operationId: getStatusUsingGET
553 description: Service is living
557 description: Unauthorized
559 description: Forbidden
561 description: Not Found
564 Mono«ResponseEntity«object»»:
566 title: Mono«ResponseEntity«object»»
567 Mono«ResponseEntity«string»»:
569 title: Mono«ResponseEntity«string»»
575 description: identity of the policy
578 description: the configuration of the policy
581 description: 'timestamp, last modification time'
584 description: identity of the target Near-RT RIC
587 description: the name of the service owning the policy
590 description: name of the policy type
597 description: O1 identities for managed entities
602 description: supported policy types
607 description: identity of the ric
610 description: state info
612 ServiceRegistrationInfo:
619 description: callback for notifying of RIC synchronization
620 keepAliveIntervalSeconds:
623 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.'
626 description: identity of the service
627 title: ServiceRegistrationInfo
633 description: callback for notifying of RIC synchronization
634 keepAliveIntervalSeconds:
637 description: policy keep alive timeout
640 description: identity of the service
641 timeSinceLastActivitySeconds:
644 description: time since last invocation by the service