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'
322 description: Bad request
326 $ref: '#/components/schemas/ProblemDetails'
328 description: Unauthorized
331 description: Forbidden
334 description: Not Found
339 - Data Producer Registry API
340 summary: Individual EI type
341 operationId: deleteEiTypeUsingDELETE
345 description: eiTypeId
351 description: Not used
354 description: Producer deleted
357 description: Unauthorized
360 description: Forbidden
363 description: Enrichment Information type is not found
367 $ref: '#/components/schemas/ProblemDetails'
369 description: The Enrichment Information type has one or several active producers
373 $ref: '#/components/schemas/ProblemDetails'
379 summary: Returns status and statistics of this service
380 operationId: getStatusUsingGET
383 description: Service is living
387 $ref: '#/components/schemas/status_info'
389 description: Unauthorized
392 description: Forbidden
395 description: Not Found
398 /A1-EI/v1/eijobs/{eiJobId}:
401 - A1-EI (enrichment information)
402 summary: Individual EI job
403 operationId: getIndividualEiJobUsingGET
417 $ref: '#/components/schemas/EiJobObject'
419 description: Unauthorized
422 description: Forbidden
425 description: Enrichment Information job is not found
429 $ref: '#/components/schemas/ProblemDetails'
433 - A1-EI (enrichment information)
434 summary: Individual EI job
435 operationId: putIndividualEiJobUsingPUT
444 description: eiJobObject
448 $ref: '#/components/schemas/EiJobObject'
452 description: Job updated
455 description: Job created
458 description: Unauthorized
461 description: Forbidden
464 description: Enrichment Information type is not found
468 $ref: '#/components/schemas/ProblemDetails'
472 - A1-EI (enrichment information)
473 summary: Individual EI job
474 operationId: deleteIndividualEiJobUsingDELETE
484 description: Not used
487 description: Job deleted
490 description: Unauthorized
493 description: Forbidden
496 description: Enrichment Information job is not found
500 $ref: '#/components/schemas/ProblemDetails'
502 /ei-producer/v1/eiproducers/{eiProducerId}:
505 - Data Producer Registry API
506 summary: Individual EI producer
507 operationId: getEiProducerUsingGET
511 description: eiProducerId
521 $ref: '#/components/schemas/producer_registration_info'
523 description: Unauthorized
526 description: Forbidden
529 description: Enrichment Information producer is not found
533 $ref: '#/components/schemas/ProblemDetails'
537 - Data Producer Registry API
538 summary: Individual EI producer
539 operationId: putEiProducerUsingPUT
543 description: eiProducerId
548 description: registrationInfo
552 $ref: '#/components/schemas/producer_registration_info'
556 description: Producer updated
559 description: Producer created
562 description: Unauthorized
565 description: Forbidden
568 description: Not Found
573 - Data Producer Registry API
574 summary: Individual EI producer
575 operationId: deleteEiProducerUsingDELETE
579 description: eiProducerId
585 description: Not used
588 description: Producer deleted
591 description: Unauthorized
594 description: Forbidden
597 description: Producer is not found
601 $ref: '#/components/schemas/ProblemDetails'
603 /producer_simulator/health_check:
606 - Data Producer Job Control (example producer)
607 summary: Producer supervision
608 operationId: producerSupervisionUsingGET
617 description: Unauthorized
620 description: Forbidden
623 description: Not Found
626 /ei-producer/v1/eiproducers/{eiProducerId}/eijobs:
629 - Data Producer Registry API
630 summary: EI job definitions
631 description: EI job definitions for one EI producer
632 operationId: getEiProducerJobsUsingGET
636 description: eiProducerId
648 $ref: '#/components/schemas/producer_ei_job_request'
650 description: Unauthorized
653 description: Forbidden
656 description: Enrichment Information producer is not found
660 $ref: '#/components/schemas/ProblemDetails'
665 - A1-EI (enrichment information)
666 summary: EI job identifiers
667 description: query for EI job identifiers
668 operationId: getEiJobIdsUsingGET
672 description: selects EI jobs of matching EI type
673 allowEmptyValue: false
678 description: selects EI jobs for one EI job owner
679 allowEmptyValue: false
684 description: EI job identifiers
692 description: Unauthorized
695 description: Forbidden
698 description: Enrichment Information type is not found
702 $ref: '#/components/schemas/ProblemDetails'
704 /A1-EI/v1/eijobs/{eiJobId}/status:
707 - A1-EI (enrichment information)
708 summary: EI job status
709 operationId: getEiJobStatusUsingGET
719 description: EI job status
723 $ref: '#/components/schemas/EiJobStatusObject'
725 description: Unauthorized
728 description: Forbidden
731 description: Enrichment Information job is not found
735 $ref: '#/components/schemas/ProblemDetails'
739 producer_ei_job_request:
740 title: producer_ei_job_request
747 description: The owner of the job
750 description: Idenitity of the EI job
753 description: The time when the job was last updated or created (ISO-8601)
757 description: Json for the job data
760 description: URI for the target of the EI
763 description: Type idenitity for the job
764 description: The body of the EI producer callbacks for EI job creation and deletion
768 description: Information for an EI type
775 description: Number of EI producers
779 description: Number of EI jobs
783 description: Number of EI types
787 description: status text
788 Mono«ResponseEntity«object»»:
789 title: Mono«ResponseEntity«object»»
791 producer_ei_type_info:
792 title: producer_ei_type_info
800 description: Json schema for the job data
801 description: Information for an EI type
802 producer_registration_info:
803 title: producer_registration_info
805 - ei_job_callback_url
806 - ei_producer_supervision_callback_url
812 description: Supported EI type IDs
815 ei_producer_supervision_callback_url:
817 description: callback for producer supervision
820 description: callback for EI job
821 description: Information for an EI producer
823 title: producer_status
831 Operational state, values:
837 description: Status for an EI Producer
839 title: ProblemDetails
844 description: A human-readable explanation specific to this occurrence of
846 example: EI job type not found
849 description: The HTTP status code generated by the origin server for this
850 occurrence of the problem.
853 description: A problem detail to carry details in a HTTP response according
858 description: Void/empty
860 title: EiJobStatusObject
869 ENABLED: the A1-EI producer is able to deliver EI result for the EI job
870 DISABLED: the A1-EI producer is unable to deliver EI result for the EI job
874 description: Status for an EI job
886 description: EI type Idenitifier of the EI job
889 description: The target URI of the EI data
892 description: Identity of the owner of the job
893 jobStatusNotificationUri:
895 description: The target of EI job status notifications
899 description: EI type specific job data
900 description: Information for an Enrichment Information Job