3 title: Enrichment Data service
4 description: This page lists all the rest apis for the service.
9 - name: A1-EI (enrichment information)
10 description: Consumer Controller
11 - name: Consumer Callbacks
12 description: Consumer Simulator Controller
13 - name: Enrichment Data Producer API
14 description: Producer Controller
15 - name: Producer Callbacks
16 description: Producer Simulator Controller
17 - name: Service status
18 description: Status Controller
20 /producer_simulator/ei_job:
24 summary: Callback for EI job creation
25 operationId: jobCreatedCallbackUsingPOST
31 $ref: '#/components/schemas/producer_ei_job_request'
41 description: Unauthorized
44 description: Forbidden
47 description: Not Found
50 /A1-EI/v1/eitypes/{eiTypeId}:
53 - A1-EI (enrichment information)
54 summary: Individual EI type
55 operationId: getEiTypeUsingGET
69 $ref: '#/components/schemas/EiTypeObject'
71 description: Unauthorized
74 description: Forbidden
77 description: Enrichment Information type is not found
81 $ref: '#/components/schemas/ProblemDetails'
83 /consumer_simulator/eijobs/{eiJobId}/status:
87 summary: Callback for EI job status
88 operationId: jobStatusCallbackUsingPOST
101 $ref: '#/components/schemas/EiJobStatusObject'
111 description: Unauthorized
114 description: Forbidden
117 description: Not Found
120 /ei-producer/v1/eitypes:
123 - Enrichment Data Producer API
124 summary: EI type identifiers
125 operationId: getEiTypeIdentifiersUsingGET_1
128 description: EI type identifiers
136 description: Unauthorized
139 description: Forbidden
142 description: Not Found
148 - A1-EI (enrichment information)
149 summary: EI type identifiers
150 operationId: getEiTypeIdentifiersUsingGET
153 description: EI type identifiers
161 description: Unauthorized
164 description: Forbidden
167 description: Not Found
170 /ei-producer/v1/eiproducers/{eiProducerId}/status:
173 - Enrichment Data Producer API
174 summary: EI producer status
175 operationId: getEiProducerStatusUsingGET
179 description: eiProducerId
189 $ref: '#/components/schemas/producer_status'
191 description: Unauthorized
194 description: Forbidden
197 description: Enrichment Information producer is not found
201 $ref: '#/components/schemas/ProblemDetails'
203 /producer_simulator/ei_job/{eiJobId}:
207 summary: Callback for EI job deletion
208 operationId: jobDeletedCallbackUsingDELETE
221 description: No Content
224 description: Unauthorized
227 description: Forbidden
230 /ei-producer/v1/eiproducers:
233 - Enrichment Data Producer API
234 summary: EI producer identifiers
235 operationId: getEiProducerIdentifiersUsingGET
238 description: EI producer identifiers
246 description: Unauthorized
249 description: Forbidden
252 description: Not Found
255 /ei-producer/v1/eitypes/{eiTypeId}:
258 - Enrichment Data Producer API
259 summary: Individual EI type
260 operationId: getEiTypeUsingGET_1
264 description: eiTypeId
274 $ref: '#/components/schemas/producer_ei_type_info'
276 description: Unauthorized
279 description: Forbidden
282 description: Enrichment Information type is not found
286 $ref: '#/components/schemas/ProblemDetails'
292 summary: Returns status and statistics of this service
293 operationId: getStatusUsingGET
296 description: Service is living
300 $ref: '#/components/schemas/status_info'
302 description: Unauthorized
305 description: Forbidden
308 description: Not Found
311 /A1-EI/v1/eijobs/{eiJobId}:
314 - A1-EI (enrichment information)
315 summary: Individual EI job
316 operationId: getIndividualEiJobUsingGET
330 $ref: '#/components/schemas/EiJobObject'
332 description: Unauthorized
335 description: Forbidden
338 description: Enrichment Information job is not found
342 $ref: '#/components/schemas/ProblemDetails'
346 - A1-EI (enrichment information)
347 summary: Individual EI job
348 operationId: putIndividualEiJobUsingPUT
357 description: eiJobObject
361 $ref: '#/components/schemas/EiJobObject'
365 description: Job updated
368 description: Job created
371 description: Unauthorized
374 description: Forbidden
377 description: Enrichment Information type is not found
381 $ref: '#/components/schemas/ProblemDetails'
385 - A1-EI (enrichment information)
386 summary: Individual EI job
387 operationId: deleteIndividualEiJobUsingDELETE
397 description: Not used
400 description: Job deleted
403 description: Unauthorized
406 description: Forbidden
409 description: Enrichment Information job is not found
413 $ref: '#/components/schemas/ProblemDetails'
415 /ei-producer/v1/eiproducers/{eiProducerId}:
418 - Enrichment Data Producer API
419 summary: Individual EI producer
420 operationId: getEiProducerUsingGET
424 description: eiProducerId
434 $ref: '#/components/schemas/producer_registration_info'
436 description: Unauthorized
439 description: Forbidden
442 description: Enrichment Information producer is not found
446 $ref: '#/components/schemas/ProblemDetails'
450 - Enrichment Data Producer API
451 summary: Individual EI producer
452 operationId: putEiProducerUsingPUT
456 description: eiProducerId
461 description: registrationInfo
465 $ref: '#/components/schemas/producer_registration_info'
469 description: Producer updated
472 description: Producer created
475 description: Unauthorized
478 description: Forbidden
481 description: Not Found
486 - Enrichment Data Producer API
487 summary: Individual EI producer
488 operationId: deleteEiProducerUsingDELETE
492 description: eiProducerId
498 description: Not used
501 description: Producer deleted
504 description: Unauthorized
507 description: Forbidden
510 description: Producer is not found
514 $ref: '#/components/schemas/ProblemDetails'
516 /producer_simulator/health_check:
520 summary: Producer supervision
521 operationId: producerSupervisionUsingGET
530 description: Unauthorized
533 description: Forbidden
536 description: Not Found
539 /ei-producer/v1/eiproducers/{eiProducerId}/eijobs:
542 - Enrichment Data Producer API
543 summary: EI job definitions
544 description: EI job definitions for one EI producer
545 operationId: getEiProducerJobsUsingGET
549 description: eiProducerId
561 $ref: '#/components/schemas/producer_ei_job_request'
563 description: Unauthorized
566 description: Forbidden
569 description: Enrichment Information producer is not found
573 $ref: '#/components/schemas/ProblemDetails'
578 - A1-EI (enrichment information)
579 summary: EI job identifiers
580 description: query for EI job identifiers
581 operationId: getEiJobIdsUsingGET
585 description: selects EI jobs of matching EI type
586 allowEmptyValue: false
591 description: selects EI jobs for one EI job owner
592 allowEmptyValue: false
597 description: EI job identifiers
605 description: Unauthorized
608 description: Forbidden
611 description: Enrichment Information type is not found
615 $ref: '#/components/schemas/ProblemDetails'
617 /A1-EI/v1/eijobs/{eiJobId}/status:
620 - A1-EI (enrichment information)
621 summary: EI job status
622 operationId: getEiJobStatusUsingGET
632 description: EI job status
636 $ref: '#/components/schemas/EiJobStatusObject'
638 description: Unauthorized
641 description: Forbidden
644 description: Enrichment Information job is not found
648 $ref: '#/components/schemas/ProblemDetails'
652 producer_ei_job_request:
653 title: producer_ei_job_request
660 description: The owner of the job
663 description: Idenitity of the EI job
667 description: Json for the job data
670 description: URI for the target of the EI
673 description: Type idenitity for the job
674 description: The body of the EI producer callbacks for EI job creation and deletion
678 description: Information for an EI type
679 producer_ei_type_registration_info:
680 title: producer_ei_type_registration_info
687 description: EI type identity
691 description: Json schema for the job data
692 description: Information for an EI type
699 description: Number of EI producers
703 description: Number of EI jobs
707 description: Number of EI types
711 description: status text
712 Mono«ResponseEntity«object»»:
713 title: Mono«ResponseEntity«object»»
715 producer_ei_type_info:
716 title: producer_ei_type_info
721 description: Registered producers
727 description: Json schema for the job data
728 description: Information for an EI type
729 producer_registration_info:
730 title: producer_registration_info
732 - ei_job_callback_url
733 - ei_producer_supervision_callback_url
739 description: Supported EI types
741 $ref: '#/components/schemas/producer_ei_type_registration_info'
742 ei_producer_supervision_callback_url:
744 description: callback for producer supervision
747 description: callback for EI job
748 description: Information for an EI producer
750 title: producer_status
758 Operational state, values:
764 description: Status for an EI Producer
766 title: ProblemDetails
771 description: A human-readable explanation specific to this occurrence of
773 example: EI job type not found
776 description: The HTTP status code generated by the origin server for this
777 occurrence of the problem.
780 description: A problem detail to carry details in a HTTP response according
785 description: Void/empty
787 title: EiJobStatusObject
796 ENABLED: the A1-EI producer is able to deliver EI result for the EI job
797 DISABLED: the A1-EI producer is unable to deliver EI result for the EI job
801 description: Status for an EI job
813 description: EI type Idenitifier of the EI job
816 description: The target URI of the EI data
819 description: Identity of the owner of the job
820 jobStatusNotificationUri:
822 description: The target of EI job status notifications
826 description: EI type specific job data
827 description: Information for an Enrichment Information Job