enrichment-coordinator-service/api/ecs-api.json

   1 {
   2     "basePath": "/",
   3     "paths": {
   4         "/producer_simulator/ei_job": {"post": {
   5             "summary": "Callback for EI job creation",
   6             "deprecated": false,
   7             "produces": ["application/json"],
   8             "operationId": "jobCreatedCallbackUsingPOST",
   9             "responses": {
  10                 "200": {"description": "OK"},
  11                 "201": {"description": "Created"},
  12                 "401": {"description": "Unauthorized"},
  13                 "403": {"description": "Forbidden"},
  14                 "404": {"description": "Not Found"}
  15             },
  16             "parameters": [{
  17                 "schema": {"$ref": "#/definitions/producer_ei_job_request"},
  18                 "in": "body",
  19                 "name": "request",
  20                 "description": "request",
  21                 "required": true
  22             }],
  23             "tags": ["Data Producer Job Control (example producer)"],
  24             "consumes": ["application/json"]
  25         }},
  26         "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
  27             "summary": "Individual EI type",
  28             "deprecated": false,
  29             "produces": ["application/json"],
  30             "operationId": "getEiTypeUsingGET",
  31             "responses": {
  32                 "200": {
  33                     "schema": {"$ref": "#/definitions/EiTypeObject"},
  34                     "description": "EI type"
  35                 },
  36                 "401": {"description": "Unauthorized"},
  37                 "403": {"description": "Forbidden"},
  38                 "404": {
  39                     "schema": {"$ref": "#/definitions/ProblemDetails"},
  40                     "description": "Enrichment Information type is not found"
  41                 }
  42             },
  43             "parameters": [{
  44                 "in": "path",
  45                 "name": "eiTypeId",
  46                 "description": "eiTypeId",
  47                 "type": "string",
  48                 "required": true
  49             }],
  50             "tags": ["A1-EI (enrichment information)"]
  51         }},
  52         "/consumer_simulator/eijobs/{eiJobId}/status": {"post": {
  53             "summary": "Callback for EI job status",
  54             "deprecated": false,
  55             "produces": ["application/json"],
  56             "operationId": "jobStatusCallbackUsingPOST",
  57             "responses": {
  58                 "200": {"description": "OK"},
  59                 "201": {"description": "Created"},
  60                 "401": {"description": "Unauthorized"},
  61                 "403": {"description": "Forbidden"},
  62                 "404": {"description": "Not Found"}
  63             },
  64             "parameters": [
  65                 {
  66                     "in": "path",
  67                     "name": "eiJobId",
  68                     "description": "eiJobId",
  69                     "type": "string",
  70                     "required": true
  71                 },
  72                 {
  73                     "schema": {"$ref": "#/definitions/EiJobStatusObject"},
  74                     "in": "body",
  75                     "name": "status",
  76                     "description": "status",
  77                     "required": true
  78                 }
  79             ],
  80             "tags": ["A1-EI (enrichment information) callbacks"],
  81             "consumes": ["application/json"]
  82         }},
  83         "/ei-producer/v1/eitypes": {"get": {
  84             "summary": "EI type identifiers",
  85             "deprecated": false,
  86             "produces": ["application/json"],
  87             "operationId": "getEiTypeIdentifiersUsingGET_1",
  88             "responses": {
  89                 "200": {
  90                     "schema": {
  91                         "type": "array",
  92                         "items": {"type": "string"}
  93                     },
  94                     "description": "EI type identifiers"
  95                 },
  96                 "401": {"description": "Unauthorized"},
  97                 "403": {"description": "Forbidden"},
  98                 "404": {"description": "Not Found"}
  99             },
 100             "tags": ["Data Producer Registry API"]
 101         }},
 102         "/A1-EI/v1/eitypes": {"get": {
 103             "summary": "EI type identifiers",
 104             "deprecated": false,
 105             "produces": ["application/json"],
 106             "operationId": "getEiTypeIdentifiersUsingGET",
 107             "responses": {
 108                 "200": {
 109                     "schema": {
 110                         "type": "array",
 111                         "items": {"type": "string"}
 112                     },
 113                     "description": "EI type identifiers"
 114                 },
 115                 "401": {"description": "Unauthorized"},
 116                 "403": {"description": "Forbidden"},
 117                 "404": {"description": "Not Found"}
 118             },
 119             "tags": ["A1-EI (enrichment information)"]
 120         }},
 121         "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
 122             "summary": "EI producer status",
 123             "deprecated": false,
 124             "produces": ["application/json"],
 125             "operationId": "getEiProducerStatusUsingGET",
 126             "responses": {
 127                 "200": {
 128                     "schema": {"$ref": "#/definitions/producer_status"},
 129                     "description": "EI producer status"
 130                 },
 131                 "401": {"description": "Unauthorized"},
 132                 "403": {"description": "Forbidden"},
 133                 "404": {
 134                     "schema": {"$ref": "#/definitions/ProblemDetails"},
 135                     "description": "Enrichment Information producer is not found"
 136                 }
 137             },
 138             "parameters": [{
 139                 "in": "path",
 140                 "name": "eiProducerId",
 141                 "description": "eiProducerId",
 142                 "type": "string",
 143                 "required": true
 144             }],
 145             "tags": ["Data Producer Registry API"]
 146         }},
 147         "/producer_simulator/ei_job/{eiJobId}": {"delete": {
 148             "summary": "Callback for EI job deletion",
 149             "deprecated": false,
 150             "produces": ["application/json"],
 151             "operationId": "jobDeletedCallbackUsingDELETE",
 152             "responses": {
 153                 "200": {"description": "OK"},
 154                 "401": {"description": "Unauthorized"},
 155                 "204": {"description": "No Content"},
 156                 "403": {"description": "Forbidden"}
 157             },
 158             "parameters": [{
 159                 "in": "path",
 160                 "name": "eiJobId",
 161                 "description": "eiJobId",
 162                 "type": "string",
 163                 "required": true
 164             }],
 165             "tags": ["Data Producer Job Control (example producer)"]
 166         }},
 167         "/ei-producer/v1/eiproducers": {"get": {
 168             "summary": "EI producer identifiers",
 169             "deprecated": false,
 170             "produces": ["application/json"],
 171             "operationId": "getEiProducerIdentifiersUsingGET",
 172             "responses": {
 173                 "200": {
 174                     "schema": {
 175                         "type": "array",
 176                         "items": {"type": "string"}
 177                     },
 178                     "description": "EI producer identifiers"
 179                 },
 180                 "401": {"description": "Unauthorized"},
 181                 "403": {"description": "Forbidden"},
 182                 "404": {"description": "Not Found"}
 183             },
 184             "parameters": [{
 185                 "in": "query",
 186                 "allowEmptyValue": false,
 187                 "name": "ei_type_id",
 188                 "description": "If given, only the producers for the EI Data type is returned.",
 189                 "type": "string",
 190                 "required": false
 191             }],
 192             "tags": ["Data Producer Registry API"]
 193         }},
 194         "/ei-producer/v1/eitypes/{eiTypeId}": {
 195             "get": {
 196                 "summary": "Individual EI type",
 197                 "deprecated": false,
 198                 "produces": ["application/json"],
 199                 "operationId": "getEiTypeUsingGET_1",
 200                 "responses": {
 201                     "200": {
 202                         "schema": {"$ref": "#/definitions/producer_ei_type_info"},
 203                         "description": "EI type"
 204                     },
 205                     "401": {"description": "Unauthorized"},
 206                     "403": {"description": "Forbidden"},
 207                     "404": {
 208                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 209                         "description": "Enrichment Information type is not found"
 210                     }
 211                 },
 212                 "parameters": [{
 213                     "in": "path",
 214                     "name": "eiTypeId",
 215                     "description": "eiTypeId",
 216                     "type": "string",
 217                     "required": true
 218                 }],
 219                 "tags": ["Data Producer Registry API"]
 220             },
 221             "delete": {
 222                 "summary": "Individual EI type",
 223                 "deprecated": false,
 224                 "produces": ["application/json"],
 225                 "operationId": "deleteEiTypeUsingDELETE",
 226                 "responses": {
 227                     "200": {"description": "Not used"},
 228                     "401": {"description": "Unauthorized"},
 229                     "204": {"description": "Producer deleted"},
 230                     "403": {"description": "Forbidden"},
 231                     "404": {
 232                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 233                         "description": "Enrichment Information type is not found"
 234                     },
 235                     "406": {
 236                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 237                         "description": "The Enrichment Information type has one or several active producers"
 238                     }
 239                 },
 240                 "parameters": [{
 241                     "in": "path",
 242                     "name": "eiTypeId",
 243                     "description": "eiTypeId",
 244                     "type": "string",
 245                     "required": true
 246                 }],
 247                 "tags": ["Data Producer Registry API"]
 248             },
 249             "put": {
 250                 "summary": "Individual EI type",
 251                 "deprecated": false,
 252                 "produces": ["application/json"],
 253                 "operationId": "putEiTypeUsingPUT",
 254                 "responses": {
 255                     "200": {"description": "Type updated"},
 256                     "201": {"description": "Type created"},
 257                     "400": {
 258                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 259                         "description": "Bad request"
 260                     },
 261                     "401": {"description": "Unauthorized"},
 262                     "403": {"description": "Forbidden"},
 263                     "404": {"description": "Not Found"}
 264                 },
 265                 "parameters": [
 266                     {
 267                         "in": "path",
 268                         "name": "eiTypeId",
 269                         "description": "eiTypeId",
 270                         "type": "string",
 271                         "required": true
 272                     },
 273                     {
 274                         "schema": {"$ref": "#/definitions/producer_ei_type_info"},
 275                         "in": "body",
 276                         "name": "registrationInfo",
 277                         "description": "registrationInfo",
 278                         "required": true
 279                     }
 280                 ],
 281                 "tags": ["Data Producer Registry API"],
 282                 "consumes": ["application/json"]
 283             }
 284         },
 285         "/status": {"get": {
 286             "summary": "Returns status and statistics of this service",
 287             "deprecated": false,
 288             "produces": ["application/json"],
 289             "operationId": "getStatusUsingGET",
 290             "responses": {
 291                 "200": {
 292                     "schema": {"$ref": "#/definitions/status_info"},
 293                     "description": "Service is living"
 294                 },
 295                 "401": {"description": "Unauthorized"},
 296                 "403": {"description": "Forbidden"},
 297                 "404": {"description": "Not Found"}
 298             },
 299             "tags": ["Service status"]
 300         }},
 301         "/A1-EI/v1/eijobs/{eiJobId}": {
 302             "get": {
 303                 "summary": "Individual EI job",
 304                 "deprecated": false,
 305                 "produces": ["application/json"],
 306                 "operationId": "getIndividualEiJobUsingGET",
 307                 "responses": {
 308                     "200": {
 309                         "schema": {"$ref": "#/definitions/EiJobObject"},
 310                         "description": "EI job"
 311                     },
 312                     "401": {"description": "Unauthorized"},
 313                     "403": {"description": "Forbidden"},
 314                     "404": {
 315                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 316                         "description": "Enrichment Information job is not found"
 317                     }
 318                 },
 319                 "parameters": [{
 320                     "in": "path",
 321                     "name": "eiJobId",
 322                     "description": "eiJobId",
 323                     "type": "string",
 324                     "required": true
 325                 }],
 326                 "tags": ["A1-EI (enrichment information)"]
 327             },
 328             "delete": {
 329                 "summary": "Individual EI job",
 330                 "deprecated": false,
 331                 "produces": ["application/json"],
 332                 "operationId": "deleteIndividualEiJobUsingDELETE",
 333                 "responses": {
 334                     "200": {"description": "Not used"},
 335                     "401": {"description": "Unauthorized"},
 336                     "204": {"description": "Job deleted"},
 337                     "403": {"description": "Forbidden"},
 338                     "404": {
 339                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 340                         "description": "Enrichment Information job is not found"
 341                     }
 342                 },
 343                 "parameters": [{
 344                     "in": "path",
 345                     "name": "eiJobId",
 346                     "description": "eiJobId",
 347                     "type": "string",
 348                     "required": true
 349                 }],
 350                 "tags": ["A1-EI (enrichment information)"]
 351             },
 352             "put": {
 353                 "summary": "Individual EI job",
 354                 "deprecated": false,
 355                 "produces": ["application/json"],
 356                 "operationId": "putIndividualEiJobUsingPUT",
 357                 "responses": {
 358                     "200": {"description": "Job updated"},
 359                     "201": {"description": "Job created"},
 360                     "401": {"description": "Unauthorized"},
 361                     "403": {"description": "Forbidden"},
 362                     "404": {
 363                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 364                         "description": "Enrichment Information type is not found"
 365                     }
 366                 },
 367                 "parameters": [
 368                     {
 369                         "in": "path",
 370                         "name": "eiJobId",
 371                         "description": "eiJobId",
 372                         "type": "string",
 373                         "required": true
 374                     },
 375                     {
 376                         "schema": {"$ref": "#/definitions/EiJobObject"},
 377                         "in": "body",
 378                         "name": "eiJobObject",
 379                         "description": "eiJobObject",
 380                         "required": true
 381                     }
 382                 ],
 383                 "tags": ["A1-EI (enrichment information)"],
 384                 "consumes": ["application/json"]
 385             }
 386         },
 387         "/ei-producer/v1/eiproducers/{eiProducerId}": {
 388             "get": {
 389                 "summary": "Individual EI producer",
 390                 "deprecated": false,
 391                 "produces": ["application/json"],
 392                 "operationId": "getEiProducerUsingGET",
 393                 "responses": {
 394                     "200": {
 395                         "schema": {"$ref": "#/definitions/producer_registration_info"},
 396                         "description": "EI producer"
 397                     },
 398                     "401": {"description": "Unauthorized"},
 399                     "403": {"description": "Forbidden"},
 400                     "404": {
 401                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 402                         "description": "Enrichment Information producer is not found"
 403                     }
 404                 },
 405                 "parameters": [{
 406                     "in": "path",
 407                     "name": "eiProducerId",
 408                     "description": "eiProducerId",
 409                     "type": "string",
 410                     "required": true
 411                 }],
 412                 "tags": ["Data Producer Registry API"]
 413             },
 414             "delete": {
 415                 "summary": "Individual EI producer",
 416                 "deprecated": false,
 417                 "produces": ["application/json"],
 418                 "operationId": "deleteEiProducerUsingDELETE",
 419                 "responses": {
 420                     "200": {"description": "Not used"},
 421                     "401": {"description": "Unauthorized"},
 422                     "204": {"description": "Producer deleted"},
 423                     "403": {"description": "Forbidden"},
 424                     "404": {
 425                         "schema": {"$ref": "#/definitions/ProblemDetails"},
 426                         "description": "Producer is not found"
 427                     }
 428                 },
 429                 "parameters": [{
 430                     "in": "path",
 431                     "name": "eiProducerId",
 432                     "description": "eiProducerId",
 433                     "type": "string",
 434                     "required": true
 435                 }],
 436                 "tags": ["Data Producer Registry API"]
 437             },
 438             "put": {
 439                 "summary": "Individual EI producer",
 440                 "deprecated": false,
 441                 "produces": ["application/json"],
 442                 "operationId": "putEiProducerUsingPUT",
 443                 "responses": {
 444                     "200": {"description": "Producer updated"},
 445                     "201": {"description": "Producer created"},
 446                     "401": {"description": "Unauthorized"},
 447                     "403": {"description": "Forbidden"},
 448                     "404": {"description": "Not Found"}
 449                 },
 450                 "parameters": [
 451                     {
 452                         "in": "path",
 453                         "name": "eiProducerId",
 454                         "description": "eiProducerId",
 455                         "type": "string",
 456                         "required": true
 457                     },
 458                     {
 459                         "schema": {"$ref": "#/definitions/producer_registration_info"},
 460                         "in": "body",
 461                         "name": "registrationInfo",
 462                         "description": "registrationInfo",
 463                         "required": true
 464                     }
 465                 ],
 466                 "tags": ["Data Producer Registry API"],
 467                 "consumes": ["application/json"]
 468             }
 469         },
 470         "/producer_simulator/health_check": {"get": {
 471             "summary": "Producer supervision",
 472             "deprecated": false,
 473             "produces": ["application/json"],
 474             "operationId": "producerSupervisionUsingGET",
 475             "responses": {
 476                 "200": {
 477                     "schema": {"type": "string"},
 478                     "description": "OK"
 479                 },
 480                 "401": {"description": "Unauthorized"},
 481                 "403": {"description": "Forbidden"},
 482                 "404": {"description": "Not Found"}
 483             },
 484             "tags": ["Data Producer Job Control (example producer)"]
 485         }},
 486         "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
 487             "summary": "EI job definitions",
 488             "deprecated": false,
 489             "produces": ["application/json"],
 490             "description": "EI job definitions for one EI producer",
 491             "operationId": "getEiProducerJobsUsingGET",
 492             "responses": {
 493                 "200": {
 494                     "schema": {
 495                         "type": "array",
 496                         "items": {"$ref": "#/definitions/producer_ei_job_request"}
 497                     },
 498                     "description": "EI producer"
 499                 },
 500                 "401": {"description": "Unauthorized"},
 501                 "403": {"description": "Forbidden"},
 502                 "404": {
 503                     "schema": {"$ref": "#/definitions/ProblemDetails"},
 504                     "description": "Enrichment Information producer is not found"
 505                 }
 506             },
 507             "parameters": [{
 508                 "in": "path",
 509                 "name": "eiProducerId",
 510                 "description": "eiProducerId",
 511                 "type": "string",
 512                 "required": true
 513             }],
 514             "tags": ["Data Producer Registry API"]
 515         }},
 516         "/A1-EI/v1/eijobs": {"get": {
 517             "summary": "EI job identifiers",
 518             "deprecated": false,
 519             "produces": ["application/json"],
 520             "description": "query for EI job identifiers",
 521             "operationId": "getEiJobIdsUsingGET",
 522             "responses": {
 523                 "200": {
 524                     "schema": {
 525                         "type": "array",
 526                         "items": {"type": "string"}
 527                     },
 528                     "description": "EI job identifiers"
 529                 },
 530                 "401": {"description": "Unauthorized"},
 531                 "403": {"description": "Forbidden"},
 532                 "404": {
 533                     "schema": {"$ref": "#/definitions/ProblemDetails"},
 534                     "description": "Enrichment Information type is not found"
 535                 }
 536             },
 537             "parameters": [
 538                 {
 539                     "in": "query",
 540                     "allowEmptyValue": false,
 541                     "name": "eiTypeId",
 542                     "description": "selects EI jobs of matching EI type",
 543                     "type": "string",
 544                     "required": false
 545                 },
 546                 {
 547                     "in": "query",
 548                     "allowEmptyValue": false,
 549                     "name": "owner",
 550                     "description": "selects EI jobs for one EI job owner",
 551                     "type": "string",
 552                     "required": false
 553                 }
 554             ],
 555             "tags": ["A1-EI (enrichment information)"]
 556         }},
 557         "/A1-EI/v1/eijobs/{eiJobId}/status": {"get": {
 558             "summary": "EI job status",
 559             "deprecated": false,
 560             "produces": ["application/json"],
 561             "operationId": "getEiJobStatusUsingGET",
 562             "responses": {
 563                 "200": {
 564                     "schema": {"$ref": "#/definitions/EiJobStatusObject"},
 565                     "description": "EI job status"
 566                 },
 567                 "401": {"description": "Unauthorized"},
 568                 "403": {"description": "Forbidden"},
 569                 "404": {
 570                     "schema": {"$ref": "#/definitions/ProblemDetails"},
 571                     "description": "Enrichment Information job is not found"
 572                 }
 573             },
 574             "parameters": [{
 575                 "in": "path",
 576                 "name": "eiJobId",
 577                 "description": "eiJobId",
 578                 "type": "string",
 579                 "required": true
 580             }],
 581             "tags": ["A1-EI (enrichment information)"]
 582         }}
 583     },
 584     "definitions": {
 585         "producer_ei_job_request": {
 586             "description": "The body of the EI producer callbacks for EI job creation and deletion",
 587             "type": "object",
 588             "title": "producer_ei_job_request",
 589             "required": ["ei_job_identity"],
 590             "properties": {
 591                 "owner": {
 592                     "description": "The owner of the job",
 593                     "type": "string"
 594                 },
 595                 "ei_job_identity": {
 596                     "description": "Idenitity of the EI job",
 597                     "type": "string"
 598                 },
 599                 "last_updated": {
 600                     "description": "The time when the job was last updated or created (ISO-8601)",
 601                     "type": "string"
 602                 },
 603                 "ei_job_data": {
 604                     "description": "Json for the job data",
 605                     "type": "object"
 606                 },
 607                 "target_uri": {
 608                     "description": "URI for the target of the EI",
 609                     "type": "string"
 610                 },
 611                 "ei_type_identity": {
 612                     "description": "Type idenitity for the job",
 613                     "type": "string"
 614                 }
 615             }
 616         },
 617         "EiTypeObject": {
 618             "description": "Information for an EI type",
 619             "type": "object",
 620             "title": "EiTypeObject"
 621         },
 622         "status_info": {
 623             "type": "object",
 624             "title": "status_info",
 625             "properties": {
 626                 "no_of_producers": {
 627                     "format": "int32",
 628                     "description": "Number of EI producers",
 629                     "type": "integer"
 630                 },
 631                 "no_of_jobs": {
 632                     "format": "int32",
 633                     "description": "Number of EI jobs",
 634                     "type": "integer"
 635                 },
 636                 "no_of_types": {
 637                     "format": "int32",
 638                     "description": "Number of EI types",
 639                     "type": "integer"
 640                 },
 641                 "status": {
 642                     "description": "status text",
 643                     "type": "string"
 644                 }
 645             }
 646         },
 647         "producer_ei_type_info": {
 648             "description": "Information for an EI type",
 649             "type": "object",
 650             "title": "producer_ei_type_info",
 651             "required": ["ei_job_data_schema"],
 652             "properties": {"ei_job_data_schema": {
 653                 "description": "Json schema for the job data",
 654                 "type": "object"
 655             }}
 656         },
 657         "producer_registration_info": {
 658             "description": "Information for an EI producer",
 659             "type": "object",
 660             "title": "producer_registration_info",
 661             "required": [
 662                 "ei_job_callback_url",
 663                 "ei_producer_supervision_callback_url",
 664                 "supported_ei_types"
 665             ],
 666             "properties": {
 667                 "supported_ei_types": {
 668                     "description": "Supported EI type IDs",
 669                     "type": "array",
 670                     "items": {"type": "string"}
 671                 },
 672                 "ei_producer_supervision_callback_url": {
 673                     "description": "callback for producer supervision",
 674                     "type": "string"
 675                 },
 676                 "ei_job_callback_url": {
 677                     "description": "callback for EI job",
 678                     "type": "string"
 679                 }
 680             }
 681         },
 682         "producer_status": {
 683             "description": "Status for an EI Producer",
 684             "type": "object",
 685             "title": "producer_status",
 686             "required": ["operational_state"],
 687             "properties": {"operational_state": {
 688                 "description": "Operational state, values:\nENABLED: TBD\nDISABLED: TBD.",
 689                 "type": "string",
 690                 "enum": [
 691                     "ENABLED",
 692                     "DISABLED"
 693                 ]
 694             }}
 695         },
 696         "ProblemDetails": {
 697             "description": "A problem detail to carry details in a HTTP response according to RFC 7807",
 698             "type": "object",
 699             "title": "ProblemDetails",
 700             "properties": {
 701                 "detail": {
 702                     "description": "A human-readable explanation specific to this occurrence of the problem.",
 703                     "type": "string",
 704                     "example": "EI job type not found"
 705                 },
 706                 "status": {
 707                     "format": "int32",
 708                     "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
 709                     "type": "integer",
 710                     "example": 404
 711                 }
 712             }
 713         },
 714         "EiJobStatusObject": {
 715             "description": "Status for an EI job",
 716             "type": "object",
 717             "title": "EiJobStatusObject",
 718             "required": ["eiJobStatus"],
 719             "properties": {"eiJobStatus": {
 720                 "description": "values:\nENABLED: the A1-EI producer is able to deliver EI result for the EI job\nDISABLED: the A1-EI producer is unable to deliver EI result for the EI job",
 721                 "type": "string",
 722                 "enum": [
 723                     "ENABLED",
 724                     "DISABLED"
 725                 ]
 726             }}
 727         },
 728         "EiJobObject": {
 729             "description": "Information for an Enrichment Information Job",
 730             "type": "object",
 731             "title": "EiJobObject",
 732             "required": [
 733                 "eiTypeId",
 734                 "jobDefinition",
 735                 "jobOwner",
 736                 "jobResultUri"
 737             ],
 738             "properties": {
 739                 "eiTypeId": {
 740                     "description": "EI type Idenitifier of the EI job",
 741                     "type": "string"
 742                 },
 743                 "jobResultUri": {
 744                     "description": "The target URI of the EI data",
 745                     "type": "string"
 746                 },
 747                 "jobOwner": {
 748                     "description": "Identity of the owner of the job",
 749                     "type": "string"
 750                 },
 751                 "jobStatusNotificationUri": {
 752                     "description": "The target of EI job status notifications",
 753                     "type": "string"
 754                 },
 755                 "jobDefinition": {
 756                     "description": "EI type specific job data",
 757                     "type": "object"
 758                 }
 759             }
 760         }
 761     },
 762     "swagger": "2.0",
 763     "info": {
 764         "description": "This page lists all the rest apis for the service.",
 765         "title": "Enrichment Data service",
 766         "version": "1.0"
 767     },
 768     "tags": [
 769         {
 770             "name": "A1-EI (enrichment information)",
 771             "description": "Consumer Controller"
 772         },
 773         {
 774             "name": "A1-EI (enrichment information) callbacks",
 775             "description": "Consumer Simulator Controller"
 776         },
 777         {
 778             "name": "Data Producer Job Control (example producer)",
 779             "description": "Producer Simulator Controller"
 780         },
 781         {
 782             "name": "Data Producer Registry API",
 783             "description": "Producer Controller"
 784         },
 785         {
 786             "name": "Service status",
 787             "description": "Status Controller"
 788         }
 789     ]
 790 }