4 "/producer_simulator/job_deleted_error": {"post": {
5 "summary": "Callback for EI job creation, returns error",
7 "produces": ["application/json"],
8 "operationId": "jobDeletedCallbackReturnErrorUsingPOST",
10 "200": {"description": "OK"},
11 "201": {"description": "Created"},
12 "401": {"description": "Unauthorized"},
13 "403": {"description": "Forbidden"},
14 "404": {"description": "Not Found"}
17 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
20 "description": "request",
23 "tags": ["Producer Simulator"],
24 "consumes": ["application/json"]
26 "/producer_simulator/supervision": {"get": {
27 "summary": "Producer supervision",
29 "produces": ["application/json"],
30 "operationId": "producerSupervisionUsingGET",
33 "schema": {"type": "string"},
36 "401": {"description": "Unauthorized"},
37 "403": {"description": "Forbidden"},
38 "404": {"description": "Not Found"}
40 "tags": ["Producer Simulator"]
42 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs": {"get": {
43 "summary": "EI job identifiers",
45 "produces": ["application/json"],
46 "operationId": "getEiJobIdsUsingGET",
51 "items": {"type": "string"}
53 "description": "EI job identifiers"
55 "401": {"description": "Unauthorized"},
56 "403": {"description": "Forbidden"},
58 "schema": {"$ref": "#/definitions/error_information"},
59 "description": "Enrichment Information type is not found"
66 "description": "eiTypeId",
71 "schema": {"type": "string"},
74 "description": "identifies the owner of the job",
78 "tags": ["A1-E Enrichment Data Consumer API"]
80 "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
81 "summary": "Individual EI type",
83 "produces": ["application/json"],
84 "operationId": "getEiTypeUsingGET",
87 "schema": {"$ref": "#/definitions/EiType"},
88 "description": "EI type"
90 "401": {"description": "Unauthorized"},
91 "403": {"description": "Forbidden"},
93 "schema": {"$ref": "#/definitions/error_information"},
94 "description": "Enrichment Information type is not found"
100 "description": "eiTypeId",
104 "tags": ["A1-E Enrichment Data Consumer API"]
106 "/ei-producer/v1/eitypes": {"get": {
107 "summary": "EI type identifiers",
109 "produces": ["application/json"],
110 "operationId": "getEiTypeIdentifiersUsingGET_1",
115 "items": {"type": "string"}
117 "description": "EI type identifiers"
119 "401": {"description": "Unauthorized"},
120 "403": {"description": "Forbidden"},
121 "404": {"description": "Not Found"}
123 "tags": ["Enrichment Data Producer API"]
125 "/A1-EI/v1/eitypes": {"get": {
126 "summary": "EI type identifiers",
128 "produces": ["application/json"],
129 "operationId": "getEiTypeIdentifiersUsingGET",
134 "items": {"type": "string"}
136 "description": "EI type identifiers"
138 "401": {"description": "Unauthorized"},
139 "403": {"description": "Forbidden"},
140 "404": {"description": "Not Found"}
142 "tags": ["A1-E Enrichment Data Consumer API"]
144 "/producer_simulator/job_deleted": {"post": {
145 "summary": "Callback for EI job deletion",
147 "produces": ["application/json"],
148 "operationId": "jobDeletedCallbackUsingPOST",
150 "200": {"description": "OK"},
151 "201": {"description": "Created"},
152 "401": {"description": "Unauthorized"},
153 "403": {"description": "Forbidden"},
154 "404": {"description": "Not Found"}
157 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
160 "description": "request",
163 "tags": ["Producer Simulator"],
164 "consumes": ["application/json"]
166 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status": {"get": {
167 "summary": "EI Job status",
169 "produces": ["application/json"],
170 "operationId": "getEiJobStatusUsingGET",
173 "schema": {"$ref": "#/definitions/EiJobStatus"},
174 "description": "EI Job status"
176 "401": {"description": "Unauthorized"},
177 "403": {"description": "Forbidden"},
179 "schema": {"$ref": "#/definitions/error_information"},
180 "description": "Enrichment Information type or job is not found"
187 "description": "eiJobId",
194 "description": "eiTypeId",
199 "tags": ["A1-E Enrichment Data Consumer API"]
201 "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
202 "summary": "EI producer status",
204 "produces": ["application/json"],
205 "operationId": "getEiProducerStatusUsingGET",
208 "schema": {"$ref": "#/definitions/producer_status"},
209 "description": "EI jobs"
211 "401": {"description": "Unauthorized"},
212 "403": {"description": "Forbidden"},
214 "schema": {"$ref": "#/definitions/error_information"},
215 "description": "Enrichment Information producer is not found"
220 "name": "eiProducerId",
221 "description": "eiProducerId",
225 "tags": ["Enrichment Data Producer API"]
227 "/producer_simulator/supervision_error": {"get": {
228 "summary": "Producer supervision error",
230 "produces": ["application/json"],
231 "operationId": "producerSupervisionErrorUsingGET",
234 "schema": {"type": "string"},
237 "401": {"description": "Unauthorized"},
238 "403": {"description": "Forbidden"},
239 "404": {"description": "Not Found"}
241 "tags": ["Producer Simulator"]
243 "/ei-producer/v1/eiproducers": {"get": {
244 "summary": "EI producer identifiers",
246 "produces": ["application/json"],
247 "operationId": "getEiProducerIdentifiersUsingGET",
252 "items": {"type": "string"}
254 "description": "EI producer identifiers"
256 "401": {"description": "Unauthorized"},
257 "403": {"description": "Forbidden"},
258 "404": {"description": "Not Found"}
260 "tags": ["Enrichment Data Producer API"]
262 "/ei-producer/v1/eitypes/{eiTypeId}": {"get": {
263 "summary": "Individual EI Type",
265 "produces": ["application/json"],
266 "operationId": "getEiTypeUsingGET_1",
269 "schema": {"$ref": "#/definitions/producer_ei_type_info"},
270 "description": "EI type"
272 "401": {"description": "Unauthorized"},
273 "403": {"description": "Forbidden"},
275 "schema": {"$ref": "#/definitions/error_information"},
276 "description": "Enrichment Information type is not found"
282 "description": "eiTypeId",
286 "tags": ["Enrichment Data Producer API"]
288 "/producer_simulator/job_created_error": {"post": {
289 "summary": "Callback for EI job creation, returns error",
291 "produces": ["application/json"],
292 "operationId": "jobCreatedCallbackReturnErrorUsingPOST",
294 "200": {"description": "OK"},
295 "201": {"description": "Created"},
296 "401": {"description": "Unauthorized"},
297 "403": {"description": "Forbidden"},
298 "404": {"description": "Not Found"}
301 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
304 "description": "request",
307 "tags": ["Producer Simulator"],
308 "consumes": ["application/json"]
310 "/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}": {
312 "summary": "Individual EI Job",
314 "produces": ["application/json"],
315 "operationId": "getIndividualEiJobUsingGET",
318 "schema": {"$ref": "#/definitions/EiJob"},
319 "description": "EI Job"
321 "401": {"description": "Unauthorized"},
322 "403": {"description": "Forbidden"},
324 "schema": {"$ref": "#/definitions/error_information"},
325 "description": "Enrichment Information type or job is not found"
332 "description": "eiJobId",
339 "description": "eiTypeId",
344 "tags": ["A1-E Enrichment Data Consumer API"]
347 "summary": "Individual EI Job",
349 "produces": ["application/json"],
350 "operationId": "deleteIndividualEiJobUsingDELETE",
352 "200": {"description": "Not used"},
353 "401": {"description": "Unauthorized"},
354 "204": {"description": "Job deleted"},
355 "403": {"description": "Forbidden"},
357 "schema": {"$ref": "#/definitions/error_information"},
358 "description": "Enrichment Information type or job is not found"
365 "description": "eiJobId",
372 "description": "eiTypeId",
377 "tags": ["A1-E Enrichment Data Consumer API"]
380 "summary": "Individual EI Job",
382 "produces": ["application/json"],
383 "operationId": "putIndividualEiJobUsingPUT",
385 "200": {"description": "Job updated"},
386 "201": {"description": "Job created"},
387 "401": {"description": "Unauthorized"},
388 "403": {"description": "Forbidden"},
390 "schema": {"$ref": "#/definitions/error_information"},
391 "description": "Enrichment Information type is not found"
398 "description": "eiJobId",
403 "schema": {"$ref": "#/definitions/EiJob"},
406 "description": "eiJobInfo",
412 "description": "eiTypeId",
417 "tags": ["A1-E Enrichment Data Consumer API"],
418 "consumes": ["application/json"]
421 "/ei-producer/v1/eiproducers/{eiProducerId}": {
423 "summary": "Individual EI producer",
425 "produces": ["application/json"],
426 "operationId": "getEiProducerUsingGET",
429 "schema": {"$ref": "#/definitions/producer_registration_info"},
430 "description": "EI Jobs"
432 "401": {"description": "Unauthorized"},
433 "403": {"description": "Forbidden"},
435 "schema": {"$ref": "#/definitions/error_information"},
436 "description": "Enrichment Information producer is not found"
441 "name": "eiProducerId",
442 "description": "eiProducerId",
446 "tags": ["Enrichment Data Producer API"]
449 "summary": "Individual EI producer",
451 "produces": ["application/json"],
452 "operationId": "deleteEiProducerUsingDELETE",
454 "200": {"description": "Not used"},
455 "401": {"description": "Unauthorized"},
456 "204": {"description": "Producer deleted"},
457 "403": {"description": "Forbidden"},
459 "schema": {"$ref": "#/definitions/error_information"},
460 "description": "Producer is not found"
465 "name": "eiProducerId",
466 "description": "eiProducerId",
470 "tags": ["Enrichment Data Producer API"]
473 "summary": "Individual EI producer",
475 "produces": ["application/json"],
476 "operationId": "putEiProducerUsingPUT",
478 "200": {"description": "Producer updated"},
479 "201": {"description": "Producer created"},
480 "401": {"description": "Unauthorized"},
481 "403": {"description": "Forbidden"},
482 "404": {"description": "Not Found"}
487 "name": "eiProducerId",
488 "description": "eiProducerId",
493 "schema": {"$ref": "#/definitions/producer_registration_info"},
495 "name": "registrationInfo",
496 "description": "registrationInfo",
500 "tags": ["Enrichment Data Producer API"],
501 "consumes": ["application/json"]
504 "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
505 "summary": "EI job definitions",
507 "produces": ["application/json"],
508 "description": "EI job definitions for one EI producer",
509 "operationId": "getEiProducerJobsUsingGET",
514 "items": {"$ref": "#/definitions/producer_ei_job_request"}
516 "description": "EI jobs"
518 "401": {"description": "Unauthorized"},
519 "403": {"description": "Forbidden"},
521 "schema": {"$ref": "#/definitions/error_information"},
522 "description": "Enrichment Information producer is not found"
527 "name": "eiProducerId",
528 "description": "eiProducerId",
532 "tags": ["Enrichment Data Producer API"]
534 "/producer_simulator/job_created": {"post": {
535 "summary": "Callback for EI job creation",
537 "produces": ["application/json"],
538 "operationId": "jobCreatedCallbackUsingPOST",
540 "200": {"description": "OK"},
541 "201": {"description": "Created"},
542 "401": {"description": "Unauthorized"},
543 "403": {"description": "Forbidden"},
544 "404": {"description": "Not Found"}
547 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
550 "description": "request",
553 "tags": ["Producer Simulator"],
554 "consumes": ["application/json"]
557 "host": "localhost:43453",
560 "description": "Information for an EI type",
563 "properties": {"eiJobParametersSchema": {
564 "description": "Json schema for the job data",
568 "producer_ei_job_request": {
569 "description": "The body of the EI producer callbacks for EI job creation and deletion",
571 "title": "producer_ei_job_request",
572 "required": ["ei_job_identity"],
575 "description": "Idenitity of the EI job",
579 "description": "Json for the job data",
583 "description": "URI for the target of the EI",
586 "ei_type_identity": {
587 "description": "Type idenitity for the job",
592 "error_information": {
593 "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
595 "title": "error_information",
598 "description": "A human-readable explanation specific to this occurrence of the problem.",
600 "example": "EI job type not found"
604 "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
611 "description": "Void/empty",
616 "description": "Information for an Enrichment Information Job",
626 "description": "The target of the EI data",
630 "description": "Identity of the owner of the job",
634 "description": "EI Type specific job data",
639 "producer_ei_type_registration_info": {
640 "description": "Information for an EI type",
642 "title": "producer_ei_type_registration_info",
643 "required": ["ei_type_identity"],
645 "ei_type_identity": {
646 "description": "EI type identity",
649 "ei_job_data_schema": {
650 "description": "Json schema for the job data",
656 "description": "Status for an EI Job",
658 "title": "EiJobStatus",
659 "required": ["operationalState"],
660 "properties": {"operationalState": {
661 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
669 "Mono«ResponseEntity«object»»": {
671 "title": "Mono«ResponseEntity«object»»"
673 "producer_ei_type_info": {
674 "description": "Information for an EI type",
676 "title": "producer_ei_type_info",
679 "description": "Registered producers",
681 "items": {"type": "string"}
683 "ei_job_data_schema": {
684 "description": "Json schema for the job data",
689 "producer_registration_info": {
690 "description": "Information for an EI producer",
692 "title": "producer_registration_info",
694 "ei_job_creation_callback_url",
695 "ei_job_deletion_callback_url",
696 "ei_producer_supervision_callback_url",
700 "supported_ei_types": {
701 "description": "Supported EI types",
703 "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
705 "ei_job_creation_callback_url": {
706 "description": "callback for job creation",
709 "ei_job_deletion_callback_url": {
710 "description": "callback for job deletion",
713 "ei_producer_supervision_callback_url": {
714 "description": "callback for producer supervision",
720 "description": "Status for an EI Producer",
722 "title": "producer_status",
723 "required": ["operational_state"],
724 "properties": {"operational_state": {
725 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
736 "description": "This page lists all the rest apis for the service.",
737 "title": "Enrichment Data service",
742 "name": "A1-E Enrichment Data Consumer API",
743 "description": "Consumer Controller"
746 "name": "Enrichment Data Producer API",
747 "description": "Producer Controller"
750 "name": "Producer Simulator",
751 "description": "Producer Simulator Controller"