4 "/policy_types": {"get": {
5 "summary": "Query policy type names",
8 "operationId": "getPolicyTypesUsingGET_1",
13 "items": {"type": "string"}
15 "description": "Policy type names"
17 "401": {"description": "Unauthorized"},
18 "403": {"description": "Forbidden"},
20 "schema": {"type": "string"},
21 "description": "Near-RT RIC is not found"
26 "allowEmptyValue": false,
28 "description": "The name of the Near-RT RIC to get types for.",
32 "tags": ["A1 Policy Management Version 1.0"]
34 "/v2/status": {"get": {
35 "summary": "Returns status and statistics of this service",
37 "produces": ["application/json"],
38 "operationId": "getStatusUsingGET_1",
41 "schema": {"$ref": "#/definitions/status_info_v2"},
42 "description": "Service is living"
44 "401": {"description": "Unauthorized"},
45 "403": {"description": "Forbidden"},
46 "404": {"description": "Not Found"}
48 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
50 "/v2/policy-types": {"get": {
51 "summary": "Query policy type identities",
53 "produces": ["application/json"],
54 "operationId": "getPolicyTypesUsingGET",
57 "schema": {"$ref": "#/definitions/policytype_id_list_v2"},
58 "description": "Policy type IDs"
60 "401": {"description": "Unauthorized"},
61 "403": {"description": "Forbidden"},
63 "schema": {"$ref": "#/definitions/error_information"},
64 "description": "Near-RT RIC is not found"
69 "allowEmptyValue": false,
71 "description": "The identity of the Near-RT RIC to get types for.",
75 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
79 "summary": "Returns service information",
82 "operationId": "getServicesUsingGET",
87 "items": {"$ref": "#/definitions/service_status_v1"}
91 "401": {"description": "Unauthorized"},
92 "403": {"description": "Forbidden"},
94 "schema": {"type": "string"},
95 "description": "Service is not found"
100 "allowEmptyValue": false,
102 "description": "The name of the service",
106 "tags": ["A1 Policy Management Version 1.0"]
109 "summary": "Delete a service",
112 "operationId": "deleteServiceUsingDELETE",
115 "schema": {"type": "string"},
118 "401": {"description": "Unauthorized"},
120 "schema": {"type": "string"},
121 "description": "Service deleted"
123 "403": {"description": "Forbidden"},
125 "schema": {"type": "string"},
126 "description": "Service not found"
131 "allowEmptyValue": false,
133 "description": "The name of the service",
137 "tags": ["A1 Policy Management Version 1.0"]
140 "/v2/services/{service_id}": {"delete": {
141 "summary": "Unregister a service",
144 "operationId": "deleteServiceUsingDELETE_1",
146 "200": {"description": "Not used"},
147 "401": {"description": "Unauthorized"},
149 "schema": {"type": "object"},
150 "description": "Service unregistered"
152 "403": {"description": "Forbidden"},
154 "schema": {"$ref": "#/definitions/error_information"},
155 "description": "Service not found"
160 "name": "service_id",
161 "description": "service_id",
165 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
169 "summary": "Returns a policy configuration",
172 "operationId": "getPolicyUsingGET_1",
175 "schema": {"type": "object"},
176 "description": "Policy found"
178 "401": {"description": "Unauthorized"},
179 "403": {"description": "Forbidden"},
180 "404": {"description": "Policy is not found"}
184 "allowEmptyValue": false,
186 "description": "The identity of the policy instance.",
190 "tags": ["A1 Policy Management Version 1.0"]
193 "summary": "Delete a policy",
196 "operationId": "deletePolicyUsingDELETE_1",
198 "200": {"description": "Not used"},
199 "401": {"description": "Unauthorized"},
201 "schema": {"type": "string"},
202 "description": "Near-RT RIC is not operational"
204 "204": {"description": "Policy deleted"},
205 "403": {"description": "Forbidden"},
207 "schema": {"type": "string"},
208 "description": "Policy is not found"
213 "allowEmptyValue": false,
215 "description": "The identity of the policy instance.",
219 "tags": ["A1 Policy Management Version 1.0"]
222 "summary": "Put a policy",
225 "operationId": "putPolicyUsingPUT_1",
227 "200": {"description": "Policy updated"},
228 "201": {"description": "Policy created"},
229 "401": {"description": "Unauthorized"},
231 "schema": {"type": "string"},
232 "description": "Near-RT RIC is not operational"
234 "403": {"description": "Forbidden"},
236 "schema": {"type": "string"},
237 "description": "Near-RT RIC or policy type is not found"
243 "allowEmptyValue": false,
245 "description": "The identity of the policy instance.",
250 "schema": {"type": "object"},
253 "description": "jsonBody",
258 "allowEmptyValue": false,
260 "description": "The name of the Near-RT RIC where the policy will be created.",
266 "allowEmptyValue": false,
268 "description": "The name of the service creating the policy.",
275 "allowEmptyValue": false,
278 "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.",
284 "allowEmptyValue": false,
286 "description": "The name of the policy type.",
291 "tags": ["A1 Policy Management Version 1.0"],
292 "consumes": ["application/json"]
295 "/policies": {"get": {
296 "summary": "Query policies",
299 "operationId": "getPoliciesUsingGET",
304 "items": {"$ref": "#/definitions/policy_info_v1"}
306 "description": "Policies"
308 "401": {"description": "Unauthorized"},
309 "403": {"description": "Forbidden"},
311 "schema": {"type": "string"},
312 "description": "Near-RT RIC or type not found"
318 "allowEmptyValue": false,
320 "description": "The name of the Near-RT RIC to get policies for.",
326 "allowEmptyValue": false,
328 "description": "The name of the service to get policies for.",
334 "allowEmptyValue": false,
336 "description": "The name of the policy type to get policies for.",
341 "tags": ["A1 Policy Management Version 1.0"]
343 "/v2/policies/{policy_id}": {
345 "summary": "Returns a policy",
347 "produces": ["application/json"],
348 "operationId": "getPolicyUsingGET",
351 "schema": {"$ref": "#/definitions/policy_info_v2"},
352 "description": "Policy found"
354 "401": {"description": "Unauthorized"},
355 "403": {"description": "Forbidden"},
357 "schema": {"$ref": "#/definitions/error_information"},
358 "description": "Policy is not found"
364 "description": "policy_id",
368 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
371 "summary": "Delete a policy",
374 "operationId": "deletePolicyUsingDELETE",
376 "200": {"description": "Not used"},
377 "401": {"description": "Unauthorized"},
379 "schema": {"$ref": "#/definitions/error_information"},
380 "description": "Near-RT RIC is not operational"
382 "204": {"description": "Policy deleted"},
383 "403": {"description": "Forbidden"},
385 "schema": {"$ref": "#/definitions/error_information"},
386 "description": "Policy is not found"
392 "description": "policy_id",
396 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
399 "/policy_schema": {"get": {
400 "summary": "Returns one policy type schema definition",
403 "operationId": "getPolicySchemaUsingGET",
406 "schema": {"type": "object"},
407 "description": "Policy schema"
409 "401": {"description": "Unauthorized"},
410 "403": {"description": "Forbidden"},
412 "schema": {"type": "string"},
413 "description": "The policy type is not found"
418 "allowEmptyValue": false,
420 "description": "The identity of the policy type to get the definition for.",
424 "tags": ["A1 Policy Management Version 1.0"]
427 "summary": "Query Near-RT RIC information",
430 "operationId": "getRicsUsingGET_1",
435 "items": {"$ref": "#/definitions/ric_info_v1"}
439 "401": {"description": "Unauthorized"},
440 "403": {"description": "Forbidden"},
442 "schema": {"type": "string"},
443 "description": "Policy type is not found"
448 "allowEmptyValue": false,
449 "name": "policyType",
450 "description": "The name of the policy type",
454 "tags": ["A1 Policy Management Version 1.0"]
456 "/policy_status": {"get": {
457 "summary": "Returns a policy status",
460 "operationId": "getPolicyStatusUsingGET_1",
463 "schema": {"type": "object"},
464 "description": "Policy status"
466 "401": {"description": "Unauthorized"},
467 "403": {"description": "Forbidden"},
469 "schema": {"type": "string"},
470 "description": "Policy is not found"
475 "allowEmptyValue": false,
477 "description": "The identity of the policy.",
481 "tags": ["A1 Policy Management Version 1.0"]
483 "/v2/policies/{policy_id}/status": {"get": {
484 "summary": "Returns a policy status",
486 "produces": ["application/json"],
487 "operationId": "getPolicyStatusUsingGET",
490 "schema": {"$ref": "#/definitions/policy_status_info_v2"},
491 "description": "Policy status"
493 "401": {"description": "Unauthorized"},
494 "403": {"description": "Forbidden"},
496 "schema": {"$ref": "#/definitions/error_information"},
497 "description": "Policy is not found"
503 "description": "policy_id",
507 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
509 "/v2/rics": {"get": {
510 "summary": "Query Near-RT RIC information",
512 "produces": ["application/json"],
513 "description": "The call returns all Near-RT RICs that supports a given policy type identity",
514 "operationId": "getRicsUsingGET",
517 "schema": {"$ref": "#/definitions/ric_info_list_v2"},
520 "401": {"description": "Unauthorized"},
521 "403": {"description": "Forbidden"},
523 "schema": {"$ref": "#/definitions/error_information"},
524 "description": "Policy type is not found"
529 "allowEmptyValue": false,
530 "name": "policytype_id",
531 "description": "The identity of a policy type. If given, all Near-RT RICs supporteing the policy type are returned",
535 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
537 "/v2/configuration": {
539 "summary": "Returns the contents of the configuration file",
541 "produces": ["application/json"],
542 "description": "Note that the file contents is not relevant if the Consul is used.",
543 "operationId": "getConfigurationUsingGET",
546 "schema": {"type": "object"},
547 "description": "Configuration"
549 "401": {"description": "Unauthorized"},
550 "403": {"description": "Forbidden"},
552 "schema": {"$ref": "#/definitions/error_information"},
553 "description": "File is not found or readable"
556 "tags": ["Component Configuration"]
559 "summary": "Replace the current configuration file with the given configuration",
562 "description": "Note that the file is ignored if the Consul is used.",
563 "operationId": "putConfigurationUsingPUT",
565 "200": {"description": "Configuration updated"},
566 "201": {"description": "Created"},
568 "schema": {"$ref": "#/definitions/error_information"},
569 "description": "Invalid configuration provided"
571 "401": {"description": "Unauthorized"},
573 "schema": {"$ref": "#/definitions/error_information"},
574 "description": "Something went wrong when replacing the configuration. Try again."
576 "403": {"description": "Forbidden"},
577 "404": {"description": "Not Found"}
580 "schema": {"type": "object"},
582 "name": "configuration",
583 "description": "configuration",
586 "tags": ["Component Configuration"],
587 "consumes": ["application/json"]
590 "/policy_ids": {"get": {
591 "summary": "Query policies, only policy identities returned",
594 "operationId": "getPolicyIdsUsingGET_1",
599 "items": {"type": "string"}
601 "description": "Policy identitiess"
603 "401": {"description": "Unauthorized"},
604 "403": {"description": "Forbidden"},
606 "schema": {"type": "string"},
607 "description": "Near-RT RIC or type not found"
613 "allowEmptyValue": false,
615 "description": "The name of the Near-RT RIC to get policies for.",
621 "allowEmptyValue": false,
623 "description": "The name of the service to get policies for.",
629 "allowEmptyValue": false,
631 "description": "The name of the policy type to get policies for.",
636 "tags": ["A1 Policy Management Version 1.0"]
638 "/policy_schemas": {"get": {
639 "summary": "Returns policy type schema definitions",
642 "operationId": "getPolicySchemasUsingGET",
647 "items": {"type": "object"}
649 "description": "Policy schemas"
651 "401": {"description": "Unauthorized"},
652 "403": {"description": "Forbidden"},
654 "schema": {"type": "string"},
655 "description": "Near-RT RIC is not found"
660 "allowEmptyValue": false,
662 "description": "The name of the Near-RT RIC to get the definitions for.",
666 "tags": ["A1 Policy Management Version 1.0"]
668 "/v2/policy-instances": {"get": {
669 "summary": "Query for A1 policy instances",
671 "produces": ["application/json"],
672 "description": "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",
673 "operationId": "getPolicyInstancesUsingGET",
676 "schema": {"$ref": "#/definitions/policy_info_list_v2"},
677 "description": "Policies"
679 "401": {"description": "Unauthorized"},
680 "403": {"description": "Forbidden"},
682 "schema": {"$ref": "#/definitions/error_information"},
683 "description": "Near-RT RIC, policy type or service not found"
689 "allowEmptyValue": false,
690 "name": "policytype_id",
691 "description": "The identity of the policy type to get policies for.",
697 "allowEmptyValue": false,
699 "description": "The identity of the Near-RT RIC to get policies for.",
705 "allowEmptyValue": false,
706 "name": "service_id",
707 "description": "The identity of the service to get policies for.",
712 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
716 "summary": "Returns service information",
718 "produces": ["application/json"],
719 "description": "Either information about a registered service with given identity or all registered services are returned.",
720 "operationId": "getServicesUsingGET_1",
723 "schema": {"$ref": "#/definitions/service_list_v2"},
726 "401": {"description": "Unauthorized"},
727 "403": {"description": "Forbidden"},
729 "schema": {"$ref": "#/definitions/error_information"},
730 "description": "Service is not found"
735 "allowEmptyValue": false,
736 "name": "service_id",
737 "description": "The identity of the service",
741 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
744 "summary": "Register a service",
747 "description": "Registering a service is needed to:<ul><li>Get callbacks.<\/li><li>Activate supervision of the service. If a service is inactive, its policies will be deleted.<\/li><\/ul>",
748 "operationId": "putServiceUsingPUT_1",
751 "schema": {"type": "object"},
752 "description": "Service updated"
755 "schema": {"type": "object"},
756 "description": "Service created"
759 "schema": {"$ref": "#/definitions/error_information"},
760 "description": "The ServiceRegistrationInfo is not accepted"
762 "401": {"description": "Unauthorized"},
763 "403": {"description": "Forbidden"},
764 "404": {"description": "Not Found"}
767 "schema": {"$ref": "#/definitions/service_registration_info_v2"},
769 "name": "registrationInfo",
770 "description": "registrationInfo",
773 "tags": ["A1 Policy Management Version 2.0 (in progress)"],
774 "consumes": ["application/json"]
778 "summary": "Returns the name of a RIC managing one Mananged Element",
781 "operationId": "getRicUsingGET_1",
784 "schema": {"type": "string"},
785 "description": "Near-RT RIC is found"
787 "401": {"description": "Unauthorized"},
788 "403": {"description": "Forbidden"},
790 "schema": {"type": "string"},
791 "description": "Near-RT RIC is not found"
796 "allowEmptyValue": false,
797 "name": "managedElementId",
798 "description": "The identity of the Managed Element",
802 "tags": ["A1 Policy Management Version 1.0"]
804 "/services/keepalive": {"put": {
805 "summary": "Heartbeat from a service",
808 "operationId": "keepAliveServiceUsingPUT",
811 "schema": {"type": "string"},
812 "description": "Service supervision timer refreshed, OK"
814 "201": {"description": "Created"},
815 "401": {"description": "Unauthorized"},
816 "403": {"description": "Forbidden"},
817 "404": {"description": "The service is not found, needs re-registration"}
821 "allowEmptyValue": false,
823 "description": "The name of the service",
827 "tags": ["A1 Policy Management Version 1.0"],
828 "consumes": ["application/json"]
830 "/v2/services/{service_id}/keepalive": {"put": {
831 "summary": "Heartbeat indicates that the service is running",
834 "operationId": "keepAliveServiceUsingPUT_1",
837 "schema": {"type": "object"},
838 "description": "Service supervision timer refreshed, OK"
840 "201": {"description": "Created"},
841 "401": {"description": "Unauthorized"},
842 "403": {"description": "Forbidden"},
844 "schema": {"$ref": "#/definitions/error_information"},
845 "description": "The service is not found, needs re-registration"
850 "name": "service_id",
851 "description": "service_id",
855 "tags": ["A1 Policy Management Version 2.0 (in progress)"],
856 "consumes": ["application/json"]
859 "summary": "Returns status and statistics of this service",
862 "operationId": "getStatusUsingGET",
865 "schema": {"type": "string"},
866 "description": "Service is living"
868 "401": {"description": "Unauthorized"},
869 "403": {"description": "Forbidden"},
870 "404": {"description": "Not Found"}
872 "tags": ["A1 Policy Management Version 1.0"]
874 "/v2/rics/ric": {"get": {
875 "summary": "Returns info for one Near-RT RIC",
877 "produces": ["application/json"],
878 "description": "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).",
879 "operationId": "getRicUsingGET",
882 "schema": {"$ref": "#/definitions/ric_info_v2"},
883 "description": "Near-RT RIC is found"
885 "401": {"description": "Unauthorized"},
886 "403": {"description": "Forbidden"},
888 "schema": {"$ref": "#/definitions/error_information"},
889 "description": "Near-RT RIC is not found"
895 "allowEmptyValue": false,
896 "name": "managed_element_id",
897 "description": "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",
903 "allowEmptyValue": false,
905 "description": "The identity of a Near-RT RIC to get information for.",
910 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
912 "/r-app/pms-callback": {"post": {
913 "summary": "Callback for Near-RT RIC status",
915 "produces": ["application/json"],
916 "description": "The URL to this call is registerred at Service registration.",
917 "operationId": "jobStatusCallbackUsingPOST",
919 "200": {"description": "OK"},
920 "201": {"description": "Created"},
921 "401": {"description": "Unauthorized"},
922 "403": {"description": "Forbidden"},
923 "404": {"description": "Not Found"}
926 "schema": {"$ref": "#/definitions/service_callback_info_v2"},
929 "description": "body",
932 "tags": ["R-App Callbacks"],
933 "consumes": ["application/json"]
935 "/v2/policy-types/{policytype_id}": {"get": {
936 "summary": "Returns a policy type definition",
938 "produces": ["application/json"],
939 "operationId": "getPolicyTypeUsingGET",
942 "schema": {"$ref": "#/definitions/policytype_v2"},
943 "description": "Policy type"
945 "401": {"description": "Unauthorized"},
946 "403": {"description": "Forbidden"},
948 "schema": {"$ref": "#/definitions/error_information"},
949 "description": "Policy type is not found"
954 "name": "policytype_id",
955 "description": "policytype_id",
959 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
961 "/service": {"put": {
962 "summary": "Register a service",
965 "operationId": "putServiceUsingPUT",
968 "schema": {"type": "string"},
969 "description": "Service updated"
972 "schema": {"type": "string"},
973 "description": "Service created"
976 "schema": {"type": "string"},
977 "description": "The ServiceRegistrationInfo is not accepted"
979 "401": {"description": "Unauthorized"},
980 "403": {"description": "Forbidden"},
981 "404": {"description": "Not Found"}
984 "schema": {"$ref": "#/definitions/service_registration_info_v1"},
986 "name": "registrationInfo",
987 "description": "registrationInfo",
990 "tags": ["A1 Policy Management Version 1.0"],
991 "consumes": ["application/json"]
995 "summary": "Query policy identities",
997 "produces": ["application/json"],
998 "description": "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",
999 "operationId": "getPolicyIdsUsingGET",
1002 "schema": {"$ref": "#/definitions/policy_id_list_v2"},
1003 "description": "Policy identities"
1005 "401": {"description": "Unauthorized"},
1006 "403": {"description": "Forbidden"},
1008 "schema": {"$ref": "#/definitions/error_information"},
1009 "description": "Near-RT RIC or type not found"
1015 "allowEmptyValue": false,
1016 "name": "policytype_id",
1017 "description": "The identity of the policy type to get policies for.",
1023 "allowEmptyValue": false,
1025 "description": "The identity of the Near-RT RIC to get policies for.",
1031 "allowEmptyValue": false,
1032 "name": "service_id",
1033 "description": "The identity of the service to get policies for.",
1038 "tags": ["A1 Policy Management Version 2.0 (in progress)"]
1041 "summary": "Create or update a policy",
1042 "deprecated": false,
1043 "produces": ["application/json"],
1044 "operationId": "putPolicyUsingPUT",
1046 "200": {"description": "Policy updated"},
1047 "201": {"description": "Policy created"},
1048 "401": {"description": "Unauthorized"},
1050 "schema": {"$ref": "#/definitions/error_information"},
1051 "description": "Near-RT RIC is not operational"
1053 "403": {"description": "Forbidden"},
1055 "schema": {"$ref": "#/definitions/error_information"},
1056 "description": "Near-RT RIC or policy type is not found"
1060 "schema": {"$ref": "#/definitions/policy_info_v2"},
1062 "name": "policyInfo",
1063 "description": "policyInfo",
1066 "tags": ["A1 Policy Management Version 2.0 (in progress)"],
1067 "consumes": ["application/json"]
1071 "host": "localhost:46233",
1073 "error_information": {
1074 "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
1076 "title": "error_information",
1079 "description": " A human-readable explanation specific to this occurrence of the problem.",
1081 "example": "Policy type not found"
1085 "description": "The HTTP status code generated by the origin server for this occurrence of the problem. ",
1092 "description": "Void/empty",
1098 "title": "status_info_v2",
1099 "properties": {"status": {
1100 "description": "status text",
1106 "title": "policy_info_v1",
1109 "description": "the name of the service owning the policy",
1113 "description": "the configuration of the policy",
1117 "description": "identity of the policy",
1121 "description": "timestamp, last modification time",
1125 "description": "name of the policy type",
1129 "description": "identity of the target Near-RT RIC",
1134 "Mono«ResponseEntity«object»»": {
1136 "title": "Mono«ResponseEntity«object»»"
1139 "description": "Information for a Near-RT RIC",
1141 "title": "ric_info_v2",
1144 "description": "identity of the Near-RT RIC",
1147 "managed_element_ids": {
1148 "description": "O1 identities for managed entities",
1150 "items": {"type": "string"}
1153 "description": "State for the Near-RT RIC, values: \nUNAVAILABLE: The Near-RT RIC is not avialable, information may be inconsistent \nAVAILABLE: The normal state. Policies can be configured. +\nSYNCHRONIZING: The Policy Management Service is synchronizing the view of the Near-RT RIC. Policies cannot be configured. \nCONSISTENCY_CHECK: A consistency check between the Policy Management Service and the Near-RT RIC. Policies cannot be configured.",
1163 "description": "supported policy types",
1165 "items": {"type": "string"}
1169 "service_registration_info_v1": {
1171 "title": "service_registration_info_v1",
1173 "keepAliveIntervalSeconds": {
1175 "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.",
1179 "description": "callback for notifying of RIC synchronization",
1182 "serviceName": {"type": "string"}
1185 "policy_info_list_v2": {
1186 "description": "List of policy information",
1188 "title": "policy_info_list_v2",
1189 "properties": {"policies": {
1190 "description": "List of policy information",
1192 "items": {"$ref": "#/definitions/policy_info_v2"}
1195 "service_registration_info_v2": {
1196 "description": "Information for one service",
1198 "title": "service_registration_info_v2",
1199 "required": ["service_id"],
1202 "description": "callback for notifying of Near-RT RIC state changes",
1206 "description": "identity of the service",
1209 "keep_alive_interval_seconds": {
1211 "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.",
1218 "title": "ric_info_v1",
1220 "managedElementIds": {
1221 "description": "O1 identities for managed entities",
1223 "items": {"type": "string"}
1226 "description": "supported policy types",
1228 "items": {"type": "string"}
1231 "description": "state info",
1235 "description": "identity of the Near-RT RIC",
1240 "policy_status_info_v2": {
1241 "description": "Status for one A1-P Policy",
1243 "title": "policy_status_info_v2",
1246 "description": "timestamp, last modification time",
1250 "description": "the Policy status",
1255 "service_status_v1": {
1257 "title": "service_status_v1",
1259 "keepAliveIntervalSeconds": {
1261 "description": "policy keep alive timeout",
1265 "description": "callback for notifying of RIC synchronization",
1268 "timeSinceLastActivitySeconds": {
1270 "description": "time since last invocation by the service",
1274 "description": "identity of the service",
1279 "service_status_v2": {
1281 "title": "service_status_v2",
1284 "description": "callback for notifying of RIC synchronization",
1288 "description": "identity of the service",
1291 "keep_alive_interval_seconds": {
1293 "description": "policy keep alive timeout",
1296 "time_since_last_activity_seconds": {
1298 "description": "time since last invocation by the service",
1304 "description": "Policy type",
1306 "title": "policytype_v2",
1307 "properties": {"policy_schema": {
1308 "description": "Policy type json scema. The schema is a json object following http://json-schema.org/draft-07/schema",
1312 "ric_info_list_v2": {
1313 "description": "List of Near-RT RIC information",
1315 "title": "ric_info_list_v2",
1316 "properties": {"rics": {
1317 "description": "List of Near-RT RIC information",
1319 "items": {"$ref": "#/definitions/ric_info_v2"}
1322 "policytype_id_list_v2": {
1323 "description": "Information about policy types",
1325 "title": "policytype_id_list_v2",
1326 "properties": {"policytype_ids": {
1327 "description": "Policy type identities",
1329 "items": {"type": "string"}
1332 "policy_id_list_v2": {
1333 "description": "A list of policy identities",
1335 "title": "policy_id_list_v2",
1336 "properties": {"policy_ids": {
1337 "description": "Policy identities",
1339 "items": {"type": "string"}
1343 "description": "Information for one A1-P Policy",
1345 "title": "policy_info_v2",
1355 "description": "identity of the target Near-RT RIC",
1359 "description": "identity of the policy",
1363 "description": "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",
1367 "description": "the name of the service owning the policy",
1371 "description": "the configuration of the policy",
1374 "status_notification_uri": {
1375 "description": "Callback URI for policy status updates",
1379 "description": "identity of the policy type",
1384 "service_list_v2": {
1385 "description": "List of service information",
1387 "title": "service_list_v2",
1388 "properties": {"service_list": {
1389 "description": "List of service information",
1391 "items": {"$ref": "#/definitions/service_status_v2"}
1394 "service_callback_info_v2": {
1395 "description": "Information transferred as in Service callbacks (callback_url)",
1397 "title": "service_callback_info_v2",
1404 "description": "identity of a Near-RT RIC",
1408 "description": "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",
1410 "enum": ["AVAILABLE"]
1414 "Mono«ResponseEntity«string»»": {
1416 "title": "Mono«ResponseEntity«string»»"
1421 "x-audience": "external-partner",
1422 "x-api-id": "60f9a0e7-343f-43bf-9194-d8d65688d465",
1424 "name": "Ericsson Software Technology",
1425 "email": "nonrtric@est.tech"
1427 "description": "The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. \nIt provides support for:<ul><li>A1 Policy creation and modification.<\/li><li>Maintaining a view of supported Near-RT RIC policy types <\/li><li>Supervision of using services (R-APPs). When a service is unavailble, its policies are removed. <\/li> <li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs <\/li><\/ul>",
1428 "title": "A1 Policy management service",
1433 "name": "A1 Policy Management Version 1.0",
1434 "description": "Policy Controller"
1437 "name": "A1 Policy Management Version 2.0 (in progress)",
1438 "description": "Policy Controller"
1441 "name": "Component Configuration",
1442 "description": "Configuration Controller"
1445 "name": "R-App Callbacks",
1446 "description": "Rapp Simulator Controller"