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: A1-EI (enrichment information) callbacks
12 description: Consumer Simulator Controller
13 - name: Data Producer Job Control (example producer)
14 description: Producer Simulator Controller
15 - name: Data Producer Registry API
16 description: Producer Controller
17 - name: Service status
18 description: Status Controller
20 /producer_simulator/ei_job:
23 - Data Producer Job Control (example producer)
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:
86 - A1-EI (enrichment information) callbacks
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 - Data Producer Registry 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 - Data Producer Registry 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}:
206 - Data Producer Job Control (example producer)
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 - Data Producer Registry API
234 summary: EI producer identifiers
235 operationId: getEiProducerIdentifiersUsingGET
239 description: If given, only the producers for the EI Data type is returned.
240 allowEmptyValue: false
245 description: EI producer identifiers
253 description: Unauthorized
256 description: Forbidden
259 description: Not Found
262 /ei-producer/v1/eitypes/{eiTypeId}:
265 - Data Producer Registry API
266 summary: Individual EI type
267 operationId: getEiTypeUsingGET_1
271 description: eiTypeId
281 $ref: '#/components/schemas/producer_ei_type_info'
283 description: Unauthorized
286 description: Forbidden
289 description: Enrichment Information type is not found
293 $ref: '#/components/schemas/ProblemDetails'
297 - Data Producer Registry API
298 summary: Individual EI type
299 operationId: putEiTypeUsingPUT
303 description: eiTypeId
308 description: registrationInfo
312 $ref: '#/components/schemas/producer_ei_type_info'
325 description: Unauthorized
328 description: Forbidden
331 description: Not Found
336 - Data Producer Registry API
337 summary: Individual EI type
338 operationId: deleteEiTypeUsingDELETE
342 description: eiTypeId
348 description: Not used
351 description: Producer deleted
354 description: Unauthorized
357 description: Forbidden
360 description: Enrichment Information type is not found
364 $ref: '#/components/schemas/ProblemDetails'
366 description: The Enrichment Information type has one or several active producers
370 $ref: '#/components/schemas/ProblemDetails'
376 summary: Returns status and statistics of this service
377 operationId: getStatusUsingGET
380 description: Service is living
384 $ref: '#/components/schemas/status_info'
386 description: Unauthorized
389 description: Forbidden
392 description: Not Found
395 /A1-EI/v1/eijobs/{eiJobId}:
398 - A1-EI (enrichment information)
399 summary: Individual EI job
400 operationId: getIndividualEiJobUsingGET
414 $ref: '#/components/schemas/EiJobObject'
416 description: Unauthorized
419 description: Forbidden
422 description: Enrichment Information job is not found
426 $ref: '#/components/schemas/ProblemDetails'
430 - A1-EI (enrichment information)
431 summary: Individual EI job
432 operationId: putIndividualEiJobUsingPUT
441 description: eiJobObject
445 $ref: '#/components/schemas/EiJobObject'
449 description: Job updated
452 description: Job created
455 description: Unauthorized
458 description: Forbidden
461 description: Enrichment Information type is not found
465 $ref: '#/components/schemas/ProblemDetails'
469 - A1-EI (enrichment information)
470 summary: Individual EI job
471 operationId: deleteIndividualEiJobUsingDELETE
481 description: Not used
484 description: Job deleted
487 description: Unauthorized
490 description: Forbidden
493 description: Enrichment Information job is not found
497 $ref: '#/components/schemas/ProblemDetails'
499 /ei-producer/v1/eiproducers/{eiProducerId}:
502 - Data Producer Registry API
503 summary: Individual EI producer
504 operationId: getEiProducerUsingGET
508 description: eiProducerId
518 $ref: '#/components/schemas/producer_registration_info'
520 description: Unauthorized
523 description: Forbidden
526 description: Enrichment Information producer is not found
530 $ref: '#/components/schemas/ProblemDetails'
534 - Data Producer Registry API
535 summary: Individual EI producer
536 operationId: putEiProducerUsingPUT
540 description: eiProducerId
545 description: registrationInfo
549 $ref: '#/components/schemas/producer_registration_info'
553 description: Producer updated
556 description: Producer created
559 description: Unauthorized
562 description: Forbidden
565 description: Not Found
570 - Data Producer Registry API
571 summary: Individual EI producer
572 operationId: deleteEiProducerUsingDELETE
576 description: eiProducerId
582 description: Not used
585 description: Producer deleted
588 description: Unauthorized
591 description: Forbidden
594 description: Producer is not found
598 $ref: '#/components/schemas/ProblemDetails'
600 /producer_simulator/health_check:
603 - Data Producer Job Control (example producer)
604 summary: Producer supervision
605 operationId: producerSupervisionUsingGET
614 description: Unauthorized
617 description: Forbidden
620 description: Not Found
623 /ei-producer/v1/eiproducers/{eiProducerId}/eijobs:
626 - Data Producer Registry API
627 summary: EI job definitions
628 description: EI job definitions for one EI producer
629 operationId: getEiProducerJobsUsingGET
633 description: eiProducerId
645 $ref: '#/components/schemas/producer_ei_job_request'
647 description: Unauthorized
650 description: Forbidden
653 description: Enrichment Information producer is not found
657 $ref: '#/components/schemas/ProblemDetails'
662 - A1-EI (enrichment information)
663 summary: EI job identifiers
664 description: query for EI job identifiers
665 operationId: getEiJobIdsUsingGET
669 description: selects EI jobs of matching EI type
670 allowEmptyValue: false
675 description: selects EI jobs for one EI job owner
676 allowEmptyValue: false
681 description: EI job identifiers
689 description: Unauthorized
692 description: Forbidden
695 description: Enrichment Information type is not found
699 $ref: '#/components/schemas/ProblemDetails'
701 /A1-EI/v1/eijobs/{eiJobId}/status:
704 - A1-EI (enrichment information)
705 summary: EI job status
706 operationId: getEiJobStatusUsingGET
716 description: EI job status
720 $ref: '#/components/schemas/EiJobStatusObject'
722 description: Unauthorized
725 description: Forbidden
728 description: Enrichment Information job is not found
732 $ref: '#/components/schemas/ProblemDetails'
736 producer_ei_job_request:
737 title: producer_ei_job_request
744 description: The owner of the job
747 description: Idenitity of the EI job
751 description: Json for the job data
754 description: URI for the target of the EI
757 description: Type idenitity for the job
758 description: The body of the EI producer callbacks for EI job creation and deletion
762 description: Information for an EI type
769 description: Number of EI producers
773 description: Number of EI jobs
777 description: Number of EI types
781 description: status text
782 Mono«ResponseEntity«object»»:
783 title: Mono«ResponseEntity«object»»
785 producer_ei_type_info:
786 title: producer_ei_type_info
792 description: Json schema for the job data
793 description: Information for an EI type
794 producer_registration_info:
795 title: producer_registration_info
797 - ei_job_callback_url
798 - ei_producer_supervision_callback_url
804 description: Supported EI type IDs
807 ei_producer_supervision_callback_url:
809 description: callback for producer supervision
812 description: callback for EI job
813 description: Information for an EI producer
815 title: producer_status
823 Operational state, values:
829 description: Status for an EI Producer
831 title: ProblemDetails
836 description: A human-readable explanation specific to this occurrence of
838 example: EI job type not found
841 description: The HTTP status code generated by the origin server for this
842 occurrence of the problem.
845 description: A problem detail to carry details in a HTTP response according
850 description: Void/empty
852 title: EiJobStatusObject
861 ENABLED: the A1-EI producer is able to deliver EI result for the EI job
862 DISABLED: the A1-EI producer is unable to deliver EI result for the EI job
866 description: Status for an EI job
878 description: EI type Idenitifier of the EI job
881 description: The target URI of the EI data
884 description: Identity of the owner of the job
885 jobStatusNotificationUri:
887 description: The target of EI job status notifications
891 description: EI type specific job data
892 description: Information for an Enrichment Information Job