3 title: Enrichment Information Service
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 producer one or several type 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 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, which is a data consumer and the Non-RT RIC. </p><h4>Data
12 producer API</h4><p> This API is between data producers and this service. It
13 is divivided into two parts, where one is provided by this service (registration)
14 and one part is provided by the data producer.</p><h4>EI Service status</h4><p> This
15 API provides a means to monitor the service.</p>
17 name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.
18 url: http://www.apache.org/licenses/LICENSE-2.0
23 - name: A1-EI (registration)
24 description: Data consumer EI job registration
25 - name: A1-EI (callbacks)
26 description: Data consumer EI job status callbacks
27 - name: Data producer (callbacks)
28 description: API implemented by data producers
29 - name: Data producer (registration)
30 description: API for data producers
31 - name: EI Service status
32 description: API for monitoring of the service
34 /producer_simulator/ei_job:
37 - Data producer (callbacks)
38 summary: Callback for EI job creation/modification
39 description: The call is invoked to activate or to modify a data subscription.
40 The endpoint is provided by the EI producer.
41 operationId: jobCreatedCallback
46 $ref: '#/components/schemas/producer_ei_job_request'
54 $ref: '#/components/schemas/Void'
55 /A1-EI/v1/eitypes/{eiTypeId}:
58 - A1-EI (registration)
59 summary: Individual EI type
60 operationId: getEiType_1
75 $ref: '#/components/schemas/EiTypeObject'
77 description: Enrichment Information type is not found
81 $ref: '#/components/schemas/ProblemDetails'
82 /ei-producer/v1/eitypes:
85 - Data producer (registration)
86 summary: EI type identifiers
87 operationId: getEiTypeIdentifiers
90 description: EI type identifiers
100 - A1-EI (registration)
101 summary: EI type identifiers
102 operationId: getEiTypeIdentifiers_1
105 description: EI type identifiers
112 /ei-producer/v1/eiproducers/{eiProducerId}/status:
115 - Data producer (registration)
116 summary: EI producer status
117 operationId: getEiProducerStatus
128 description: EI producer status
132 $ref: '#/components/schemas/producer_status'
134 description: Enrichment Information producer is not found
138 $ref: '#/components/schemas/ProblemDetails'
139 /producer_simulator/ei_job/{eiJobId}:
142 - Data producer (callbacks)
143 summary: Callback for EI job deletion
144 description: The call is invoked to terminate a data subscription. The endpoint
145 is provided by the EI producer.
146 operationId: jobDeletedCallback
161 $ref: '#/components/schemas/Void'
162 /ei-producer/v1/eitypes/{eiTypeId}:
165 - Data producer (registration)
166 summary: Individual EI type
167 operationId: getEiType
182 $ref: '#/components/schemas/producer_ei_type_info'
184 description: Enrichment Information type is not found
188 $ref: '#/components/schemas/ProblemDetails'
191 - Data producer (registration)
192 summary: Individual EI type
193 operationId: putEiType
206 $ref: '#/components/schemas/producer_ei_type_info'
210 description: Type updated
214 $ref: '#/components/schemas/Void'
216 description: Type created
220 $ref: '#/components/schemas/Void'
222 description: Bad request
226 $ref: '#/components/schemas/ProblemDetails'
229 - Data producer (registration)
230 summary: Individual EI type
231 operationId: deleteEiType
242 description: Not used
246 $ref: '#/components/schemas/Void'
248 description: Producer deleted
252 $ref: '#/components/schemas/Void'
254 description: Enrichment Information type is not found
258 $ref: '#/components/schemas/ProblemDetails'
260 description: The Enrichment Information type has one or several active producers
264 $ref: '#/components/schemas/ProblemDetails'
269 summary: Returns status and statistics of this service
270 operationId: getStatus
273 description: Service is living
277 $ref: '#/components/schemas/status_info'
278 /ei-producer/v1/eiproducers:
281 - Data producer (registration)
282 summary: EI producer identifiers
283 operationId: getEiProducerIdentifiers
287 description: If given, only the producers for the EI Data type is returned.
295 description: EI producer identifiers
302 /A1-EI/v1/eijobs/{eiJobId}:
305 - A1-EI (registration)
306 summary: Individual EI job
307 operationId: getIndividualEiJob
322 $ref: '#/components/schemas/EiJobObject'
324 description: Enrichment Information job is not found
328 $ref: '#/components/schemas/ProblemDetails'
331 - A1-EI (registration)
332 summary: Individual EI job
333 operationId: putIndividualEiJob
346 $ref: '#/components/schemas/EiJobObject'
350 description: Job updated
354 $ref: '#/components/schemas/Void'
356 description: Job created
360 $ref: '#/components/schemas/Void'
362 description: Enrichment Information type is not found
366 $ref: '#/components/schemas/ProblemDetails'
369 - A1-EI (registration)
370 summary: Individual EI job
371 operationId: deleteIndividualEiJob
382 description: Not used
386 $ref: '#/components/schemas/Void'
388 description: Job deleted
392 $ref: '#/components/schemas/Void'
394 description: Enrichment Information job is not found
398 $ref: '#/components/schemas/ProblemDetails'
399 /ei-producer/v1/eiproducers/{eiProducerId}:
402 - Data producer (registration)
403 summary: Individual EI producer
404 operationId: getEiProducer
415 description: EI producer
419 $ref: '#/components/schemas/producer_registration_info'
421 description: Enrichment Information producer is not found
425 $ref: '#/components/schemas/ProblemDetails'
428 - Data producer (registration)
429 summary: Individual EI producer
430 operationId: putEiProducer
443 $ref: '#/components/schemas/producer_registration_info'
447 description: Producer updated
451 $ref: '#/components/schemas/Void'
453 description: Producer created
457 $ref: '#/components/schemas/Void'
460 - Data producer (registration)
461 summary: Individual EI producer
462 operationId: deleteEiProducer
473 description: Not used
477 $ref: '#/components/schemas/Void'
479 description: Producer deleted
483 $ref: '#/components/schemas/Void'
485 description: Producer is not found
489 $ref: '#/components/schemas/ProblemDetails'
490 /producer_simulator/health_check:
493 - Data producer (callbacks)
494 summary: Producer supervision
495 description: The endpoint is provided by the EI producer and is used for supervision
497 operationId: producerSupervision
500 description: The producer is OK
505 /ei-producer/v1/eiproducers/{eiProducerId}/eijobs:
508 - Data producer (registration)
509 summary: EI job definitions
510 description: EI job definitions for one EI producer
511 operationId: getEiProducerJobs
522 description: EI producer
528 $ref: '#/components/schemas/producer_ei_job_request'
530 description: Enrichment Information producer is not found
534 $ref: '#/components/schemas/ProblemDetails'
538 - A1-EI (registration)
539 summary: EI job identifiers
540 description: query for EI job identifiers
541 operationId: getEiJobIds
545 description: selects EI jobs of matching EI type
553 description: selects EI jobs for one EI job owner
561 description: EI job identifiers
569 description: Enrichment Information type is not found
573 $ref: '#/components/schemas/ProblemDetails'
574 /A1-EI/v1/eijobs/{eiJobId}/status:
577 - A1-EI (registration)
578 summary: EI job status
579 operationId: getEiJobStatus
590 description: EI job status
594 $ref: '#/components/schemas/EiJobStatusObject'
596 description: Enrichment Information job is not found
600 $ref: '#/components/schemas/ProblemDetails'
601 /example_dataconsumer/eijobs/{eiJobId}/status:
605 summary: Callback for changed EI job status
606 description: The primitive is implemented by the data consumer and is invoked
607 when a EI job status has been changed.
608 operationId: jobStatusCallback
621 $ref: '#/components/schemas/EiJobStatusObject'
629 $ref: '#/components/schemas/Void'
632 producer_ei_job_request:
639 description: The owner of the job
642 description: Idenitity of the EI job
645 description: The time when the job was last updated or created (ISO-8601)
648 description: Json for the job data
651 description: URI for the target of the EI
654 description: Type idenitity for the job
655 description: The body of the EI producer callbacks for EI job creation and deletion
658 description: Information for an EI type
669 description: Number of EI producers
673 description: Number of EI types
677 description: Number of EI jobs
681 description: status text
682 producer_ei_type_info:
689 description: Json schema for the job data
690 description: Information for an EI type
691 producer_registration_info:
693 - ei_job_callback_url
694 - ei_producer_supervision_callback_url
700 description: Supported EI type IDs
703 description: Supported EI type IDs
704 ei_producer_supervision_callback_url:
706 description: callback for producer supervision
709 description: callback for EI job
710 description: Information for an EI producer
718 description: Represents the operational states
722 description: Status for an EI Producer
728 description: A human-readable explanation specific to this occurrence of
730 example: EI job type not found
733 description: The HTTP status code generated by the origin server for this
734 occurrence of the problem.
737 description: A problem detail to carry details in a HTTP response according
741 description: 'Void/empty '
749 description: Allowed values for EI job status
753 description: Status for an EI job
764 description: EI type Idenitifier of the EI job
767 description: The target URI of the EI data
770 description: Identity of the owner of the job
771 statusNotificationUri:
773 description: The target of EI job status notifications
776 description: EI type specific job data
777 description: Information for an Enrichment Information Job