3 description: This page lists all the rest apis for the service.
5 title: Enrichment Data service
9 - name: A1-E Enrichment Data Consumer API
10 description: Consumer Controller
11 - name: Enrichment Data Producer API
12 description: Producer Controller
13 - name: Producer Simulator
14 description: Producer Simulator Controller
19 - A1-E Enrichment Data Consumer API
20 summary: EI type identifiers
21 operationId: getEiTypeIdentifiersUsingGET
26 description: EI type identifiers
32 description: Unauthorized
34 description: Forbidden
36 description: Not Found
38 '/A1-EI/v1/eitypes/{eiTypeId}':
41 - A1-E Enrichment Data Consumer API
42 summary: Individual EI type
43 operationId: getEiTypeUsingGET
56 $ref: '#/definitions/EiType'
58 description: Unauthorized
60 description: Forbidden
62 description: Enrichment Information type is not found
64 $ref: '#/definitions/error_information'
66 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs':
69 - A1-E Enrichment Data Consumer API
70 summary: EI job identifiers
71 operationId: getEiJobIdsUsingGET
82 description: identifies the owner of the job
88 description: EI job identifiers
94 description: Unauthorized
96 description: Forbidden
98 description: Enrichment Information type is not found
100 $ref: '#/definitions/error_information'
102 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}':
105 - A1-E Enrichment Data Consumer API
106 summary: Individual EI Job
107 operationId: getIndividualEiJobUsingGET
118 description: eiTypeId
125 $ref: '#/definitions/EiJob'
127 description: Unauthorized
129 description: Forbidden
131 description: Enrichment Information type or job is not found
133 $ref: '#/definitions/error_information'
137 - A1-E Enrichment Data Consumer API
138 summary: Individual EI Job
139 operationId: putIndividualEiJobUsingPUT
152 description: eiJobInfo
155 $ref: '#/definitions/EiJob'
158 description: eiTypeId
163 description: Job updated
165 description: Job created
167 description: Unauthorized
169 description: Forbidden
171 description: Enrichment Information type is not found
173 $ref: '#/definitions/error_information'
177 - A1-E Enrichment Data Consumer API
178 summary: Individual EI Job
179 operationId: deleteIndividualEiJobUsingDELETE
190 description: eiTypeId
195 description: Not used
197 description: Job deleted
199 description: Unauthorized
201 description: Forbidden
203 description: Enrichment Information type or job is not found
205 $ref: '#/definitions/error_information'
207 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status':
210 - A1-E Enrichment Data Consumer API
211 summary: EI Job status
212 operationId: getEiJobStatusUsingGET
223 description: eiTypeId
228 description: EI Job status
230 $ref: '#/definitions/EiJobStatus'
232 description: Unauthorized
234 description: Forbidden
236 description: Enrichment Information type or job is not found
238 $ref: '#/definitions/error_information'
240 /ei-producer/v1/eiproducers:
243 - Enrichment Data Producer API
244 summary: EI producer identifiers
245 operationId: getEiProducerIdentifiersUsingGET
250 description: EI producer identifiers
256 description: Unauthorized
258 description: Forbidden
260 description: Not Found
262 '/ei-producer/v1/eiproducers/{eiProducerId}':
265 - Enrichment Data Producer API
266 summary: Individual EI producer
267 operationId: getEiProducerUsingGET
273 description: eiProducerId
280 $ref: '#/definitions/producer_registration_info'
282 description: Unauthorized
284 description: Forbidden
286 description: Enrichment Information producer is not found
288 $ref: '#/definitions/error_information'
292 - Enrichment Data Producer API
293 summary: Individual EI producer
294 operationId: putEiProducerUsingPUT
302 description: eiProducerId
306 name: registrationInfo
307 description: registrationInfo
310 $ref: '#/definitions/producer_registration_info'
313 description: Producer updated
315 description: Producer created
317 description: Unauthorized
319 description: Forbidden
321 description: Not Found
325 - Enrichment Data Producer API
326 summary: Individual EI producer
327 operationId: deleteEiProducerUsingDELETE
333 description: eiProducerId
338 description: Not used
340 description: Producer deleted
342 description: Unauthorized
344 description: Forbidden
346 description: Producer is not found
348 $ref: '#/definitions/error_information'
350 '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs':
353 - Enrichment Data Producer API
354 summary: EI job definitions
355 description: EI job definitions for one EI producer
356 operationId: getEiProducerJobsUsingGET
362 description: eiProducerId
371 $ref: '#/definitions/producer_ei_job_request'
373 description: Unauthorized
375 description: Forbidden
377 description: Enrichment Information producer is not found
379 $ref: '#/definitions/error_information'
381 '/ei-producer/v1/eiproducers/{eiProducerId}/status':
384 - Enrichment Data Producer API
385 summary: EI producer status
386 operationId: getEiProducerStatusUsingGET
392 description: eiProducerId
399 $ref: '#/definitions/producer_status'
401 description: Unauthorized
403 description: Forbidden
405 description: Enrichment Information producer is not found
407 $ref: '#/definitions/error_information'
409 /ei-producer/v1/eitypes:
412 - Enrichment Data Producer API
413 summary: EI type identifiers
414 operationId: getEiTypeIdentifiersUsingGET_1
419 description: EI type identifiers
425 description: Unauthorized
427 description: Forbidden
429 description: Not Found
431 '/ei-producer/v1/eitypes/{eiTypeId}':
434 - Enrichment Data Producer API
435 summary: Individual EI Type
436 operationId: getEiTypeUsingGET_1
442 description: eiTypeId
449 $ref: '#/definitions/producer_ei_type_info'
451 description: Unauthorized
453 description: Forbidden
455 description: Enrichment Information type is not found
457 $ref: '#/definitions/error_information'
459 /producer_simulator/job_created:
463 summary: Callback for EI job creation
464 operationId: jobCreatedCallbackUsingPOST
475 $ref: '#/definitions/producer_ei_job_request'
482 description: Unauthorized
484 description: Forbidden
486 description: Not Found
488 /producer_simulator/job_created_error:
492 summary: 'Callback for EI job creation, returns error'
493 operationId: jobCreatedCallbackReturnErrorUsingPOST
504 $ref: '#/definitions/producer_ei_job_request'
511 description: Unauthorized
513 description: Forbidden
515 description: Not Found
517 /producer_simulator/job_deleted:
521 summary: Callback for EI job deletion
522 operationId: jobDeletedCallbackUsingPOST
533 $ref: '#/definitions/producer_ei_job_request'
540 description: Unauthorized
542 description: Forbidden
544 description: Not Found
546 /producer_simulator/job_deleted_error:
550 summary: 'Callback for EI job creation, returns error'
551 operationId: jobDeletedCallbackReturnErrorUsingPOST
562 $ref: '#/definitions/producer_ei_job_request'
569 description: Unauthorized
571 description: Forbidden
573 description: Not Found
575 /producer_simulator/supervision:
579 summary: Producer supervision
580 operationId: producerSupervisionUsingGET
589 description: Unauthorized
591 description: Forbidden
593 description: Not Found
595 /producer_simulator/supervision_error:
599 summary: Producer supervision error
600 operationId: producerSupervisionErrorUsingGET
609 description: Unauthorized
611 description: Forbidden
613 description: Not Found
625 description: Identity of the owner of the job
628 description: EI Type specific job data
631 description: The target of the EI data
633 description: Information for an Enrichment Information Job
642 Operational state, values:
649 description: Status for an EI Job
653 eiJobParametersSchema:
655 description: Json schema for the job data
657 description: Information for an EI type
658 Mono«ResponseEntity«object»»:
660 title: Mono«ResponseEntity«object»»
666 example: EI job type not found
667 description: A human-readable explanation specific to this occurrence of the problem.
672 description: The HTTP status code generated by the origin server for this occurrence of the problem.
673 title: error_information
674 description: 'Problem as defined in https://tools.ietf.org/html/rfc7807'
675 producer_ei_job_request:
682 description: Json for the job data
685 description: Idenitity of the EI job
688 description: Type idenitity for the job
691 description: URI for the target of the EI
692 title: producer_ei_job_request
693 description: The body of the EI producer callbacks for EI job creation and deletion
694 producer_ei_type_info:
699 description: Json schema for the job data
702 description: Registered producers
705 title: producer_ei_type_info
706 description: Information for an EI type
707 producer_ei_type_registration_info:
714 description: Json schema for the job data
717 description: EI type identity
718 title: producer_ei_type_registration_info
719 description: Information for an EI type
720 producer_registration_info:
723 - ei_job_creation_callback_url
724 - ei_job_deletion_callback_url
725 - ei_producer_supervision_callback_url
728 ei_job_creation_callback_url:
730 description: callback for job creation
731 ei_job_deletion_callback_url:
733 description: callback for job deletion
734 ei_producer_supervision_callback_url:
736 description: callback for producer supervision
739 description: Supported EI types
741 $ref: '#/definitions/producer_ei_type_registration_info'
742 title: producer_registration_info
743 description: Information for an EI producer
752 Operational state, values:
758 title: producer_status
759 description: Status for an EI Producer
763 description: Void/empty