3 title: Data management and exposure
4 description: <h1>API documentation</h1><h2>General</h2><p> The service is mainly
5 a broker between data producers and data consumers. A data producer has the ability
6 to produce one or several types of data (Information Type). One type of data can
7 be produced by zero to many producers. <br /><br />A data consumer can have several
8 active data subscriptions (Information Job). One Information Job consists of the
9 type of data to produce and additional parameters for filtering of the data. These
10 parameters are different for different data types.</p><h2>APIs provided by the
11 service</h2><h4>A1-EI</h4><p> This API is between Near-RT RIC and the Non-RT
12 RIC. The Near-RT RIC is a data consumer, which creates Information Jobs to subscribe
13 for data. In this context, the information is referred to as 'Enrichment Information',
14 EI.</p><h4>Data producer API</h4><p> This API is provided by the Non-RT RIC platform
15 and is intended to be part of the O-RAN R1 interface. The API is for use by different
16 kinds of data producers and provides support for:<ul><li>Registry of supported
17 information types and which parameters needed to setup a subscription.</li><li>Registry
18 of existing data producers.</li><li>Callback API provided by producers to setup
19 subscriptions.</li></ul></p><h4>Data consumer API</h4><p> This API is provided
20 by the Non-RT RIC platform and is intended to be part of the O-RAN R1 interface. The
21 API is for use by different kinds of data consumers and provides support for:<ul><li>Querying
22 of available types of data to consume.</li><li>Management of data subscription
23 jobs</li><li>Optional callback API provided by consumers to get notification on
24 added and removed information types.</li></ul></p><h4>Service status</h4><p> This
25 API provides a means to monitor the health of this service.</p>
27 name: Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.
28 url: http://www.apache.org/licenses/LICENSE-2.0
33 - name: A1-EI (registration)
34 description: Data consumer EI job registration
35 - name: A1-EI (callbacks)
36 description: Data consumer EI job status callbacks
37 - name: Data consumer (callbacks)
38 description: API for data consumers
39 - name: Data producer (registration)
40 description: API for data producers
41 - name: Data producer (callbacks)
42 description: API implemented by data producers
44 description: API for data consumers
45 - name: Service status
46 description: API for monitoring of the service
48 description: Monitor and interact
50 description: Spring Boot Actuator Web API Documentation
51 url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
53 /data-producer/v1/info-types:
56 - Data producer (registration)
57 summary: Info Type identifiers
58 operationId: getInfoTypdentifiers
61 description: Info Type identifiers
68 /A1-EI/v1/eitypes/{eiTypeId}:
71 - A1-EI (registration)
72 summary: Individual EI type
73 operationId: getEiType
88 $ref: '#/components/schemas/EiTypeObject'
90 description: Enrichment Information type is not found
94 $ref: '#/components/schemas/ProblemDetails'
99 summary: Actuator web endpoint 'threaddump'
100 operationId: threaddump_4
108 /data-producer/v1/info-types/{infoTypeId}:
111 - Data producer (registration)
112 summary: Individual Information Type
113 operationId: getInfoType
124 description: Info Type
128 $ref: '#/components/schemas/producer_info_type_info'
130 description: Information type is not found
134 $ref: '#/components/schemas/ProblemDetails'
137 - Data producer (registration)
138 summary: Individual Information Type
139 operationId: putInfoType
152 $ref: '#/components/schemas/producer_info_type_info'
156 description: Type updated
160 $ref: '#/components/schemas/Void'
162 description: Type created
166 $ref: '#/components/schemas/Void'
168 description: Input validation failed
172 $ref: '#/components/schemas/ProblemDetails'
175 - Data producer (registration)
176 summary: Individual Information Type
177 operationId: deleteInfoType
188 description: Not used
192 $ref: '#/components/schemas/Void'
194 description: Producer deleted
198 $ref: '#/components/schemas/Void'
200 description: Information type is not found
204 $ref: '#/components/schemas/ProblemDetails'
206 description: The Information type has one or several active producers
210 $ref: '#/components/schemas/ProblemDetails'
211 /data-consumer/v1/info-type-subscription/{subscriptionId}:
215 summary: Individual subscription for information types (registration/deregistration)
216 operationId: getIndividualTypeSubscription
218 - name: subscriptionId
227 description: Type subscription
231 $ref: '#/components/schemas/consumer_type_subscription_info'
233 description: Subscription is not found
237 $ref: '#/components/schemas/ProblemDetails'
241 summary: Individual subscription for information types (registration/deregistration)
242 description: This service operation is used to subscribe to notifications for
243 changes in the availability of data types.
244 operationId: putIndividualTypeSubscription
246 - name: subscriptionId
257 $ref: '#/components/schemas/consumer_type_subscription_info'
261 description: Subscription updated
265 $ref: '#/components/schemas/Void'
267 description: Subscription created
271 $ref: '#/components/schemas/Void'
275 summary: Individual subscription for information types (registration/deregistration)
276 operationId: deleteIndividualTypeSubscription
278 - name: subscriptionId
287 description: Not used
291 $ref: '#/components/schemas/Void'
293 description: Subscription deleted
297 $ref: '#/components/schemas/Void'
299 description: Subscription is not found
303 $ref: '#/components/schemas/ProblemDetails'
304 /example-dataproducer/health-check:
307 - Data producer (callbacks)
308 summary: Producer supervision
309 description: The endpoint is provided by the Information Producer and is used
310 for supervision of the producer.
311 operationId: producerSupervision
314 description: The producer is OK
323 summary: Actuator web endpoint 'loggers'
324 operationId: loggers_2
336 summary: Actuator web endpoint 'health-path'
337 operationId: health-path_2
345 /data-consumer/v1/info-types:
349 summary: Information type identifiers
350 operationId: getinfoTypeIdentifiers
353 description: Information type identifiers
360 /example-dataconsumer/info-type-status:
363 - Data consumer (callbacks)
364 summary: Callback for changed Information type registration status
365 description: The primitive is implemented by the data consumer and is invoked
366 when a Information type status has been changed. <br/>Subscription are managed
367 by primitives in 'Data consumer'
368 operationId: typeStatusCallback
373 $ref: '#/components/schemas/consumer_type_registration_info'
381 $ref: '#/components/schemas/Void'
382 /actuator/metrics/{requiredMetricName}:
386 summary: Actuator web endpoint 'metrics-requiredMetricName'
387 operationId: metrics-requiredMetricName_2
389 - name: requiredMetricName
407 summary: Actuator root web endpoint
416 additionalProperties:
418 additionalProperties:
419 $ref: '#/components/schemas/Link'
420 /data-consumer/v1/info-jobs:
424 summary: Information Job identifiers
425 description: query for information job identifiers
426 operationId: getJobIds
430 description: selects subscription jobs of matching information type
438 description: selects result for one owner
446 description: Information information job identifiers
454 description: Information type is not found
458 $ref: '#/components/schemas/ProblemDetails'
459 /actuator/loggers/{name}:
463 summary: Actuator web endpoint 'loggers-name'
464 operationId: loggers-name_4
483 summary: Actuator web endpoint 'loggers-name'
484 operationId: loggers-name_3
500 /example-dataproducer/info-job:
503 - Data producer (callbacks)
504 summary: Callback for Information Job creation/modification
505 description: The call is invoked to activate or to modify a data subscription.
506 The endpoint is provided by the Information Producer.
507 operationId: jobCreatedCallback
512 $ref: '#/components/schemas/producer_info_job_request'
520 $ref: '#/components/schemas/Void'
521 /example-dataproducer/info-job/{infoJobId}:
524 - Data producer (callbacks)
525 summary: Callback for Information Job deletion
526 description: The call is invoked to terminate a data subscription. The endpoint
527 is provided by the Information Producer.
528 operationId: jobDeletedCallback
543 $ref: '#/components/schemas/Void'
544 /A1-EI/v1/eijobs/{eiJobId}/status:
547 - A1-EI (registration)
548 summary: EI job status
549 operationId: getEiJobStatus_1
560 description: EI job status
564 $ref: '#/components/schemas/EiJobStatusObject'
566 description: Enrichment Information job is not found
570 $ref: '#/components/schemas/ProblemDetails'
571 /data-producer/v1/info-producers/{infoProducerId}/status:
574 - Data producer (registration)
575 summary: Information producer status
576 operationId: getInfoProducerStatus
578 - name: infoProducerId
587 description: Information producer status
591 $ref: '#/components/schemas/producer_status'
593 description: Information producer is not found
597 $ref: '#/components/schemas/ProblemDetails'
598 /data-consumer/v1/info-jobs/{infoJobId}/status:
603 operationId: getEiJobStatus
614 description: Information subscription job status
618 $ref: '#/components/schemas/consumer_job_status'
620 description: Information subscription job is not found
624 $ref: '#/components/schemas/ProblemDetails'
629 summary: Actuator web endpoint 'metrics'
630 operationId: metrics_2
638 /example-dataconsumer/info-jobs/{infoJobId}/status:
642 summary: Callback for changed Information Job status
643 description: The primitive is implemented by the data consumer and is invoked
644 when a Information Job status has been changed.
645 operationId: jobStatusCallback
658 $ref: '#/components/schemas/EiJobStatusObject'
666 $ref: '#/components/schemas/Void'
671 summary: Actuator web endpoint 'info'
683 - A1-EI (registration)
684 summary: EI type identifiers
685 operationId: getEiTypeIdentifiers
688 description: EI type identifiers
695 /data-producer/v1/info-producers/{infoProducerId}:
698 - Data producer (registration)
699 summary: Individual Information Producer
700 operationId: getInfoProducer
702 - name: infoProducerId
711 description: Information producer
715 $ref: '#/components/schemas/producer_registration_info'
717 description: Information producer is not found
721 $ref: '#/components/schemas/ProblemDetails'
724 - Data producer (registration)
725 summary: Individual Information Producer
726 operationId: putInfoProducer
728 - name: infoProducerId
739 $ref: '#/components/schemas/producer_registration_info'
743 description: Producer updated
747 $ref: '#/components/schemas/Void'
749 description: Producer created
753 $ref: '#/components/schemas/Void'
755 description: Input validation failed
759 $ref: '#/components/schemas/ProblemDetails'
761 description: Producer type not found
765 $ref: '#/components/schemas/ProblemDetails'
768 - Data producer (registration)
769 summary: Individual Information Producer
770 operationId: deleteInfoProducer
772 - name: infoProducerId
781 description: Not used
785 $ref: '#/components/schemas/Void'
787 description: Producer deleted
791 $ref: '#/components/schemas/Void'
793 description: Producer is not found
797 $ref: '#/components/schemas/ProblemDetails'
802 summary: Returns status and statistics of this service
803 operationId: getStatus
806 description: Service is living
810 $ref: '#/components/schemas/service_status_info'
811 /data-consumer/v1/info-type-subscription:
815 summary: Information type subscription identifiers
816 description: query for information type subscription identifiers
817 operationId: getInfoTypeSubscriptions
821 description: selects result for one owner
829 description: Information type subscription identifiers
836 /A1-EI/v1/eijobs/{eiJobId}:
839 - A1-EI (registration)
840 summary: Individual EI job
841 operationId: getIndividualEiJob_1
856 $ref: '#/components/schemas/EiJobObject'
858 description: Enrichment Information job is not found
862 $ref: '#/components/schemas/ProblemDetails'
865 - A1-EI (registration)
866 summary: Individual EI job
867 operationId: putIndividualEiJob
880 $ref: '#/components/schemas/EiJobObject'
884 description: Job updated
888 $ref: '#/components/schemas/Void'
890 description: Job created
894 $ref: '#/components/schemas/Void'
896 description: Input validation failed
900 $ref: '#/components/schemas/ProblemDetails'
902 description: Enrichment Information type is not found
906 $ref: '#/components/schemas/ProblemDetails'
908 description: Cannot modify job type
912 $ref: '#/components/schemas/ProblemDetails'
915 - A1-EI (registration)
916 summary: Individual EI job
917 operationId: deleteIndividualEiJob_1
928 description: Not used
932 $ref: '#/components/schemas/Void'
934 description: Job deleted
938 $ref: '#/components/schemas/Void'
940 description: Enrichment Information job is not found
944 $ref: '#/components/schemas/ProblemDetails'
949 summary: Actuator web endpoint 'logfile'
950 operationId: logfile_2
958 /data-consumer/v1/info-jobs/{infoJobId}:
962 summary: Individual data subscription job
963 operationId: getIndividualEiJob
974 description: Information subscription job
978 $ref: '#/components/schemas/consumer_job'
980 description: Information subscription job is not found
984 $ref: '#/components/schemas/ProblemDetails'
988 summary: Individual data subscription job
989 description: The job will be enabled when a producer is available
990 operationId: putIndividualInfoJob
1001 description: when true, a validation of that the type exists and that the
1002 job matches the type schema.
1013 $ref: '#/components/schemas/consumer_job'
1017 description: Job updated
1021 $ref: '#/components/schemas/Void'
1023 description: Job created
1027 $ref: '#/components/schemas/Void'
1029 description: Input validation failed
1033 $ref: '#/components/schemas/ProblemDetails'
1035 description: Information type is not found
1039 $ref: '#/components/schemas/ProblemDetails'
1041 description: Cannot modify job type
1045 $ref: '#/components/schemas/ProblemDetails'
1049 summary: Individual data subscription job
1050 operationId: deleteIndividualEiJob
1061 description: Not used
1065 $ref: '#/components/schemas/Void'
1067 description: Job deleted
1071 $ref: '#/components/schemas/Void'
1073 description: Information subscription job is not found
1077 $ref: '#/components/schemas/ProblemDetails'
1078 /data-producer/v1/info-producers:
1081 - Data producer (registration)
1082 summary: Information producer identifiers
1083 operationId: getInfoProducerIdentifiers
1087 description: If given, only the producers for the EI Data type is returned.
1095 description: Information producer identifiers
1102 /data-consumer/v1/info-types/{infoTypeId}:
1106 summary: Individual information type
1107 operationId: getInfoType_1
1118 description: Information type
1122 $ref: '#/components/schemas/consumer_information_type'
1124 description: Information type is not found
1128 $ref: '#/components/schemas/ProblemDetails'
1133 summary: Actuator web endpoint 'health'
1134 operationId: health_2
1145 - A1-EI (registration)
1146 summary: EI job identifiers
1147 description: query for EI job identifiers
1148 operationId: getEiJobIds
1152 description: selects EI jobs of matching EI type
1160 description: selects EI jobs for one EI job owner
1168 description: EI job identifiers
1176 description: Enrichment Information type is not found
1180 $ref: '#/components/schemas/ProblemDetails'
1181 /data-producer/v1/info-producers/{infoProducerId}/info-jobs:
1184 - Data producer (registration)
1185 summary: Information Job definitions
1186 description: Information Job definitions for one Information Producer
1187 operationId: getInfoProducerJobs
1189 - name: infoProducerId
1198 description: Information producer
1204 $ref: '#/components/schemas/producer_info_job_request'
1206 description: Information producer is not found
1210 $ref: '#/components/schemas/ProblemDetails'
1215 summary: Actuator web endpoint 'heapdump'
1216 operationId: heapdump_2
1226 consumer_information_type:
1235 description: The number of registered producers for the type
1239 description: 'Allowed values: <br/>ENABLED: one or several producers for
1240 the information type are available <br/>DISABLED: no producers for the
1241 information type are available'
1247 description: Json schema for the job data
1248 description: Information for an Information type
1251 description: Information for an EI type
1252 service_status_info:
1262 description: Number of Information Producers
1266 description: Number of Information Types
1270 description: Number of Information Jobs
1274 description: status text
1275 producer_registration_info:
1277 - info_job_callback_url
1278 - info_producer_supervision_callback_url
1279 - supported_info_types
1282 info_producer_supervision_callback_url:
1284 description: callback for producer supervision
1285 supported_info_types:
1287 description: Supported Information Type IDs
1290 description: Supported Information Type IDs
1291 info_job_callback_url:
1293 description: callback for Information Job
1294 description: Information for an Information Producer
1295 consumer_type_registration_info:
1304 description: Information type identifier
1307 description: Json schema for the job data
1310 description: 'Allowed values: <br/>REGISTERED: the information type has
1311 been registered <br/>DEREGISTERED: the information type has been removed'
1315 description: Information for an Information type
1321 description: A human-readable explanation specific to this occurrence of
1323 example: Information Job type not found
1326 description: The HTTP status code generated by the origin server for this
1327 occurrence of the problem.
1330 description: A problem detail to carry details in a HTTP response according
1339 description: 'Allowed values for EI job status: <br/>ENABLED: the A1-EI
1340 producer is able to deliver EI result for the EI job <br/>DISABLED: the
1341 A1-EI producer is unable to deliver EI result for the EI job'
1345 description: Status for an EI job
1346 consumer_job_status:
1354 description: 'Allowed values: <br/>ENABLED: the A1-Information producer
1355 is able to deliver result for the Information Job <br/>DISABLED: the A1-Information
1356 producer is unable to deliver result for the Information Job'
1362 description: An array of all registered Information Producer Identifiers.
1365 description: An array of all registered Information Producer Identifiers.
1366 description: Status for an Information Job
1377 description: EI type Idenitifier of the EI job
1380 description: The target URI of the EI data
1383 description: Identity of the owner of the job
1384 statusNotificationUri:
1386 description: The target of EI job status notifications
1389 description: EI type specific job data
1390 description: Information for an Enrichment Information Job
1391 producer_info_type_info:
1393 - info_job_data_schema
1396 info_type_information:
1398 description: Type specific information for the information type
1399 info_job_data_schema:
1401 description: Json schema for the job data
1402 description: Information for an Information Type
1403 producer_info_job_request:
1410 description: The owner of the job
1413 description: The time when the job was last updated or created (ISO-8601)
1416 description: Identity of the Information Job
1419 description: URI for the target of the produced Information
1422 description: Json for the job data
1425 description: Type identity for the job
1426 description: The body of the Information Producer callbacks for Information
1427 Job creation and deletion
1438 description: Information type Idenitifier of the subscription job
1441 description: The target URI of the subscribed information
1444 description: Identity of the owner of the job
1447 description: Information type specific job data
1448 status_notification_uri:
1450 description: The target of Information subscription job status notifications
1451 description: Information for an Information Job
1459 description: Represents the operational states
1463 description: Status for an Info Producer
1466 description: 'Void/empty '
1474 consumer_type_subscription_info:
1482 description: Identity of the owner of the subscription
1485 description: The target URI of the subscribed information
1486 description: Information for an information type subscription