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: Query EI type identifiers
21 description: DETAILS TBD
22 operationId: getEiTypeIdentifiersUsingGET
27 description: EI type identifiers
33 description: Unauthorized
35 description: Forbidden
37 description: Not Found
39 '/A1-EI/v1/eitypes/{eiTypeId}':
42 - A1-E Enrichment Data Consumer API
43 summary: Definitions for an individual EI Type
44 description: Query EI type
45 operationId: getEiTypeUsingGET
58 $ref: '#/definitions/ei_type_info'
60 description: Unauthorized
62 description: Forbidden
64 description: Enrichment Information type is not found
66 $ref: '#/definitions/error_information'
68 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs':
71 - A1-E Enrichment Data Consumer API
72 summary: Query EI job identifiers
73 description: Returns the identifiers for an EI Type
74 operationId: getEiJobIdsUsingGET
85 description: identifies the owner of the job
97 description: Unauthorized
99 description: Forbidden
101 description: Enrichment Information type is not found
103 $ref: '#/definitions/error_information'
105 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}':
108 - A1-E Enrichment Data Consumer API
109 summary: Individual EI Job
110 operationId: getIndividualEiJobUsingGET
121 description: eiTypeId
128 $ref: '#/definitions/ei_job_info'
130 description: Unauthorized
132 description: Forbidden
134 description: Enrichment Information type or job is not found
136 $ref: '#/definitions/error_information'
140 - A1-E Enrichment Data Consumer API
141 summary: Individual EI Job
142 description: Create or update an EI Job
143 operationId: putIndividualEiJobUsingPUT
156 description: eiJobInfo
159 $ref: '#/definitions/ei_job_info'
162 description: eiTypeId
167 description: Job updated
171 description: Job created
175 description: Unauthorized
177 description: Forbidden
179 description: Enrichment Information type is not found
181 $ref: '#/definitions/error_information'
185 - A1-E Enrichment Data Consumer API
186 summary: Individual EI Job
187 description: Delete an EI job
188 operationId: deleteIndividualEiJobUsingDELETE
199 description: eiTypeId
204 description: Not used
208 description: Job deleted
212 description: Unauthorized
214 description: Forbidden
216 description: Enrichment Information type or job is not found
218 $ref: '#/definitions/error_information'
220 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status':
223 - A1-E Enrichment Data Consumer API
224 summary: EI Job status
225 operationId: getEiJobStatusUsingGET
236 description: eiTypeId
241 description: EI Job status
243 $ref: '#/definitions/ei_job_status'
245 description: Unauthorized
247 description: Forbidden
249 description: Enrichment Information type or job is not found
251 $ref: '#/definitions/error_information'
253 /ei-producer/v1/eiproducers:
256 - Enrichment Data Producer API
257 summary: Query EI producer identifiers
258 description: DETAILS TBD
259 operationId: getEiProducerIdentifiersUsingGET
264 description: EI producer identifiers
270 description: Unauthorized
272 description: Forbidden
274 description: Not Found
276 '/ei-producer/v1/eiproducers/{eiProducerId}':
279 - Enrichment Data Producer API
280 summary: Job definition for an individual EI producer
281 description: Query EI jobs
282 operationId: getEiProducerUsingGET
288 description: eiProducerId
295 $ref: '#/definitions/producer_ei_type_info'
297 description: Unauthorized
299 description: Forbidden
301 description: Enrichment Information producer is not found
303 $ref: '#/definitions/error_information'
307 - Enrichment Data Producer API
308 summary: Definitions for an individual EI producer
309 description: Put EI producer
310 operationId: putEiProducerUsingPUT
318 description: eiProducerId
322 name: registrationInfo
323 description: registrationInfo
326 $ref: '#/definitions/producer_registration_info'
329 description: Producer updated
333 description: Producer created
337 description: Unauthorized
339 description: Forbidden
341 description: Not Found
345 - Enrichment Data Producer API
346 summary: Individual EI Producer
347 description: Delete an EI Producer
348 operationId: deleteEiProducerUsingDELETE
354 description: eiProducerId
359 description: Not used
363 description: Producer deleted
367 description: Unauthorized
369 description: Forbidden
371 description: Producer is not found
373 $ref: '#/definitions/error_information'
375 '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs':
378 - Enrichment Data Producer API
379 summary: Job definition for an individual EI producer
380 description: Query EI producer jobs
381 operationId: getEiProducerJobsUsingGET
387 description: eiProducerId
396 $ref: '#/definitions/producer_ei_job_request'
398 description: Unauthorized
400 description: Forbidden
402 description: Enrichment Information producer is not found
404 $ref: '#/definitions/error_information'
406 /ei-producer/v1/eitypes:
409 - Enrichment Data Producer API
410 summary: Query EI type identifiers
411 description: DETAILS TBD
412 operationId: getEiTypeIdentifiersUsingGET_1
417 description: EI type identifiers
423 description: Unauthorized
425 description: Forbidden
427 description: Not Found
429 '/ei-producer/v1/eitypes/{eiTypeId}':
432 - Enrichment Data Producer API
433 summary: Definitions for an individual EI Type
434 description: Query EI type
435 operationId: getEiTypeUsingGET_1
441 description: eiTypeId
448 $ref: '#/definitions/producer_ei_type_info'
450 description: Unauthorized
452 description: Forbidden
454 description: Enrichment Information type is not found
456 $ref: '#/definitions/error_information'
458 /producer_simulator/job_created:
462 summary: Callback for job creation
463 operationId: jobCreatedCallbackUsingPOST
474 $ref: '#/definitions/producer_ei_job_request'
483 description: Unauthorized
485 description: Forbidden
487 description: Not Found
489 /producer_simulator/job_deleted:
493 summary: Callback for job deletion
494 operationId: jobDeletedCallbackUsingPOST
505 $ref: '#/definitions/producer_ei_job_request'
514 description: Unauthorized
516 description: Forbidden
518 description: Not Found
529 description: EI Type specific job data
532 description: Identity of the owner of the job
534 description: Information for a Enrichment Information Job
543 Operational state, values:
550 description: Status for an EI Job
556 description: Json schema for the job data
558 description: Information for an EI type
564 example: EI job type not found
565 description: ' A human-readable explanation specific to this occurrence of the problem.'
570 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. '
571 title: error_information
572 description: 'Problem as defined in https://tools.ietf.org/html/rfc7807'
573 producer_ei_job_request:
580 description: Json for the job data
583 description: Json for the job data
586 description: Type idenitity for the job
587 title: producer_ei_job_request
588 description: Information EI job start
589 producer_ei_type_info:
594 description: Json schema for the job data
597 description: Registered producers
600 title: producer_ei_type_info
601 description: Information for an EI type
602 producer_ei_type_registration_info:
609 description: EI type identity
612 description: Json schema for the job data
613 title: producer_ei_type_registration_info
614 description: Information for an EI type
615 producer_registration_info:
618 - job_creation_callback_url
619 - job_deletion_callback_url
622 job_creation_callback_url:
624 description: callback for job creation
625 job_deletion_callback_url:
627 description: callback for job deletion
630 description: Supported EI types
632 $ref: '#/definitions/producer_ei_type_registration_info'
633 title: producer_registration_info
634 description: Information for an EI Producer