4 "title" : "A1 Policy Management Service",
5 "description" : "<h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.</p><h3>Authorization API</h3><p>API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.</p><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>",
7 "url" : "https://www.onap.org/",
8 "email" : "discuss-list@onap.com"
11 "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.",
12 "url" : "http://www.apache.org/licenses/LICENSE-2.0"
15 "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8",
16 "x-audience" : "external-public"
22 "name" : "A1 Policy Management",
23 "description" : "API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances."
25 "name" : "NearRT-RIC Repository",
26 "description" : "API used to get the NearRT-RIC for the managed element."
28 "name" : "Service Registry and Supervision",
29 "description" : "API used to keep the service Alive with in the timeout period"
31 "name" : "Health Check",
32 "description" : "API used to get the health status and statistics of this service"
34 "name" : "Service callbacks"
36 "name" : "Authorization API",
37 "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA). <br> Note that this API is called by PMS, it is not provided."
39 "name" : "Configuration",
40 "description" : "API used to create or fetch the application configuration."
43 "description" : "Monitor and interact",
45 "description" : "Spring Boot Actuator Web API Documentation",
46 "url" : "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"
50 "/a1-policy/v2/policy-instances" : {
52 "tags" : [ "A1 Policy Management" ],
53 "summary" : "Query for A1 policy instances",
54 "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.",
55 "operationId" : "getPolicyInstances",
57 "name" : "policytype_id",
59 "description" : "Select policies with a given type identity.",
69 "description" : "Select policies for a given Near-RT RIC identity.",
77 "name" : "service_id",
79 "description" : "Select policies owned by a given service.",
89 "description" : "Select policies of a given type name (type identity has the format <typename_version>)",
99 "description" : "OK - Returns A1 Policies which matches the criteria",
101 "application/json" : {
103 "$ref" : "#/components/schemas/policy_info_list"
106 "policy_info_list" : {
107 "$ref" : "#/components/examples/policy_info_list"
114 "description" : "Not Found - Near-RT RIC, policy type or service not found",
116 "application/json" : {
118 "$ref" : "#/components/schemas/error_information"
126 "/example-authz-check" : {
128 "tags" : [ "Authorization API" ],
129 "summary" : "Request for access authorization.",
130 "description" : "The authorization function decides if access is granted.",
131 "operationId" : "performAccessControl",
134 "application/json" : {
136 "$ref" : "#/components/schemas/policy_authorization"
144 "description" : "OK",
146 "application/json" : {
148 "$ref" : "#/components/schemas/authorization_result"
154 "description" : "Forbidden",
156 "application/problem+json" : {
158 "$ref" : "#/components/schemas/error_information"
162 "title" : "Forbidden",
163 "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights."
171 "/actuator/threaddump" : {
173 "tags" : [ "Actuator" ],
174 "summary" : "Actuator web endpoint 'threaddump'",
175 "operationId" : "threaddump",
178 "description" : "OK",
180 "text/plain;charset=UTF-8" : {
185 "application/vnd.spring-boot.actuator.v3+json" : {
190 "application/json" : {
195 "application/vnd.spring-boot.actuator.v2+json" : {
206 "/a1-policy/v2/status" : {
208 "tags" : [ "Health Check" ],
209 "description" : "Returns status and statistics of this service",
210 "operationId" : "getStatus",
213 "description" : "OK- Service is living Ok",
215 "application/json" : {
217 "$ref" : "#/components/schemas/status_info"
221 "$ref" : "#/components/examples/status_info"
230 "/actuator/loggers" : {
232 "tags" : [ "Actuator" ],
233 "summary" : "Actuator web endpoint 'loggers'",
234 "operationId" : "loggers",
237 "description" : "OK",
239 "application/vnd.spring-boot.actuator.v3+json" : {
244 "application/json" : {
249 "application/vnd.spring-boot.actuator.v2+json" : {
260 "/actuator/health/**" : {
262 "tags" : [ "Actuator" ],
263 "summary" : "Actuator web endpoint 'health-path'",
264 "operationId" : "health-path",
267 "description" : "OK",
269 "application/vnd.spring-boot.actuator.v3+json" : {
274 "application/json" : {
279 "application/vnd.spring-boot.actuator.v2+json" : {
290 "/a1-policy/v2/rics/ric" : {
292 "tags" : [ "NearRT-RIC Repository" ],
293 "summary" : "Returns info of Near-RT RIC queried by the ric-id and managed-element-id",
294 "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).",
295 "operationId" : "getRic",
297 "name" : "managed_element_id",
299 "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",
309 "description" : "The identity of a Near-RT RIC to get information for.",
319 "description" : "OK - Near-RT RIC is found",
321 "application/json" : {
323 "$ref" : "#/components/schemas/ric_info"
327 "$ref" : "#/components/examples/ric_info"
334 "description" : "Not Found",
336 "application/problem+json" : {
344 "/actuator/shutdown" : {
346 "tags" : [ "Actuator" ],
347 "summary" : "Actuator web endpoint 'shutdown'",
348 "operationId" : "shutdown",
351 "description" : "OK",
353 "application/vnd.spring-boot.actuator.v3+json" : {
358 "application/json" : {
363 "application/vnd.spring-boot.actuator.v2+json" : {
374 "/a1-policy/v2/policy-types" : {
376 "tags" : [ "A1 Policy Management" ],
377 "description" : "Query policy type identities",
378 "operationId" : "getPolicyTypes",
382 "description" : "Select types for the given Near-RT RIC identity.",
390 "name" : "type_name",
392 "description" : "Select types with the given type name (type identity has the format <typename_version>)",
400 "name" : "compatible_with_version",
402 "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.",
412 "description" : "OK - Policy Type IDs Found",
414 "application/json" : {
416 "$ref" : "#/components/schemas/policy_type_id_list"
419 "policy_type_id_list" : {
420 "$ref" : "#/components/examples/policy_type_id_list"
427 "description" : "Not Found",
429 "application/problem+json" : {
437 "/a1-policy/v2/policies/{policy_id}" : {
439 "tags" : [ "A1 Policy Management" ],
440 "description" : "Returns a policy",
441 "operationId" : "getPolicy",
443 "name" : "policy_id",
454 "description" : "OK - Policy found",
456 "application/json" : {
458 "$ref" : "#/components/schemas/policy_info"
462 "$ref" : "#/components/examples/policy_info"
469 "description" : "Not Found",
471 "application/problem+json" : {
479 "tags" : [ "A1 Policy Management" ],
480 "summary" : "Delete a policy",
481 "description" : "Deleting the policy using the Policy's Policy ID.",
482 "operationId" : "deletePolicy",
484 "name" : "policy_id",
495 "description" : "OK - Policy deleted",
499 "$ref" : "#/components/schemas/void"
505 "description" : "Locked - HTTP Status code which can be used when the state is Locked",
507 "application/problem+json" : {
509 "$ref" : "#/components/schemas/error_information"
514 "detail" : "Requested resource is in a locked state."
522 "/actuator/metrics/{requiredMetricName}" : {
524 "tags" : [ "Actuator" ],
525 "summary" : "Actuator web endpoint 'metrics-requiredMetricName'",
526 "operationId" : "metrics-requiredMetricName",
528 "name" : "requiredMetricName",
539 "description" : "OK",
541 "application/vnd.spring-boot.actuator.v3+json" : {
546 "application/json" : {
551 "application/vnd.spring-boot.actuator.v2+json" : {
562 "/a1-policy/v2/configuration" : {
564 "tags" : [ "Configuration" ],
565 "description" : "Returns the contents of the application configuration file",
566 "operationId" : "getConfiguration",
569 "description" : "OK - Configuration",
571 "application/json" : {
579 "description" : "Not Found",
581 "application/problem+json" : {
590 "tags" : [ "Configuration" ],
591 "description" : "Replace the current configuration with the given configuration",
592 "operationId" : "putConfiguration",
595 "application/json" : {
605 "description" : "OK - Configuration updated",
609 "$ref" : "#/components/schemas/void"
615 "description" : "Bad Request",
617 "application/problem+json" : {
619 "$ref" : "#/components/schemas/error_information"
623 "title" : "Bad Request",
624 "detail" : "The provided request is not valid."
635 "tags" : [ "Actuator" ],
636 "summary" : "Actuator root web endpoint",
637 "operationId" : "links",
640 "description" : "OK",
642 "application/vnd.spring-boot.actuator.v3+json" : {
645 "additionalProperties" : {
647 "additionalProperties" : {
648 "$ref" : "#/components/schemas/Link"
653 "application/json" : {
656 "additionalProperties" : {
658 "additionalProperties" : {
659 "$ref" : "#/components/schemas/Link"
664 "application/vnd.spring-boot.actuator.v2+json" : {
667 "additionalProperties" : {
669 "additionalProperties" : {
670 "$ref" : "#/components/schemas/Link"
681 "/actuator/loggers/{name}" : {
683 "tags" : [ "Actuator" ],
684 "summary" : "Actuator web endpoint 'loggers-name'",
685 "operationId" : "loggers-name",
698 "description" : "OK",
700 "application/vnd.spring-boot.actuator.v3+json" : {
705 "application/json" : {
710 "application/vnd.spring-boot.actuator.v2+json" : {
721 "tags" : [ "Actuator" ],
722 "summary" : "Actuator web endpoint 'loggers-name'",
723 "operationId" : "loggers-name_2",
736 "application/json" : {
739 "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]
746 "description" : "OK",
759 "/a1-policy/v2/services/{service_id}/keepalive" : {
761 "tags" : [ "Service Registry and Supervision" ],
762 "summary" : "Heartbeat indicates that the service is running",
763 "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)",
764 "operationId" : "keepAliveService",
766 "name" : "service_id",
777 "description" : "OK - Service supervision timer refreshed, OK",
787 "description" : "Not Found",
789 "application/problem+json" : {
797 "/actuator/metrics" : {
799 "tags" : [ "Actuator" ],
800 "summary" : "Actuator web endpoint 'metrics'",
801 "operationId" : "metrics",
804 "description" : "OK",
806 "application/vnd.spring-boot.actuator.v3+json" : {
811 "application/json" : {
816 "application/vnd.spring-boot.actuator.v2+json" : {
827 "/a1-policy/v2/rics" : {
829 "tags" : [ "NearRT-RIC Repository" ],
830 "summary" : "Query Near-RT RIC information",
831 "description" : "The call returns all Near-RT RICs that supports a given policy type identity",
832 "operationId" : "getRics",
834 "name" : "policytype_id",
836 "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned",
846 "description" : "OK",
848 "application/json" : {
850 "$ref" : "#/components/schemas/ric_info_list"
854 "$ref" : "#/components/examples/ric_info_list"
861 "description" : "Not Found",
863 "application/problem+json" : {
871 "/a1-policy/v2/services" : {
873 "tags" : [ "Service Registry and Supervision" ],
874 "summary" : "Returns service information",
875 "description" : "Either information about a registered service with given identity or all registered services are returned.",
876 "operationId" : "getServices",
878 "name" : "service_id",
880 "description" : "The identity of the service",
890 "description" : "OK",
892 "application/json" : {
894 "$ref" : "#/components/schemas/service_status_list"
897 "service_status_list" : {
898 "$ref" : "#/components/examples/service_status_list"
905 "description" : "Not Found",
907 "application/problem+json" : {
915 "tags" : [ "Service Registry and Supervision" ],
916 "summary" : "Register a service",
917 "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.",
918 "operationId" : "putService",
921 "application/json" : {
923 "$ref" : "#/components/schemas/service_registration_info"
931 "description" : "OK - Service updated",
941 "description" : "Created - Service created",
951 "description" : "Bad Request",
953 "application/problem+json" : {
955 "$ref" : "#/components/schemas/error_information"
959 "title" : "Bad Request",
960 "detail" : "The provided request is not valid."
968 "{$request.body#/callback_url}" : {
970 "tags" : [ "Service callbacks" ],
971 "summary" : "Callback for Near-RT RIC status",
972 "description" : "The URL to this call is registered at Service registration.",
973 "operationId" : "serviceCallback",
976 "application/json" : {
978 "$ref" : "#/components/schemas/service_callback_info_v2"
986 "description" : "OK",
988 "application/json" : {
990 "$ref" : "#/components/schemas/void"
996 "description" : "Not Found",
998 "application/problem+json" : {
1010 "/actuator/info" : {
1012 "tags" : [ "Actuator" ],
1013 "summary" : "Actuator web endpoint 'info'",
1014 "operationId" : "info",
1017 "description" : "OK",
1019 "application/vnd.spring-boot.actuator.v3+json" : {
1024 "application/json" : {
1029 "application/vnd.spring-boot.actuator.v2+json" : {
1042 "tags" : [ "Health Check" ],
1043 "description" : "Returns status and statistics of this service",
1044 "operationId" : "getStatusV1",
1047 "description" : "OK - Service is living",
1059 "/a1-policy/v2/policy-types/{policytype_id}" : {
1061 "tags" : [ "A1 Policy Management" ],
1062 "description" : "Returns a policy type definition",
1063 "operationId" : "getPolicyTypeDefinition",
1065 "name" : "policytype_id",
1076 "description" : "OK - schema of the given policy type",
1078 "application/json" : {
1080 "$ref" : "#/components/schemas/policy_type_definition"
1083 "policy_type_definition" : {
1084 "$ref" : "#/components/examples/policy_type_definition"
1091 "description" : "Not Found",
1093 "application/problem+json" : {
1101 "/actuator/logfile" : {
1103 "tags" : [ "Actuator" ],
1104 "summary" : "Actuator web endpoint 'logfile'",
1105 "operationId" : "logfile",
1108 "description" : "OK",
1110 "text/plain;charset=UTF-8" : {
1121 "/actuator/health" : {
1123 "tags" : [ "Actuator" ],
1124 "summary" : "Actuator web endpoint 'health'",
1125 "operationId" : "health",
1128 "description" : "OK",
1130 "application/vnd.spring-boot.actuator.v3+json" : {
1135 "application/json" : {
1140 "application/vnd.spring-boot.actuator.v2+json" : {
1151 "/a1-policy/v2/policies" : {
1153 "tags" : [ "A1 Policy Management" ],
1154 "summary" : "Query policy identities",
1155 "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.",
1156 "operationId" : "getPolicyIds",
1158 "name" : "policytype_id",
1160 "description" : "Select policies of a given policy type identity.",
1170 "description" : "Select policies of a given Near-RT RIC identity.",
1178 "name" : "service_id",
1180 "description" : "Select policies owned by a given service.",
1188 "name" : "type_name",
1190 "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)",
1200 "description" : "OK - Policy identities",
1202 "application/json" : {
1204 "$ref" : "#/components/schemas/policy_id_list"
1207 "policy_id_list" : {
1208 "$ref" : "#/components/examples/policy_id_list"
1215 "description" : "Not Found",
1217 "application/problem+json" : {
1225 "tags" : [ "A1 Policy Management" ],
1226 "description" : "Create or update a policy",
1227 "operationId" : "putPolicy",
1230 "application/json" : {
1232 "$ref" : "#/components/schemas/policy_info"
1240 "description" : "OK - Policy updated",
1242 "application/json" : {
1244 "$ref" : "#/components/schemas/void"
1250 "description" : "Created - Policy created",
1252 "application/json" : {
1254 "$ref" : "#/components/schemas/void"
1260 "description" : "Locked - HTTP Status code which can be used when the state is Locked",
1262 "application/problem+json" : {
1264 "$ref" : "#/components/schemas/error_information"
1269 "detail" : "Requested resource is in a locked state."
1277 "/a1-policy/v2/services/{service_id}" : {
1279 "tags" : [ "Service Registry and Supervision" ],
1280 "description" : "Unregister a service",
1281 "operationId" : "deleteService",
1283 "name" : "service_id",
1294 "description" : "No Content - Service unregistered",
1304 "description" : "Not Found",
1306 "application/problem+json" : {
1314 "/actuator/heapdump" : {
1316 "tags" : [ "Actuator" ],
1317 "summary" : "Actuator web endpoint 'heapdump'",
1318 "operationId" : "heapdump",
1321 "description" : "OK",
1323 "application/octet-stream" : {
1334 "/a1-policy/v2/policies/{policy_id}/status" : {
1336 "tags" : [ "A1 Policy Management" ],
1337 "description" : "Returns a policy status",
1338 "operationId" : "getPolicyStatus",
1340 "name" : "policy_id",
1351 "description" : "OK - Policy status",
1353 "application/json" : {
1355 "$ref" : "#/components/schemas/policy_status_info"
1358 "policy_status_info" : {
1359 "$ref" : "#/components/examples/policy_status_info"
1366 "description" : "Not Found",
1368 "application/problem+json" : {
1379 "policy_type_definition" : {
1384 "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema"
1387 "description" : "Contains policy type schema definition"
1389 "error_information" : {
1394 "description" : " A human-readable explanation specific to this occurrence of the problem.",
1395 "example" : "Policy type not found"
1399 "description" : "A specific error name",
1400 "example" : "Not Found"
1404 "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ",
1409 "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807"
1413 "description" : "Void/empty"
1420 "description" : "status text"
1424 "authorization_result" : {
1425 "required" : [ "result" ],
1430 "description" : "If true, the access is granted"
1433 "description" : "Result of authorization",
1443 "description" : "identity of the Near-RT RIC"
1445 "managed_element_ids" : {
1447 "description" : "O1 identities for managed entities",
1450 "description" : "O1 identities for managed entities"
1455 "description" : "Represents the states for a Near-RT RIC",
1456 "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ]
1458 "policytype_ids" : {
1460 "description" : "supported policy types",
1463 "description" : "supported policy types"
1467 "description" : "Information for a Near-RT RIC"
1469 "service_registration_info" : {
1470 "required" : [ "service_id" ],
1475 "description" : "callback for notifying of Near-RT RIC state changes"
1479 "description" : "identity of the service"
1481 "keep_alive_interval_seconds" : {
1483 "description" : "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.",
1487 "description" : "Information for one service"
1489 "policy_info_list" : {
1494 "description" : "List of policy information",
1496 "$ref" : "#/components/schemas/policy_info"
1500 "description" : "List of policy information"
1502 "policy_status_info" : {
1507 "description" : "timestamp, last modification time"
1511 "description" : "the Policy status"
1514 "description" : "Status for one A1-P Policy"
1516 "service_status" : {
1521 "description" : "callback for notifying of RIC synchronization"
1525 "description" : "identity of the service"
1527 "keep_alive_interval_seconds" : {
1529 "description" : "policy keep alive timeout",
1532 "time_since_last_activity_seconds" : {
1534 "description" : "time since last invocation by the service",
1544 "description" : "List of Near-RT RIC information",
1546 "$ref" : "#/components/schemas/ric_info"
1550 "description" : "List of Near-RT RIC information"
1553 "required" : [ "access_type", "auth_token", "policy_type_id" ],
1558 "description" : "Access type",
1559 "enum" : [ "READ", "WRITE", "DELETE" ]
1563 "description" : "Authorization token"
1565 "policy_type_id" : {
1567 "description" : "Policy type identifier"
1570 "description" : "input"
1572 "policy_authorization" : {
1573 "required" : [ "input" ],
1577 "$ref" : "#/components/schemas/input"
1580 "description" : "Authorization request for A1 policy requests"
1582 "policy_type_id_list" : {
1585 "policytype_ids" : {
1587 "description" : "Policy type identities",
1590 "description" : "Policy type identities"
1594 "description" : "Information about policy types"
1597 "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id", "service_id" ],
1602 "description" : "identity of the target Near-RT RIC"
1606 "description" : "identity of the policy"
1610 "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",
1617 "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered."
1621 "description" : "the configuration of the policy"
1623 "status_notification_uri" : {
1625 "description" : "Callback URI for policy status updates"
1629 "description" : "identity of the policy type"
1632 "description" : "Information for one A1-P Policy"
1634 "policy_id_list" : {
1639 "description" : "Policy identities",
1642 "description" : "Policy identities"
1646 "description" : "A list of policy identities",
1648 "policy_ids" : [ "policy_ids", "policy_ids" ]
1651 "service_status_list" : {
1656 "description" : "List of service information",
1658 "$ref" : "#/components/schemas/service_status"
1663 "service_callback_info_v2" : {
1664 "required" : [ "event_type", "ric_id" ],
1669 "description" : "identity of a Near-RT RIC"
1673 "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",
1674 "enum" : [ "AVAILABLE" ]
1677 "description" : "Information transferred as in Service callbacks (callback_url)"
1693 "description" : "Locked - HTTP Status code which can be used when the state is Locked",
1695 "application/problem+json" : {
1697 "$ref" : "#/components/schemas/error_information"
1702 "detail" : "Requested resource is in a locked state."
1708 "description" : "Bad Request",
1710 "application/problem+json" : {
1712 "$ref" : "#/components/schemas/error_information"
1716 "title" : "Bad Request",
1717 "detail" : "The provided request is not valid."
1723 "description" : "Forbidden",
1725 "application/problem+json" : {
1727 "$ref" : "#/components/schemas/error_information"
1731 "title" : "Forbidden",
1732 "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights."
1738 "description" : "Not Found",
1740 "application/problem+json" : {
1747 "service_status" : {
1748 "description" : "List of service information",
1750 "callback_url" : "callback_url",
1751 "service_id" : "service_id",
1752 "keep_alive_interval_seconds" : 0,
1753 "time_since_last_activity_seconds" : 6
1756 "service_status_list" : {
1757 "description" : "List of service information",
1759 "service_list" : [ {
1760 "callback_url" : "callback_url",
1761 "service_id" : "service_id",
1762 "keep_alive_interval_seconds" : 0,
1763 "time_since_last_activity_seconds" : 6
1765 "callback_url" : "callback_url",
1766 "service_id" : "service_id",
1767 "keep_alive_interval_seconds" : 0,
1768 "time_since_last_activity_seconds" : 6
1772 "policy_type_definition" : {
1773 "description" : "Schema of the given Policy type",
1775 "policy_schema" : "{}"
1778 "policy_type_id_list" : {
1779 "description" : "Array of policy type id's",
1781 "policy_type_id_list" : [ "policytype_id", "policytype_id" ]
1785 "description" : "Policy information of one A1-P policy",
1787 "ric_id" : "ric_id",
1788 "policy_id" : "policy_id",
1789 "transient" : false,
1790 "service_id" : "service_id",
1791 "policy_data" : "{}",
1792 "status_notification_uri" : "status_notification_uri",
1793 "policytype_id" : "policytype_id"
1796 "policy_info_list" : {
1797 "description" : "List of policy information",
1800 "ric_id" : "ric_id",
1801 "policy_id" : "policy_id",
1802 "transient" : false,
1803 "service_id" : "service_id",
1804 "policy_data" : "{}",
1805 "status_notification_uri" : "status_notification_uri",
1806 "policytype_id" : "policytype_id"
1808 "ric_id" : "ric_id",
1809 "policy_id" : "policy_id",
1810 "transient" : false,
1811 "service_id" : "service_id",
1812 "policy_data" : "{}",
1813 "status_notification_uri" : "status_notification_uri",
1814 "policytype_id" : "policytype_id"
1818 "policy_id_list" : {
1819 "description" : "A list of policy identities",
1821 "policy_ids" : [ "some_policy_id", "some_policy_id" ]
1824 "policy_status_info" : {
1825 "description" : "Status for one A1-P Policy",
1827 "last_modified" : "last_modified",
1842 "ric_id" : "ric_id",
1843 "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ],
1844 "state" : "UNAVAILABLE",
1845 "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ]
1851 "ric_id" : "ric_id",
1852 "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ],
1853 "state" : "UNAVAILABLE",
1854 "policytype_ids" : [ "policytype_id", "policytype_id" ]
1856 "ric_id" : "ric_id",
1857 "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ],
1858 "state" : "UNAVAILABLE",
1859 "policytype_ids" : [ "policytype_ids", "policytype_ids" ]