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
15 - A1-E Enrichment Data Consumer API
16 summary: Query EI type identifiers
17 description: DETAILS TBD
18 operationId: getEiTypeIdentifiersUsingGET
23 description: EI type identifiers
29 description: Unauthorized
31 description: Forbidden
33 description: Not Found
35 '/A1-EI/v1/eitypes/{eiTypeId}':
38 - A1-E Enrichment Data Consumer API
39 summary: Definitions for an individual EI Type
40 description: Query EI type
41 operationId: getEiTypeUsingGET
54 $ref: '#/definitions/ei_type_info'
56 description: Unauthorized
58 description: Forbidden
60 description: Enrichment Information type is not found
62 $ref: '#/definitions/error_information'
64 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs':
67 - A1-E Enrichment Data Consumer API
68 summary: Query EI job identifiers
69 description: Returns the identifiers for an EI Type
70 operationId: getEiJobIdsUsingGET
81 description: identifies the owner of the job
93 description: Unauthorized
95 description: Forbidden
97 description: Enrichment Information type is not found
99 $ref: '#/definitions/error_information'
101 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}':
104 - A1-E Enrichment Data Consumer API
105 summary: Individual EI Job
106 operationId: getIndividualEiJobUsingGET
117 description: eiTypeId
124 $ref: '#/definitions/ei_job_info'
126 description: Unauthorized
128 description: Forbidden
130 description: Enrichment Information type or job is not found
132 $ref: '#/definitions/error_information'
136 - A1-E Enrichment Data Consumer API
137 summary: Individual EI Job
138 description: Create or update an EI Job
139 operationId: putIndividualEiJobUsingPUT
152 description: eiJobInfo
155 $ref: '#/definitions/ei_job_info'
158 description: eiTypeId
163 description: Job updated
167 description: Job created
171 description: Unauthorized
173 description: Forbidden
175 description: Enrichment Information type is not found
177 $ref: '#/definitions/error_information'
181 - A1-E Enrichment Data Consumer API
182 summary: Individual EI Job
183 description: Delete an EI job
184 operationId: deleteIndividualEiJobUsingDELETE
195 description: eiTypeId
200 description: Not used
204 description: Job deleted
208 description: Unauthorized
210 description: Forbidden
212 description: Enrichment Information type or job is not found
214 $ref: '#/definitions/error_information'
216 '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status':
219 - A1-E Enrichment Data Consumer API
220 summary: EI Job status
221 operationId: getEiJobStatusUsingGET
232 description: eiTypeId
237 description: EI Job status
239 $ref: '#/definitions/ei_job_status'
241 description: Unauthorized
243 description: Forbidden
245 description: Enrichment Information type or job is not found
247 $ref: '#/definitions/error_information'
255 description: EI Type specific job data
258 description: Identity of the owner of the job
261 description: the deliver information for the EI. This is typically a URL.
263 description: Information for a Enrichment Information Job
270 Operational state, values:
277 description: Status for an EI Job
283 description: Json schema for the job data
285 description: Information for an EI type
291 example: EI job type not found
292 description: ' A human-readable explanation specific to this occurrence of the problem.'
297 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. '
298 title: error_information
299 description: 'Problem as defined in https://tools.ietf.org/html/rfc7807'