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 (EI type). One type of data can be produced
7 by zero to many producers. <br /><br />A data consumer can have several active
8 data subscriptions (EI job). One EI job consists of the type of data to produce
9 and additional parameters for filtering of the data. These parameters are different
10 for different data types.</p><h2>APIs provided by the service</h2><h4>A1-EI</h4><p> This
11 API is between Near-RT RIC and the Non-RT RIC. The Near-RT RIC is a data consumer,
12 which creates Enrichment Information Jobs to subscribe for data.</p><h4>Data producer
13 API</h4><p> This API is provided by the Non-RT RIC platform and is intended to
14 be part of the O-RAN R1 interface. The API is for use by different kinds of data
15 producers and provides support for:<ul><li>Registry of supported information types
16 and which parameters needed to setup a subscription.</li><li>Registry of existing
17 data producers.</li><li>Callback API provided by producers to setup subscriptions.</li></ul></p><h4>Data
18 consumer API</h4><p> This API is provided by the Non-RT RIC platform and is intended
19 to be part of the O-RAN R1 interface. The API is for use by different kinds of
20 data consumers and provides support for:<ul><li>Querying of available types of
21 data to consume.</li><li>Management of data subscription jobs</li></ul></p><h4>EI
22 Service status</h4><p> This API provides a means to monitor the service.</p>
24 name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.
25 url: http://www.apache.org/licenses/LICENSE-2.0
30 - name: A1-EI (registration)
31 description: Data consumer EI job registration
32 - name: A1-EI (callbacks)
33 description: Data consumer EI job status callbacks
34 - name: Data producer (callbacks)
35 description: API implemented by data producers
36 - name: Data producer (registration)
37 description: API for data producers
38 - name: Service status
39 description: API for monitoring of the service
41 description: API for data consumers
43 /producer_simulator/ei_job:
46 - Data producer (callbacks)
47 summary: Callback for EI job creation/modification
48 description: The call is invoked to activate or to modify a data subscription.
49 The endpoint is provided by the EI producer.
50 operationId: jobCreatedCallback
55 $ref: '#/components/schemas/producer_ei_job_request'
63 $ref: '#/components/schemas/Void'
64 /A1-EI/v1/eitypes/{eiTypeId}:
67 - A1-EI (registration)
68 summary: Individual EI type
69 operationId: getEiType_1
84 $ref: '#/components/schemas/EiTypeObject'
86 description: Enrichment Information type is not found
90 $ref: '#/components/schemas/ProblemDetails'
91 /ei-producer/v1/eitypes:
94 - Data producer (registration)
95 summary: EI type identifiers
96 operationId: getEiTypeIdentifiers
99 description: EI type identifiers
109 - A1-EI (registration)
110 summary: EI type identifiers
111 operationId: getEiTypeIdentifiers_1
114 description: EI type identifiers
121 /data-consumer/v1/info-types:
125 summary: Information type identifiers
126 operationId: getinfoTypeIdentifiers
129 description: Information type identifiers
136 /ei-producer/v1/eiproducers/{eiProducerId}/status:
139 - Data producer (registration)
140 summary: EI producer status
141 operationId: getEiProducerStatus
152 description: EI producer status
156 $ref: '#/components/schemas/producer_status'
158 description: Enrichment Information producer is not found
162 $ref: '#/components/schemas/ProblemDetails'
163 /producer_simulator/ei_job/{eiJobId}:
166 - Data producer (callbacks)
167 summary: Callback for EI job deletion
168 description: The call is invoked to terminate a data subscription. The endpoint
169 is provided by the EI producer.
170 operationId: jobDeletedCallback
185 $ref: '#/components/schemas/Void'
186 /ei-producer/v1/eitypes/{eiTypeId}:
189 - Data producer (registration)
190 summary: Individual EI type
191 operationId: getEiType
206 $ref: '#/components/schemas/producer_ei_type_info'
208 description: Enrichment Information type is not found
212 $ref: '#/components/schemas/ProblemDetails'
215 - Data producer (registration)
216 summary: Individual EI type
217 operationId: putEiType
230 $ref: '#/components/schemas/producer_ei_type_info'
234 description: Type updated
238 $ref: '#/components/schemas/Void'
240 description: Type created
244 $ref: '#/components/schemas/Void'
246 description: Bad request
250 $ref: '#/components/schemas/ProblemDetails'
253 - Data producer (registration)
254 summary: Individual EI type
255 operationId: deleteEiType
266 description: Not used
270 $ref: '#/components/schemas/Void'
272 description: Producer deleted
276 $ref: '#/components/schemas/Void'
278 description: Enrichment Information type is not found
282 $ref: '#/components/schemas/ProblemDetails'
284 description: The Enrichment Information type has one or several active producers
288 $ref: '#/components/schemas/ProblemDetails'
293 summary: Returns status and statistics of this service
294 operationId: getStatus
297 description: Service is living
301 $ref: '#/components/schemas/status_info'
302 /ei-producer/v1/eiproducers:
305 - Data producer (registration)
306 summary: EI producer identifiers
307 operationId: getEiProducerIdentifiers
311 description: If given, only the producers for the EI Data type is returned.
319 description: EI producer identifiers
326 /A1-EI/v1/eijobs/{eiJobId}:
329 - A1-EI (registration)
330 summary: Individual EI job
331 operationId: getIndividualEiJob_1
346 $ref: '#/components/schemas/EiJobObject'
348 description: Enrichment Information job is not found
352 $ref: '#/components/schemas/ProblemDetails'
355 - A1-EI (registration)
356 summary: Individual EI job
357 operationId: putIndividualEiJob
370 $ref: '#/components/schemas/EiJobObject'
374 description: Job updated
378 $ref: '#/components/schemas/Void'
380 description: Job created
384 $ref: '#/components/schemas/Void'
386 description: Enrichment Information type is not found
390 $ref: '#/components/schemas/ProblemDetails'
393 - A1-EI (registration)
394 summary: Individual EI job
395 operationId: deleteIndividualEiJob_1
406 description: Not used
410 $ref: '#/components/schemas/Void'
412 description: Job deleted
416 $ref: '#/components/schemas/Void'
418 description: Enrichment Information job is not found
422 $ref: '#/components/schemas/ProblemDetails'
423 /ei-producer/v1/eiproducers/{eiProducerId}:
426 - Data producer (registration)
427 summary: Individual EI producer
428 operationId: getEiProducer
439 description: EI producer
443 $ref: '#/components/schemas/producer_registration_info'
445 description: Enrichment Information producer is not found
449 $ref: '#/components/schemas/ProblemDetails'
452 - Data producer (registration)
453 summary: Individual EI producer
454 operationId: putEiProducer
467 $ref: '#/components/schemas/producer_registration_info'
471 description: Producer updated
475 $ref: '#/components/schemas/Void'
477 description: Producer created
481 $ref: '#/components/schemas/Void'
483 description: Producer not found
487 $ref: '#/components/schemas/ProblemDetails'
490 - Data producer (registration)
491 summary: Individual EI producer
492 operationId: deleteEiProducer
503 description: Not used
507 $ref: '#/components/schemas/Void'
509 description: Producer deleted
513 $ref: '#/components/schemas/Void'
515 description: Producer is not found
519 $ref: '#/components/schemas/ProblemDetails'
520 /producer_simulator/health_check:
523 - Data producer (callbacks)
524 summary: Producer supervision
525 description: The endpoint is provided by the EI producer and is used for supervision
527 operationId: producerSupervision
530 description: The producer is OK
535 /data-consumer/v1/info-jobs:
539 summary: EI job identifiers
540 description: query for information job identifiers
541 operationId: getJobIds
545 description: selects subscription jobs of matching information type
553 description: selects subscription jobs for one job owner
561 description: Information information job identifiers
569 description: Information type is not found
573 $ref: '#/components/schemas/ProblemDetails'
574 /data-consumer/v1/info-jobs/{infoJobId}:
578 summary: Individual data subscription job
579 operationId: getIndividualEiJob
590 description: Information subscription job
594 $ref: '#/components/schemas/Job'
596 description: Information subscription job is not found
600 $ref: '#/components/schemas/ProblemDetails'
604 summary: Individual data subscription job
605 description: The job will be enabled when a producer is available
606 operationId: putIndividualInfoJob
617 description: when true, a validation of that the type exists and that the
618 job matches the type schema.
629 $ref: '#/components/schemas/Job'
633 description: Job updated
637 $ref: '#/components/schemas/Void'
639 description: Job created
643 $ref: '#/components/schemas/Void'
645 description: Enrichment Information type is not found
649 $ref: '#/components/schemas/ProblemDetails'
653 summary: Individual data subscription job
654 operationId: deleteIndividualEiJob
665 description: Not used
669 $ref: '#/components/schemas/Void'
671 description: Job deleted
675 $ref: '#/components/schemas/Void'
677 description: Information subscription job is not found
681 $ref: '#/components/schemas/ProblemDetails'
682 /ei-producer/v1/eiproducers/{eiProducerId}/eijobs:
685 - Data producer (registration)
686 summary: EI job definitions
687 description: EI job definitions for one EI producer
688 operationId: getEiProducerJobs
699 description: EI producer
705 $ref: '#/components/schemas/producer_ei_job_request'
707 description: Enrichment Information producer is not found
711 $ref: '#/components/schemas/ProblemDetails'
712 /data-consumer/v1/info-types/{infoTypeId}:
716 summary: Individual information type
717 operationId: getInfoType
728 description: Information type
732 $ref: '#/components/schemas/InformationType'
734 description: Information type is not found
738 $ref: '#/components/schemas/ProblemDetails'
742 - A1-EI (registration)
743 summary: EI job identifiers
744 description: query for EI job identifiers
745 operationId: getEiJobIds
749 description: selects EI jobs of matching EI type
757 description: selects EI jobs for one EI job owner
765 description: EI job identifiers
773 description: Enrichment Information type is not found
777 $ref: '#/components/schemas/ProblemDetails'
778 /A1-EI/v1/eijobs/{eiJobId}/status:
781 - A1-EI (registration)
782 summary: EI job status
783 operationId: getEiJobStatus_1
794 description: EI job status
798 $ref: '#/components/schemas/EiJobStatusObject'
800 description: Enrichment Information job is not found
804 $ref: '#/components/schemas/ProblemDetails'
805 /example_dataconsumer/eijobs/{eiJobId}/status:
809 summary: Callback for changed EI job status
810 description: The primitive is implemented by the data consumer and is invoked
811 when a EI job status has been changed.
812 operationId: jobStatusCallback
825 $ref: '#/components/schemas/EiJobStatusObject'
833 $ref: '#/components/schemas/Void'
834 /data-consumer/v1/info-jobs/{infoJobId}/status:
839 operationId: getEiJobStatus
850 description: Information subscription job status
854 $ref: '#/components/schemas/JobStatus'
856 description: Information subscription job is not found
860 $ref: '#/components/schemas/ProblemDetails'
863 producer_ei_job_request:
870 description: The owner of the job
873 description: Idenitity of the EI job
876 description: The time when the job was last updated or created (ISO-8601)
879 description: Json for the job data
882 description: URI for the target of the EI
885 description: Type idenitity for the job
886 description: The body of the EI producer callbacks for EI job creation and deletion
889 description: Information for an EI type
900 description: Number of EI producers
904 description: Number of EI types
908 description: Number of EI jobs
912 description: status text
913 producer_ei_type_info:
920 description: Json schema for the job data
921 description: Information for an EI type
922 producer_registration_info:
924 - ei_job_callback_url
925 - ei_producer_supervision_callback_url
931 description: Supported EI type IDs
934 description: Supported EI type IDs
935 ei_producer_supervision_callback_url:
937 description: callback for producer supervision
940 description: callback for EI job
941 description: Information for an EI producer
947 description: A human-readable explanation specific to this occurrence of
949 example: EI job type not found
952 description: The HTTP status code generated by the origin server for this
953 occurrence of the problem.
956 description: A problem detail to carry details in a HTTP response according
965 description: Allowed values for EI job status
969 description: Status for an EI job
980 description: EI type Idenitifier of the EI job
983 description: The target URI of the EI data
986 description: Identity of the owner of the job
987 statusNotificationUri:
989 description: The target of EI job status notifications
992 description: EI type specific job data
993 description: Information for an Enrichment Information Job
1001 description: Allowed values for EI job status
1005 description: Status for an EI job
1013 description: Represents the operational states
1017 description: Status for an EI Producer
1020 description: 'Void/empty '
1031 description: The target URI of the subscribed information
1034 description: Information type Idenitifier of the subscription job
1037 description: Identity of the owner of the job
1038 statusNotificationUri:
1040 description: The target of Information subscription job status notifications
1043 description: Information type specific job data
1044 description: Information for an Enrichment Information Job
1047 - consumer_job_data_schema
1050 consumer_job_data_schema:
1052 description: Json schema for the job data
1053 description: Information for an Information type