-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathRuntime_v2.yml
More file actions
2307 lines (2296 loc) · 79.6 KB
/
Runtime_v2.yml
File metadata and controls
2307 lines (2296 loc) · 79.6 KB
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
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Logik Configurator Runtime APIs V2
version: 2.1.0
description: |
Logik.io End User API Definition. Shows payload structure and schema, authroization approach and endpoint format. Can be used for custom UI or headless implementations.
## Important Versioning Information
Blueprints that use Product Picker Fields ***must*** use the `application/vnd.logik.cfg-v2+json` Content-Type when making requests.
The Runtime APIs are versioned using different Content-Types. There are 2 Content-Type formats, `application/json` for v1 and `application/vnd.logik.cfg-v2+json` for v2.
- `application/json`: can be used with regular Logik field types (number, boolean, text and picklist) and sets.
- `application/vnd.logik.cfg-v2+json`: can be used with all regular field types as well as Product Picker Fields.
The Accept Header should match the Content-Type being used, either:
- `application/json`: for v1.
- `application/vnd.logik.cfg-v2+json, application/json`: for v2.
contact:
email: support@logik.io
servers:
- url: https://{tenant}.{sector}.logik.io
variables:
tenant:
default: example
description: "Logik.io tenant"
sector:
default: test
description: "Logik.io sector"
security:
- RuntimeTokenBearerAuth: []
tags:
- name: Configuration (V2)
description: Creating new configurations, reconfiguring existing configurations, making updates to a configuration and saving changes.
- name: Runtime - Bill of Materials
description: Get Bill of Materials (BOM) information for a given configuration UUID.
paths:
/api:
post:
tags:
- Configuration (V2)
summary: Start Configuration
description: Initialize a new Configuration or reconfigure an existing Configuration if passing an existing Logik Configuration UUID in the Request Body.
operationId: startConfigV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
requestBody:
$ref: "#/components/requestBodies/InitializeConfigurationV2"
responses:
200:
description: Return the state of configuration at initalization or reconfiguration. Includes fields, messages and products.
content:
application/vnd.logik.cfg-v2+json:
schema:
$ref: "#/components/schemas/ConfigResponseV2"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
/api/{uuid}:
get:
tags:
- Configuration (V2)
summary: Get Configuration
description: |
Returns the Configuration state from the given Configuration UUID. This *does not* allow changes to made to the Configuration. To make changes, reconfigure using the POST call.
operationId: getConfigByUuidV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
- $ref: "#/components/parameters/ConfigurationUUID"
responses:
200:
description: Return initial state of fields, messages and products
content:
application/vnd.logik.cfg-v2+json:
schema:
$ref: "#/components/schemas/ConfigResponseV2"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
patch:
tags:
- Configuration (V2)
summary: Update or Save Configuration
description: |
Update or Save Configuration with the provided Configuration UUID.
operationId: updateConfigByUuidV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
- $ref: "#/components/parameters/ConfigurationUUID"
- $ref: "#/components/parameters/queryDelta"
- $ref: "#/components/parameters/querySave"
requestBody:
description: Update or Save Payload for a Configuration.
content:
application/vnd.logik.cfg-v2+json:
schema:
$ref: "#/components/schemas/UpdateConfigV2"
required: true
responses:
200:
description: Returns state of fields, messages and products
content:
application/vnd.logik.cfg-v2+json:
schema:
$ref: "#/components/schemas/ConfigResponseV2"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
/api/{uuid}/sets/{setVariableName}:
get:
tags:
- Configuration (V2)
summary:
Access fields in a given Set. Use if Set flagged in relatedChanges
param
operationId: getSet
parameters:
- $ref: "#/components/parameters/headerOrigin"
- $ref: "#/components/parameters/ConfigurationUUID"
- name: setVariableName
in: path
description: Variable name of the Set defined in admin for which data is requested
required: true
schema:
type: string
- $ref: "#/components/parameters/queryPage"
- $ref: "#/components/parameters/queryLimit"
- $ref: "#/components/parameters/querySort"
responses:
200:
description: Paginated details for a given Set variable name
content:
application/json:
schema:
$ref: "#/components/schemas/SetsResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
/api/{uuid}/bom:
get:
tags:
- Runtime - Bill of Materials
summary: Get BOM
description: Get BOM with the given uuid for current state of Configuration
operationId: getAllBomV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
- $ref: "#/components/parameters/ConfigurationUUID"
- $ref: "#/components/parameters/queryPage"
- $ref: "#/components/parameters/queryLimit"
- $ref: "#/components/parameters/querySort"
- name: bomType
in: query
description: Pass comma separated list of bom types to be returned
schema:
type: string
responses:
200:
description: Return Entire BOM snapshot of Configuration
content:
application/json:
schema:
$ref: "#/components/schemas/BOMResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
/api/{uuid}/bom/sales:
get:
tags:
- Runtime - Bill of Materials
summary: Get Sales BOM
description: Get Sales BOM with the given uuid for current state of Configuration
operationId: getSalesBomV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
- $ref: "#/components/parameters/ConfigurationUUID"
- $ref: "#/components/parameters/queryPage"
- $ref: "#/components/parameters/queryLimit"
- $ref: "#/components/parameters/querySort"
responses:
200:
description: Return current sales BOM of Configuration
content:
application/json:
schema:
$ref: "#/components/schemas/BOMResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
/api/{uuid}/bom/manufacturing:
get:
tags:
- Runtime - Bill of Materials
summary: Get Manufacturing BOM
description: Get Manufacturing BOM with the given uuid for current state of Configuration.
operationId: getManufacturingBomV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
- $ref: "#/components/parameters/ConfigurationUUID"
- $ref: "#/components/parameters/queryPage"
- $ref: "#/components/parameters/queryLimit"
- $ref: "#/components/parameters/querySort"
responses:
200:
description: Return Manufacturing BOM snapshot of Configuration
content:
application/json:
schema:
$ref: "#/components/schemas/BOMResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
/api/{uuid}/bom/{custom}:
get:
tags:
- Runtime - Bill of Materials
summary: Get Custom BOM
description: Get Custom BOM type line items defined in the admin
operationId: getBomByNameV2
parameters:
- $ref: "#/components/parameters/headerOrigin"
- name: custom
in: path
description: Custom BOM Type name
required: true
schema:
type: string
- $ref: "#/components/parameters/ConfigurationUUID"
- $ref: "#/components/parameters/queryPage"
- $ref: "#/components/parameters/queryLimit"
- $ref: "#/components/parameters/querySort"
responses:
200:
description: Returns BOM snapshot of Configuration
content:
application/json:
schema:
$ref: "#/components/schemas/BOMResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/NotAuthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"5XX":
$ref: "#/components/responses/ServerError"
components:
parameters:
headerOrigin:
in: header
name: Origin
description: Request Origin, needs to be one of the allowed origins for the Runtime Token being used.
schema:
type: string
required: true
ConfigurationUUID:
in: path
name: uuid
description: Unique Configuration ID Value
required: true
schema:
type: string
queryPage:
in: "query"
name: "page"
description: "Page number of results to return"
schema:
type: "number"
default: 0
required: true
queryLimit:
in: "query"
name: "limit"
description: "Size of the paged data results"
schema:
type: "number"
default: 100
required: true
querySort:
in: "query"
name: "sort"
description: "Sort field and order of the results, specify property and order{asc|desc} of sort in format field,asc[desc]"
schema:
type: "string"
default: "modified%2CDESC"
required: true
querySave:
name: save
in: query
description:
Pass save parameter as true to save the Configuration and send
BOM to connected application
schema:
type: boolean
default: false
queryDelta:
name: delta
in: query
description:
If `delta=true` the API only retruns changed data. This is default behavior
of the API if the parameter is omitted.
schema:
type: boolean
default: true
requestBodies:
InitializeConfigurationV2:
description: Initialization Payload
required: true
content:
application/vnd.logik.cfg-v2+json:
schema:
$ref: "#/components/schemas/InitConfigV2"
responses:
BadRequest:
description: Bad request. See `errorMessage` for additional details.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
NotAuthorized:
description: Authorization information is missing or invalid.
Forbidden:
description: Credentials are valid but insufficient privileges to perform the action on the resource.
NotFound:
description: Resource was not found. See `errorMessage` for additional details.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
ServerError:
description: Unexpected Server Error.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
schemas:
ErrorResponse:
type: object
properties:
errorMessage:
type: string
timestamp:
type: string
format: date-time
FieldPayload:
type: object
properties:
variableName:
type: string
value:
type: string
UpdateConfigV2:
type: object
properties:
fields:
type: "array"
items:
type: "object"
properties:
variableName:
type: "string"
value:
type: "boolean"
index:
type: "number"
set:
type: "string"
uniqueName:
type: "string"
responseState:
properties:
setPagination:
properties:
additionalProperties:
required:
- "pageSize"
- "pageNumber"
properties:
pageSize:
type: "number"
pageNumber:
type: "number"
type: "object"
type: "object"
defaultPagination:
required:
- "pageSize"
- "pageNumber"
properties:
pageSize:
type: "number"
default: 10
pageNumber:
type: "number"
default: 0
type: "object"
type: "object"
example:
fields:
- variableName: cpuPicker.select
uniqueName: cpuPicker-1003-cpuPicker.select
value: true
set: cpuPicker
index: 3
InitConfigV2:
type: object
properties:
sessionContext:
required:
- "stateful"
properties:
stateful:
type: "boolean"
type: "object"
partnerData:
properties:
quote:
properties:
SBQQ__PricebookId__c:
type: "string"
LGK__QueriedEditAccess__c:
type: "string"
type: "object"
product:
properties:
configuredProductId:
type: "string"
configurationAttributes:
properties:
LGK__Logik_Id__c:
type: "string"
type: "object"
type: "object"
type: "object"
configurableProduct:
properties:
responseState:
required:
- "defaultPagination"
properties:
defaultPagination:
required:
- "pageSize"
- "pageNumber"
properties:
pageSize:
type: "number"
pageNumber:
type: "number"
type: "object"
type: "object"
type: "object"
productId:
type: "string"
example:
sessionContext:
stateful: true
productId: 01t6e000009bOeLAAU
BOMResponse:
type: object
properties:
products:
type: array
items:
$ref: "#/components/schemas/Product"
pageable:
type: object
properties:
sort:
type: object
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
offset:
type: integer
pageNumber:
type: integer
pageSize:
type: integer
paged:
type: boolean
unpaged:
type: boolean
totalPages:
type: integer
totalElements:
type: integer
last:
type: boolean
size:
type: integer
number:
type: integer
numberOfElements:
type: integer
first:
type: boolean
empty:
type: boolean
total:
type: integer
example:
total: 350
pageable:
sort:
empty: false
sorted: true
unsorted: false
offset: 0
pageNumber: 0
pageSize: 20
paged: true
unpaged: false
totalPages: 1
totalElements: 2
last: true
size: 20
number: 0
sort:
empty: false
sorted: true
unsorted: false
numberOfElements: 2
first: true
empty: false
products:
- id: SSM
uom: ""
name: Single Motherboard
type: accessory
level: 0
price: 125
bomType: Sales
extPrice: 125
quantity: 1
partnerId: 01t6e000009gRTpAAM
externalId: ""
description: ""
orderNumber: 10
productCode: SSM
rollUpPrice: 350
productFamily: ""
uniqueIdentifier: motherboard
- id: CPU7320GHZRYZ3
uom: ""
name: AMD Ryzen 3 7320U
type: accessory
level: 1
price: 225
bomType: SALES
extPrice: 225
extended:
watts: "150"
quantity: 1
partnerId: 01t6e000009bOfYAAU
externalId: ""
description: ""
productCode: CPU7320GHZRYZ3
rollUpPrice: 225
parentProduct: motherboard
productFamily: Hardware
effectiveParent: motherboard
Product:
type: object
properties:
id:
type: string
selectionType:
type: string
quantity:
type: integer
bomType:
type: string
level:
type: integer
parentProduct:
type: integer
notes:
type: string
uniqueIdentifier:
type: integer
description:
type: string
externalId:
type: string
name:
type: string
price:
type: number
extPrice:
type: number
Field:
type: object
properties:
value:
type: string
dataType:
type: string
visibilityState:
type: string
editable:
type: string
variableName:
type: string
optionSet:
required:
- options
type: object
properties:
options:
type: array
items:
required:
- label
- orderNumber
- state
- value
type: object
properties:
label:
type: string
state:
type: string
value:
type: string
imageUrl:
type: string
orderNumber:
type: integer
Message:
required:
- error
- field
- message
- type
type: object
properties:
message:
type: string
type:
type: string
error:
type: boolean
field:
type: string
relatedChangesValue:
type: object
properties:
key:
type: string
type:
type: string
description:
Value of SET|PRODUCT which will return KEY value as variable
name of set or static value products
SetsContent:
type: object
properties:
index:
type: integer
fields:
type: array
items:
$ref: "#/components/schemas/Field"
SetsResponse:
type: object
properties:
content:
type: array
items:
$ref: "#/components/schemas/SetsContent"
pageable:
type: object
properties:
sort:
type: object
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
offset:
type: integer
pageNumber:
type: integer
pageSize:
type: integer
paged:
type: boolean
unpaged:
type: boolean
totalPages:
type: integer
totalElements:
type: integer
last:
type: boolean
size:
type: integer
number:
type: integer
numberOfElements:
type: integer
first:
type: boolean
empty:
type: boolean
total:
type: integer
ConfigResponseV2:
type: object
properties:
fields:
type: "array"
items:
type: "object"
properties:
userEdited:
type: "boolean"
dataType:
type: "string"
visibilityState:
type: "string"
editable:
type: "string"
variableName:
type: "string"
uniqueName:
type: "string"
value:
anyOf:
- type: "string"
- type: "number"
- type: "boolean"
- type: "array"
items:
type: "string"
optionSet:
required:
- "options"
properties:
options:
type: "array"
items:
type: "object"
properties:
label:
type: "string"
state:
type: "string"
value:
type: "string"
imageUrl:
type: "string"
orderNumber:
type: "number"
type: "object"
selectAll:
type: "string"
rows:
required:
- "content"
- "pageable"
- "last"
- "totalPages"
- "totalElements"
- "size"
- "number"
- "sort"
- "numberOfElements"
- "first"
- "empty"
properties:
content:
type: "array"
items:
type: "object"
properties:
index:
type: "number"
fields:
type: "array"
items:
type: "object"
properties:
userEdited:
type: "boolean"
dataType:
type: "string"
visibilityState:
type: "string"
editable:
type: "string"
variableName:
type: "string"
uniqueName:
type: "string"
value:
type: "string"
set:
type: "string"
index:
type: "number"
label:
type: "string"
state:
type: "string"
value:
type: "string"
imageUrl:
type: "string"
orderNumber:
type: "number"
productDetails:
required:
- "price"
- "name"
properties:
price:
type: "number"
name:
type: "string"
type: "object"
pageable:
type: "string"
last:
type: "boolean"
totalPages:
type: "number"
totalElements:
type: "number"
size:
type: "number"
number:
type: "number"
sort:
required:
- "empty"
- "sorted"
- "unsorted"
properties:
empty:
type: "boolean"
sorted:
type: "boolean"
unsorted:
type: "boolean"
type: "object"
numberOfElements:
type: "number"
first:
type: "boolean"
empty:
type: "boolean"
type: "object"
uuid:
type: "string"
revision:
type: "number"
relatedChanges:
type: "array"
items:
type: "object"
properties:
key:
type: "string"
type:
type: "string"
valid:
type: "boolean"
messages:
type: array
items:
$ref: "#/components/schemas/Message"
productChange:
type: "boolean"
products:
type: array
items:
$ref: "#/components/schemas/Product"
showValidationButton:
type: "boolean"
layouts:
type: "array"
items:
type: "object"
properties:
url:
type: "string"
label:
type: "string"
variableName:
type: "string"
example:
fields:
- userEdited: false
dataType: array
visibilityState: visible
editable: "true"
variableName: ramPicker
uniqueName: ramPicker
value: []
optionSet:
options:
- label: 8GB RAM Module
state: visible
value: RAM8GB
imageUrl: https://i.imgur.com/WkXo98I.png
orderNumber: 10
- label: 16GB RAM Module
state: visible
value: RAM16GB
imageUrl: https://i.imgur.com/WkXo98I.png
orderNumber: 20
- label: 32GB RAM Module
state: visible
value: RAM32GB
imageUrl: https://i.imgur.com/WkXo98I.png
orderNumber: 30
selectAll: NONE
rows:
content:
- index: 0
fields:
- userEdited: false
dataType: text
visibilityState: visible
editable: "false"
variableName: ramPicker.value
uniqueName: ramPicker-1000-ramPicker.value
value: RAM8GB
set: ramPicker
index: 0
- userEdited: false
dataType: text
visibilityState: visible
editable: "true"
variableName: ramPicker.interface