-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdata-import-converter-storage.raml
558 lines (551 loc) · 21 KB
/
data-import-converter-storage.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
#%RAML 1.0
title: Data Import Converter Storage
version: v1.0
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: Data Import Converter Storage API
content: API for managing data import profiles
types:
errors: !include raml-storage/raml-util/schemas/errors.schema
jobProfile: !include raml-storage/schemas/mod-data-import-converter-storage/jobProfile.json
jobProfileCollection: !include raml-storage/schemas/mod-data-import-converter-storage/jobProfileCollection.json
jobProfileUpdateDto: !include raml-storage/schemas/mod-data-import-converter-storage/jobProfileUpdateDto.json
matchProfile: !include raml-storage/schemas/mod-data-import-converter-storage/matchProfile.json
matchProfileCollection: !include raml-storage/schemas/mod-data-import-converter-storage/matchProfileCollection.json
matchProfileUpdateDto: !include raml-storage/schemas/mod-data-import-converter-storage/matchProfileUpdateDto.json
mappingProfile: !include raml-storage/schemas/mod-data-import-converter-storage/mappingProfile.json
mappingProfileCollection: !include raml-storage/schemas/mod-data-import-converter-storage/mappingProfileCollection.json
mappingProfileUpdateDto: !include raml-storage/schemas/mod-data-import-converter-storage/mappingProfileUpdateDto.json
actionProfile: !include raml-storage/schemas/mod-data-import-converter-storage/actionProfile.json
actionProfileCollection: !include raml-storage/schemas/mod-data-import-converter-storage/actionProfileCollection.json
actionProfileUpdateDto: !include raml-storage/schemas/mod-data-import-converter-storage/actionProfileUpdateDto.json
profileAssociation: !include raml-storage/schemas/mod-data-import-converter-storage/profileAssociation.json
profileAssociationRecord: !include raml-storage/schemas/mod-data-import-converter-storage/profileAssociationRecord.json
profileWrapper: !include raml-storage/schemas/mod-data-import-converter-storage/profileWrapper.json
profileAssociationCollection: !include raml-storage/schemas/mod-data-import-converter-storage/profileAssociationCollection.json
profileSnapshotWrapper: !include raml-storage/schemas/mod-data-import-converter-storage/profileSnapshotWrapper.json
entityTypeCollection: !include raml-storage/schemas/mod-data-import-converter-storage/entityTypeCollection.json
operationType: !include raml-storage/schemas/mod-data-import-converter-storage/operationType.json
traits:
validate: !include raml-storage/raml-util/traits/validation.raml
pageable: !include raml-storage/raml-util/traits/pageable.raml
searchable: !include raml-storage/raml-util/traits/searchable.raml
resourceTypes:
collection: !include raml-storage/raml-util/rtypes/collection.raml
collection-item: !include raml-storage/raml-util/rtypes/item-collection.raml
/data-import-profiles:
/jobProfiles:
displayName: Job Profiles
description: API for managing Job Profiles
type:
collection:
schemaCollection: jobProfileCollection
schemaItem: jobProfile
exampleCollection: !include raml-storage/examples/mod-data-import-converter-storage/jobProfileCollection.sample
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/jobProfile.sample
post:
is: [validate]
body:
application/json:
type: jobProfileUpdateDto
get:
queryParameters:
showHidden:
description: selection condition of Job Profiles by field 'hidden'
example: false
type: boolean
default: false
required: false
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
is: [
searchable: {description: "with valid searchable fields: for example userInfo.lastName=Doe", example: "userInfo.lastName=Doe"},
pageable,
validate
]
/{id}:
displayName: Job Profile
description: Get, Delete or Update a specific Job Profile
type:
collection-item:
schema: jobProfile
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/jobProfile.sample
get:
queryParameters:
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
put:
is: [validate]
body:
application/json:
type: jobProfileUpdateDto
responses:
200:
body:
application/json:
type: jobProfile
delete:
responses:
204:
body:
text/plain: !!null
409:
body:
text/plain: !!null
/matchProfiles:
displayName: Match Profiles
description: API for managing Match Profiles
type:
collection:
schemaCollection: matchProfileCollection
schemaItem: matchProfile
exampleCollection: !include raml-storage/examples/mod-data-import-converter-storage/matchProfileCollection.sample
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/matchProfile.sample
post:
is: [validate]
body:
application/json:
type: matchProfileUpdateDto
get:
queryParameters:
showHidden:
description: selection condition of Match Profiles by field 'hidden'
example: false
type: boolean
default: false
required: false
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
is: [
searchable: {description: "with valid searchable fields: for example userInfo.lastName=Doe", example: "userInfo.lastName=Doe"},
pageable,
validate
]
/{id}:
displayName: Match Profile
description: Get, Delete or Update a specific Match Profile
type:
collection-item:
schema: matchProfile
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/matchProfile.sample
get:
queryParameters:
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
put:
is: [validate]
body:
application/json:
type: matchProfileUpdateDto
responses:
200:
body:
application/json:
type: matchProfile
delete:
responses:
204:
body:
text/plain: !!null
409:
body:
text/plain: !!null
/mappingProfiles:
displayName: Mapping Profiles
description: API for managing Mapping Profiles
type:
collection:
schemaCollection: mappingProfileCollection
schemaItem: mappingProfile
exampleCollection: !include raml-storage/examples/mod-data-import-converter-storage/mappingProfileCollection.sample
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/mappingProfile.sample
post:
is: [validate]
body:
application/json:
type: mappingProfileUpdateDto
get:
queryParameters:
showHidden:
description: selection condition of Mapping Profiles by field 'hidden'
example: false
type: boolean
default: false
required: false
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
is: [
searchable: {description: "with valid searchable fields: for example userInfo.lastName=Doe", example: "userInfo.lastName=Doe"},
pageable,
validate
]
/{id}:
displayName: Mapping Profile
description: Get, Delete or Update a specific Mapping Profile
type:
collection-item:
schema: mappingProfile
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/mappingProfile.sample
get:
queryParameters:
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
put:
is: [validate]
body:
application/json:
type: mappingProfileUpdateDto
responses:
200:
body:
application/json:
type: mappingProfile
delete:
responses:
204:
body:
text/plain: !!null
409:
body:
text/plain: !!null
/actionProfiles:
displayName: Action Profiles
description: API for managing Action Profiles
type:
collection:
schemaCollection: actionProfileCollection
schemaItem: actionProfile
exampleCollection: !include raml-storage/examples/mod-data-import-converter-storage/actionProfileCollection.sample
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/actionProfile.sample
post:
is: [validate]
body:
application/json:
type: actionProfileUpdateDto
get:
queryParameters:
showHidden:
description: selection condition of Action Profiles by field 'hidden'
example: false
type: boolean
default: false
required: false
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
is: [
searchable: {description: "with valid searchable fields: for example userInfo.lastName=Doe", example: "userInfo.lastName=Doe"},
pageable,
validate
]
/{id}:
displayName: Action Profile
description: Get, Delete or Update a specific Action Profile
type:
collection-item:
schema: actionProfile
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/actionProfile.sample
get:
queryParameters:
withRelations:
description: Load profile with related child and parent profiles
example: false
type: boolean
default: false
required: false
put:
is: [validate]
body:
application/json:
type: actionProfileUpdateDto
responses:
200:
body:
application/json:
type: actionProfile
delete:
responses:
204:
body:
text/plain: !!null
409:
body:
text/plain: !!null
/profileAssociations:
displayName: Profile associations
description: API for managing Profile associations. Correct ProfileAssociation types are ACTION_PROFILE_TO_ACTION_PROFILE, ACTION_PROFILE_TO_MAPPING_PROFILE,
ACTION_PROFILE_TO_MATCH_PROFILE, JOB_PROFILE_TO_ACTION_PROFILE, JOB_PROFILE_TO_MATCH_PROFILE, MATCH_PROFILE_TO_ACTION_PROFILE, MATCH_PROFILE_TO_MATCH_PROFILE.
type:
collection:
schemaCollection: profileAssociationCollection
schemaItem: profileAssociation
exampleCollection: !include raml-storage/examples/mod-data-import-converter-storage/profileAssociationCollection.sample
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/profileAssociation.sample
post:
queryParameters:
master:
description: It needs to identify master profile type in association
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE"
detail:
description: It needs to identify detail profile type in association
required: true
type: string
example: "ACTION_PROFILE, MAPPING_PROFILE, MATCH_PROFILE"
is: [validate]
get:
queryParameters:
master:
description: It needs to identify master profile type in association
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE"
detail:
description: It needs to identify detail profile type in association
required: true
type: string
example: "ACTION_PROFILE, MAPPING_PROFILE, MATCH_PROFILE"
is: [validate]
/{id}:
displayName: Profile associations
description: Get, Delete or Update a specific Profile association. Correct ProfileAssociation types are ACTION_PROFILE_TO_ACTION_PROFILE, ACTION_PROFILE_TO_MAPPING_PROFILE,
ACTION_PROFILE_TO_MATCH_PROFILE, JOB_PROFILE_TO_ACTION_PROFILE, JOB_PROFILE_TO_MATCH_PROFILE, MATCH_PROFILE_TO_ACTION_PROFILE, MATCH_PROFILE_TO_MATCH_PROFILE.
type:
collection-item:
schema: profileAssociation
exampleItem: !include raml-storage/examples/mod-data-import-converter-storage/profileAssociation.sample
get:
queryParameters:
master:
description: It needs to identify master profile type in association
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE"
detail:
description: It needs to identify detail profile type in association
required: true
type: string
example: "ACTION_PROFILE, MAPPING_PROFILE, MATCH_PROFILE"
put:
queryParameters:
master:
description: It needs to identify master profile type in association
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE"
detail:
description: It needs to identify detail profile type in association
required: true
type: string
example: "ACTION_PROFILE, MAPPING_PROFILE, MATCH_PROFILE"
is: [validate]
responses:
200:
body:
application/json:
type: profileAssociation
delete:
queryParameters:
master:
description: It needs to identify master profile type in association
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MAPPING_PROFILE, MATCH_PROFILE"
detail:
description: It needs to identify detail profile type in association
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MAPPING_PROFILE, MATCH_PROFILE"
responses:
204:
body:
text/plain: !!null
/details:
displayName: Details profiles by master profile id
description: Retrives details profiles by master profile id
Note that master-detail relationship is sort of parent-child relationship but one detail instance
can be associated with many master instances.
Correct ProfileAssociation types are ACTION_PROFILE_TO_ACTION_PROFILE, ACTION_PROFILE_TO_MAPPING_PROFILE, ACTION_PROFILE_TO_MATCH_PROFILE,
JOB_PROFILE_TO_ACTION_PROFILE, JOB_PROFILE_TO_MATCH_PROFILE, MATCH_PROFILE_TO_ACTION_PROFILE, MATCH_PROFILE_TO_MATCH_PROFILE.
get:
queryParameters:
masterType:
description: It needs to identify master profile type for an id
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE"
detailType:
description: "It filters returned type of details. For example you need to get only MATCH_PROFILEs
for a JOB_PROFILE but the JOB_PROFILE has ACTION_PROFILEs too. So use it as filter for a return type"
required: false
type: string
example: "ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE"
is: [
searchable: {description: "with valid searchable fields: for example userInfo.lastName=Doe", example: "userInfo.lastName=Doe"},
pageable,
validate
]
responses:
200:
body:
application/json:
type: profileSnapshotWrapper
/masters:
displayName: Masters profiles by detail profile id
description: Retrives masters profiles by detail profile id.
Note that master-detail relationship is sort of parent-child relationship but one detail instance
can be associated with many master instances.
Correct ProfileAssociation types are ACTION_PROFILE_TO_ACTION_PROFILE, ACTION_PROFILE_TO_MAPPING_PROFILE, ACTION_PROFILE_TO_MATCH_PROFILE,
JOB_PROFILE_TO_ACTION_PROFILE, JOB_PROFILE_TO_MATCH_PROFILE, MATCH_PROFILE_TO_ACTION_PROFILE, MATCH_PROFILE_TO_MATCH_PROFILE.
get:
queryParameters:
detailType:
description: "Type of detail profile"
required: true
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE"
masterType:
description: "It filters returned type of masters. For example you need to get only JOB_PROFILEs
for a MATCH_PROFILE but the MATCH_PROFILE has ACTION_PROFILEs too. So use it as filter for a return type"
required: false
type: string
example: "JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE"
is: [
searchable: {description: "with valid searchable fields: for example userInfo.lastName=Doe", example: "userInfo.lastName=Doe"},
pageable,
validate
]
responses:
200:
body:
application/json:
type: profileSnapshotWrapper
/jobProfileSnapshots:
displayName: Profile snapshots
description: API for managing Job Profile Snapshots
/{id}:
get:
description: Method to get Job Profile Snapshot by id
responses:
200:
body:
application/json:
type: profileSnapshotWrapper
post:
description: Method to create Job Profile Snapshot by Job Profile id
responses:
201:
body:
application/json:
type: profileSnapshotWrapper
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/entityTypes:
displayName: Entity types
get:
description: Get a list of entity types
responses:
200:
body:
application/json:
type: entityTypeCollection
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/profileSnapshots:
displayName: Profile Snapshot structure
description: API for managing a Profile Snapshots.
post:
description: Method to import profile snapshot with related profiles.
is: [validate]
body:
application/json:
type: profileSnapshotWrapper
responses:
201:
body:
application/json:
type: profileSnapshotWrapper
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/{profileId}:
get:
description: Get a profile snapshot structure for specified profile id and type.
Acceptable profileType values are JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE.
queryParameters:
profileType:
description: Indicates profile type
required: true
type: string
example: "JOB_PROFILE"
jobProfileId:
description: Indicates job profile id, should be specified when {profileType} parameter has value JOB_PROFILE or MATCH_PROFILE
required: false
type: string
responses:
200:
body:
application/json:
type: profileSnapshotWrapper
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"