« back to all changes in this revision
Viewing changes to web/swagger.json
- browse files at revision 441.1.40
- compare with another revision
- download diff
- download tarball
- view history from revision 441.1.40
- Committer: Dan Garner
- Date: 2015-08-03 13:19:52 UTC
- mto: This revision was merged to the branch mainline in revision 447.
- Revision ID: git-v1:51aff4ced58edafab2631842d7de83086daa6e8d
Document Models with Swagger
- files modified:
- lib/Controller/Layout.php
added
removed
web/swagger.json
14
14
"version": "1.8.0-alpha"
15
15
},
16
16
"basePath": "/api",
17
"schemes": [
18
"http"
19
],
17
20
"produces": [
18
21
"application/json"
19
22
],
198
201
"tags": [
199
202
"layout"
200
203
],
204
"description": "Edit a Layout",
201
205
"operationId": "layoutEdit",
202
206
"parameters": [
203
207
{
204
208
"name": "layoutId",
205
209
"in": "path",
210
"required": true,
206
211
"type": "integer"
207
212
}
208
213
],
218
223
}
219
224
},
220
225
"definitions": {
226
"Application": {
227
"properties": {
228
"key": {
229
"description": "Application Key",
230
"type": "string"
231
},
232
"secret": {
233
"description": "Private Secret Key",
234
"type": "string"
235
},
236
"name": {
237
"description": "Application Name",
238
"type": "string"
239
},
240
"expires": {
241
"description": "Application Session Expiry",
242
"type": "integer"
243
}
244
}
245
},
246
"AuditLog": {
247
"properties": {
248
"logId": {
249
"description": "The Log Id",
250
"type": "integer"
251
},
252
"logDate": {
253
"description": "The Log Date",
254
"type": "integer"
255
},
256
"userId": {
257
"description": "The userId of the User that took this action",
258
"type": "integer"
259
},
260
"message": {
261
"description": "Message describing the action taken",
262
"type": "string"
263
},
264
"entity": {
265
"description": "The effected entity",
266
"type": "string"
267
},
268
"entityId": {
269
"description": "The effected entityId",
270
"type": "integer"
271
},
272
"objectAfter": {
273
"description": "A JSON representation of the object after it was changed",
274
"type": "string"
275
},
276
"userName": {
277
"description": "The User Name of the User that took this action",
278
"type": "string"
279
}
280
}
281
},
282
"Campaign": {
283
"properties": {
284
"campaignId": {
285
"description": "The Campaign Id",
286
"type": "integer"
287
},
288
"ownerId": {
289
"description": "The userId of the User that owns this Campaign",
290
"type": "integer"
291
},
292
"campaign": {
293
"description": "The name of the Campaign",
294
"type": "string"
295
},
296
"isLayoutSpecific": {
297
"description": "A 0|1 flag to indicate whether this is a Layout specific Campaign or not.",
298
"type": "integer"
299
},
300
"numberLayouts": {
301
"description": "The number of Layouts associated with this Campaign",
302
"type": "integer"
303
}
304
}
305
},
306
"DataSet": {
307
"properties": {
308
"dataSetId": {
309
"description": "The dataSetId",
310
"type": "integer"
311
},
312
"dataSet": {
313
"description": "The dataSet Name",
314
"type": "string"
315
},
316
"description": {
317
"description": "The dataSet description",
318
"type": "string"
319
},
320
"userId": {
321
"description": "The userId of the User that owns this DataSet",
322
"type": "integer"
323
},
324
"lastDataEdit": {
325
"description": "Timestamp indicating the date/time this DataSet was edited last",
326
"type": "integer"
327
},
328
"owner": {
329
"description": "The user name of the User that owns this DataSet",
330
"type": "string"
331
},
332
"groupsWithPermissions": {
333
"description": "A comma separated list of Groups/Users that have permission to this DataSet",
334
"type": "string"
335
}
336
}
337
},
338
"DataSetColumn": {
339
"properties": {
340
"dataSetColumnId": {
341
"description": "The ID of this DataSetColumn",
342
"type": "integer"
343
},
344
"dataSetId": {
345
"description": "The ID of the DataSet that this Column belongs to",
346
"type": "integer"
347
},
348
"heading": {
349
"description": "The Column Heading",
350
"type": "string"
351
},
352
"dataTypeId": {
353
"description": "The ID of the DataType for this Column",
354
"type": "integer"
355
},
356
"dataSetColumnTypeId": {
357
"description": "The ID of the ColumnType for this Column",
358
"type": "integer"
359
},
360
"listContent": {
361
"description": "Comma separated list of valid content for drop down columns",
362
"type": "string"
363
},
364
"columnOrder": {
365
"description": "The order this column should be displayed",
366
"type": "integer"
367
},
368
"formula": {
369
"description": "A MySQL formula for this column",
370
"type": "string"
371
},
372
"dataType": {
373
"description": "The data type for this Column",
374
"type": "string"
375
},
376
"dataSetColumnType": {
377
"description": "The column type for this Column",
378
"type": "string"
379
}
380
}
381
},
382
"DataSetColumnType": {
383
"properties": {
384
"dataSetColumnTypeId": {
385
"description": "The ID for this DataSetColumnType",
386
"type": "integer"
387
},
388
"dataSetColumnType": {
389
"description": "The name for this DataSetColumnType",
390
"type": "string"
391
}
392
}
393
},
394
"DataType": {
395
"properties": {
396
"dataTypeId": {
397
"description": "The ID for this DataType",
398
"type": "integer"
399
},
400
"dataType": {
401
"description": "The Name for this DataType",
402
"type": "string"
403
}
404
}
405
},
406
"Display": {
407
"properties": {
408
"displayId": {
409
"description": "The ID of this Display",
410
"type": "integer"
411
},
412
"isAuditing": {
413
"description": "Flag indicating whether this Display is recording Auditing Information from XMDS",
414
"type": "integer"
415
},
416
"display": {
417
"description": "The Name of this Display",
418
"type": "string"
419
},
420
"description": {
421
"description": "The Description of this Display",
422
"type": "string"
423
},
424
"defaultLayoutId": {
425
"description": "The ID of the Default Layout",
426
"type": "integer"
427
},
428
"license": {
429
"description": "The Display Unique Identifier also called hardware key",
430
"type": "string"
431
},
432
"licensed": {
433
"description": "A flag indicating whether this Display is licensed or not",
434
"type": "integer"
435
},
436
"loggedIn": {
437
"description": "A flag indicating whether this Display is currently logged in",
438
"type": "integer"
439
},
440
"lastAccessed": {
441
"description": "A timestamp in CMS time for the last time the Display accessed XMDS",
442
"type": "integer"
443
},
444
"incSchedule": {
445
"description": "A flag indicating whether the default layout is interleaved with the Schedule",
446
"type": "integer"
447
},
448
"emailAlert": {
449
"description": "A flag indicating whether the Display will send email alerts.",
450
"type": "integer"
451
},
452
"alertTimeout": {
453
"description": "A timeout in seconds for the Display to send email alerts.",
454
"type": "integer"
455
},
456
"clientAddress": {
457
"description": "The MAC Address of the Display",
458
"type": "string"
459
},
460
"mediaInventoryStatus": {
461
"description": "The media inventory status of the Display",
462
"type": "integer"
463
},
464
"mediaInventoryXml": {
465
"description": "The last submitted Media Inventory XML from the Player",
466
"type": "string"
467
},
468
"macAddress": {
469
"description": "The current Mac Address of the Player",
470
"type": "string"
471
},
472
"lastChanged": {
473
"description": "A timestamp indicating the last time the Mac Address changed",
474
"type": "integer"
475
},
476
"numberOfMacAddressChanges": {
477
"description": "A count of Mac Address changes",
478
"type": "integer"
479
},
480
"lastWakeOnLanCommandSent": {
481
"description": "A timestamp indicating the last time a WOL command was sent",
482
"type": "integer"
483
},
484
"wakeOnLanEnabled": {
485
"description": "A flag indicating whether Wake On Lan is enabled",
486
"type": "integer"
487
},
488
"wakeOnLanTime": {
489
"description": "A h:i string indicating the time to send a WOL command",
490
"type": "string"
491
},
492
"broadCastAddress": {
493
"description": "The broad cast address for this Display",
494
"type": "string"
495
},
496
"secureOn": {
497
"description": "The secureOn WOL settings for this display.",
498
"type": "string"
499
},
500
"cidr": {
501
"description": "The CIDR WOL settings for this display",
502
"type": "string"
503
},
504
"latitude": {
505
"description": "The display Latitude",
506
"type": "number",
507
"format": "double"
508
},
509
"longitude": {
510
"description": "The display longitude",
511
"type": "number",
512
"format": "double"
513
},
514
"versionInstructions": {
515
"description": "A JSON string representing the player installer that should be installed",
516
"type": "string"
517
},
518
"clientType": {
519
"description": "A string representing the player type",
520
"type": "string"
521
},
522
"clientVersion": {
523
"description": "A string representing the player version",
524
"type": "string"
525
},
526
"clientCode": {
527
"description": "A number representing the Player version code",
528
"type": "integer"
529
},
530
"displayProfileId": {
531
"description": "The display settings profile ID for this Display",
532
"type": "integer"
533
},
534
"currentLayoutId": {
535
"description": "The current layout ID reported via XMDS",
536
"type": "integer"
537
},
538
"screenShotRequested": {
539
"description": "A flag indicating that a screen shot should be taken by the Player",
540
"type": "integer"
541
},
542
"storageAvailableSpace": {
543
"description": "The number of bytes of storage available on the device.",
544
"type": "integer"
545
},
546
"storageTotalSpace": {
547
"description": "The number of bytes of storage in total on the device",
548
"type": "integer"
549
},
550
"displayGroupId": {
551
"description": "The ID of the Display Group for this Device",
552
"type": "integer"
553
},
554
"currentLayout": {
555
"description": "The current layout",
556
"type": "string"
557
},
558
"defaultLayout": {
559
"description": "The default layout",
560
"type": "string"
561
},
562
"displayGroups": {
563
"description": "The Display Groups this Display belongs to",
564
"type": "array",
565
"items": {
566
"$ref": "#/definitions/DisplayGroup"
567
}
568
}
569
}
570
},
221
571
"DisplayGroup": {
222
572
"properties": {
223
573
"displayGroupId": {
238
588
}
239
589
}
240
590
},
591
"DisplayProfile": {
592
"properties": {
593
"displayProfileId": {
594
"description": "The ID of this Display Profile",
595
"type": "integer"
596
},
597
"name": {
598
"description": "The name of this Display Profile",
599
"type": "string"
600
},
601
"type": {
602
"description": "The player type that this Display Profile is for",
603
"type": "string"
604
},
605
"config": {
606
"description": "The configuration options for this Profile",
607
"type": "array",
608
"items": {
609
"type": "string"
610
}
611
},
612
"isDefault": {
613
"description": "A flag indicating if this profile should be used as the Default for the client type",
614
"type": "integer"
615
},
616
"userId": {
617
"description": "The userId of the User that owns this profile",
618
"type": "integer"
619
},
620
"configDefault": {
621
"description": "The default configuration options for this Profile",
622
"type": "array",
623
"items": {
624
"type": "string"
625
}
626
},
627
"configTabs": {
628
"description": "Array of tab names to logically group the configuration options",
629
"type": "array",
630
"items": {
631
"type": "string"
632
}
633
}
634
}
635
},
636
"Help": {
637
"properties": {
638
"helpId": {
639
"description": "The ID of this Help Record",
640
"type": "integer"
641
},
642
"topic": {
643
"description": "The topic for this Help Record",
644
"type": "string"
645
},
646
"category": {
647
"description": "The Category for this Help Record",
648
"type": "string"
649
},
650
"link": {
651
"description": "The Link to the Manual for this Help Record",
652
"type": "string"
653
}
654
}
655
},
241
656
"Layout": {
242
657
"properties": {
243
658
"layoutId": {
304
719
}
305
720
}
306
721
},
722
"LogEntry": {
723
"properties": {
724
"logId": {
725
"description": "The Log ID",
726
"type": "integer"
727
},
728
"runNo": {
729
"description": "A unique run number for a set of Log Messages.",
730
"type": "string"
731
},
732
"logDate": {
733
"description": "A timestamp representing the CMS date this log message occured",
734
"type": "integer"
735
},
736
"channel": {
737
"description": "The Channel that generated this message. WEB/API/MAINT/TEST",
738
"type": "string"
739
},
740
"page": {
741
"description": "The requested route",
742
"type": "string"
743
},
744
"function": {
745
"description": "The request method, GET/POST/PUT/DELETE",
746
"type": "string"
747
},
748
"message": {
749
"description": "The log message",
750
"type": "string"
751
},
752
"displayId": {
753
"description": "The display ID this message relates to or NULL for CMS",
754
"type": "integer"
755
},
756
"type": {
757
"description": "The Log Level",
758
"type": "string"
759
},
760
"display": {
761
"description": "The display this message relates to or CMS for CMS.",
762
"type": "string"
763
}
764
}
765
},
766
"Media": {
767
"properties": {
768
"mediaId": {
769
"description": "The Media ID",
770
"type": "integer"
771
},
772
"ownerId": {
773
"description": "The ID of the User that owns this Media",
774
"type": "integer"
775
},
776
"parentId": {
777
"description": "The Parent ID of this Media if it has been revised",
778
"type": "integer"
779
},
780
"name": {
781
"description": "The Name of this Media",
782
"type": "string"
783
},
784
"mediaType": {
785
"description": "The module type of this Media",
786
"type": "integer"
787
},
788
"storedAs": {
789
"description": "The file name of the media as stored in the library",
790
"type": "string"
791
},
792
"fileName": {
793
"description": "The original file name as it was uploaded",
794
"type": "string"
795
},
796
"tags": {
797
"description": "Tags associated with this Media",
798
"type": "array",
799
"items": {
800
"$ref": "#/definitions/Tag"
801
}
802
},
803
"fileSize": {
804
"description": "The file size in bytes",
805
"type": "integer"
806
},
807
"duration": {
808
"description": "The duration to use when assigning this media to a Layout widget",
809
"type": "integer"
810
},
811
"valid": {
812
"description": "Flag indicating whether this media is valid.",
813
"type": "integer"
814
},
815
"moduleSystemFile": {
816
"description": "Flag indicating whether this media is a system file or not",
817
"type": "boolean"
818
},
819
"expires": {
820
"description": "Timestamp indicating when this media should expire",
821
"type": "integer"
822
},
823
"retired": {
824
"description": "Flag indicating whether this media is retired",
825
"type": "integer"
826
},
827
"isEdited": {
828
"description": "Flag indicating whether this media has been edited and replaced with a newer file",
829
"type": "integer"
830
},
831
"md5": {
832
"description": "A MD5 checksum of the stored media file",
833
"type": "string"
834
},
835
"owner": {
836
"description": "The username of the User that owns this media",
837
"type": "string"
838
},
839
"groupsWithPermissions": {
840
"description": "A comma separated list of groups/users with permissions to this Media",
841
"type": "string"
842
}
843
}
844
},
845
"Module": {
846
"properties": {
847
"moduleId": {
848
"description": "The ID of this Module",
849
"type": "integer"
850
},
851
"name": {
852
"description": "Module Name",
853
"type": "string"
854
},
855
"description": {
856
"description": "Description of the Module",
857
"type": "string"
858
},
859
"validExtensions": {
860
"description": "A comma separated list of Valid Extensions",
861
"type": "string"
862
},
863
"imageUri": {
864
"description": "The file uri of an image to represent this Module",
865
"type": "string"
866
},
867
"type": {
868
"description": "The type code for this module",
869
"type": "string"
870
},
871
"enabled": {
872
"description": "A flag indicating whether this module is enabled",
873
"type": "integer"
874
},
875
"regionSpecific": {
876
"description": "A flag indicating whether this module is specific to a Layout or can be uploaded to the Library",
877
"type": "integer"
878
},
879
"previewEnabled": {
880
"description": "A flag indicating whether the Layout designer should render a preview of this module",
881
"type": "integer"
882
},
883
"assignable": {
884
"description": "A flag indicating whether the module is assignable to a Layout",
885
"type": "integer"
886
},
887
"renderAs": {
888
"description": "A flag indicating whether the module should be rendered natively by the Player or via the CMS (native|html)",
889
"type": "string"
890
},
891
"settings": {
892
"description": "An array of additional module specific settings",
893
"type": "array",
894
"items": {
895
"type": "string"
896
}
897
},
898
"schemaVersion": {
899
"description": "The schema version of the module",
900
"type": "integer"
901
},
902
"viewPath": {
903
"description": "The Twig View path for module specific templates",
904
"type": "string"
905
}
906
}
907
},
908
"Page": {
909
"properties": {
910
"pageId": {
911
"description": "The ID of the Page",
912
"type": "integer"
913
},
914
"page": {
915
"description": "A code name for the page",
916
"type": "string"
917
}
918
}
919
},
920
"Permission": {
921
"properties": {
922
"permissionId": {
923
"description": "The ID of this Permission Record",
924
"type": "integer"
925
},
926
"entityId": {
927
"description": "The Entity ID that this Permission refers to",
928
"type": "integer"
929
},
930
"groupId": {
931
"description": "The User Group ID that this permission refers to",
932
"type": "integer"
933
},
934
"objectId": {
935
"description": "The object ID that this permission refers to",
936
"type": "integer"
937
},
938
"isUser": {
939
"description": "A flag indicating whether the groupId refers to a user specific group",
940
"type": "integer"
941
},
942
"entity": {
943
"description": "The entity name that this refers to",
944
"type": "string"
945
},
946
"objectIdString": {
947
"description": "Legacy for when the Object ID is a string",
948
"type": "string"
949
},
950
"group": {
951
"description": "The group name that this refers to",
952
"type": "string"
953
},
954
"view": {
955
"description": "A flag indicating whether view permission is granted",
956
"type": "integer"
957
},
958
"edit": {
959
"description": "A flag indicating whether edit permission is granted",
960
"type": "integer"
961
},
962
"delete": {
963
"description": "A flag indicating whether delete permission is granted",
964
"type": "integer"
965
},
966
"modifyPermissions": {
967
"description": "A flag indicating whether modify permission permission is granted.",
968
"type": "integer"
969
}
970
}
971
},
972
"Playlist": {
973
"properties": {
974
"playlistId": {
975
"description": "The ID of this Playlist",
976
"type": "integer"
977
},
978
"ownerId": {
979
"description": "The userId of the User that owns this Playlist",
980
"type": "integer"
981
},
982
"name": {
983
"description": "The Name of the Playlist",
984
"type": "string"
985
},
986
"tags": {
987
"description": "An array of Tags",
988
"type": "array",
989
"items": {
990
"$ref": "#/definitions/Tag"
991
}
992
},
993
"regions": {
994
"description": "An array of Regions this Playlist is assigned to",
995
"type": "array",
996
"items": {
997
"$ref": "#/definitions/Region"
998
}
999
},
1000
"widgets": {
1001
"description": "An array of Widgets assigned to this Playlist",
1002
"type": "array",
1003
"items": {
1004
"$ref": "#/definitions/Widget"
1005
}
1006
},
1007
"permissions": {
1008
"description": "An array of permissions",
1009
"type": "array",
1010
"items": {
1011
"$ref": "#/definitions/Permission"
1012
}
1013
},
1014
"displayOrder": {
1015
"description": "The display order of the Playlist when assigned to a Region",
1016
"type": "integer"
1017
}
1018
}
1019
},
1020
"Region": {
1021
"properties": {
1022
"regionId": {
1023
"description": "The ID of this region",
1024
"type": "integer"
1025
},
1026
"layoutId": {
1027
"description": "The Layout ID this region belongs to",
1028
"type": "integer"
1029
},
1030
"ownerId": {
1031
"description": "The userId of the User that owns this Region",
1032
"type": "integer"
1033
},
1034
"name": {
1035
"description": "The name of this Region",
1036
"type": "string"
1037
},
1038
"width": {
1039
"description": "Width of the region",
1040
"type": "number",
1041
"format": "double"
1042
},
1043
"height": {
1044
"description": "Height of the Region",
1045
"type": "number",
1046
"format": "double"
1047
},
1048
"top": {
1049
"description": "The top coordinate of the Region",
1050
"type": "number",
1051
"format": "double"
1052
},
1053
"left": {
1054
"description": "The left coordinate of the Region",
1055
"type": "number",
1056
"format": "double"
1057
},
1058
"zIndex": {
1059
"description": "The z-index of the Region to control Layering",
1060
"type": "integer"
1061
},
1062
"playlists": {
1063
"description": "An array of Playlists assigned",
1064
"type": "array",
1065
"items": {
1066
"$ref": "#/definitions/Playlist"
1067
}
1068
},
1069
"regionOptions": {
1070
"description": "An array of Region Options",
1071
"type": "array",
1072
"items": {
1073
"$ref": "#/definitions/RegionOption"
1074
}
1075
},
1076
"permissions": {
1077
"description": "An array of Permissions",
1078
"type": "array",
1079
"items": {
1080
"$ref": "#/definitions/Permission"
1081
}
1082
},
1083
"displayOrder": {
1084
"description": "When linked from a Playlist, what is the display order of that link",
1085
"type": "integer"
1086
}
1087
}
1088
},
1089
"RegionOption": {
1090
"properties": {
1091
"regionId": {
1092
"description": "The regionId that this Option applies to"
1093
},
1094
"option": {
1095
"description": "The option name",
1096
"type": "string"
1097
},
1098
"value": {
1099
"description": "The option value",
1100
"type": "string"
1101
}
1102
}
1103
},
1104
"Resolution": {
1105
"properties": {
1106
"resolutionId": {
1107
"description": "The ID of this Resolution",
1108
"type": "integer"
1109
},
1110
"resolution": {
1111
"description": "The resolution name",
1112
"type": "string"
1113
},
1114
"width": {
1115
"description": "The display width of the resolution",
1116
"type": "number",
1117
"format": "double"
1118
},
1119
"height": {
1120
"description": "The display height of the resolution",
1121
"type": "number",
1122
"format": "double"
1123
},
1124
"designerWidth": {
1125
"description": "The designer width of the resolution",
1126
"type": "number",
1127
"format": "double"
1128
},
1129
"designerHeight": {
1130
"description": "The designer height of the resolution",
1131
"type": "number",
1132
"format": "double"
1133
},
1134
"version": {
1135
"description": "The layout schema version",
1136
"type": "integer"
1137
},
1138
"enabled": {
1139
"description": "A flag indicating whether this resolution is enabled or not",
1140
"type": "integer"
1141
}
1142
}
1143
},
307
1144
"Schedule": {
308
1145
"properties": {
309
1146
"eventId": {
310
"description": "",
1147
"description": "The ID of this Event",
311
1148
"type": "integer"
312
1149
},
313
1150
"campaignId": {
314
"description": "",
1151
"description": "The CampaignID this event is for",
315
1152
"type": "integer"
316
1153
},
317
1154
"displayGroups": {
367
1204
"readOnly": true
368
1205
}
369
1206
}
1207
},
1208
"Tag": {
1209
"properties": {
1210
"tagId": {
1211
"description": "The Tag ID",
1212
"type": "integer"
1213
},
1214
"tag": {
1215
"description": "The Tag Name",
1216
"type": "string"
1217
},
1218
"layoutIds": {
1219
"description": "An array of layoutIDs with this Tag",
1220
"type": "array",
1221
"items": {
1222
"type": "integer"
1223
}
1224
},
1225
"mediaIds": {
1226
"description": "An array of mediaIds with this Tag",
1227
"type": "array",
1228
"items": {
1229
"type": "integer"
1230
}
1231
}
1232
}
1233
},
1234
"Transition": {
1235
"properties": {
1236
"transitionId": {
1237
"description": "The transition ID",
1238
"type": "integer"
1239
},
1240
"transition": {
1241
"description": "The transition name",
1242
"type": "string"
1243
},
1244
"code": {
1245
"description": "Code for transition",
1246
"type": "string"
1247
},
1248
"hasDirection": {
1249
"description": "Flag indicating whether this is a directional transition",
1250
"type": "integer"
1251
},
1252
"hasDuration": {
1253
"description": "Flag indicating whether this transition has a duration option",
1254
"type": "integer"
1255
},
1256
"availableAsIn": {
1257
"description": "Flag indicating whether this transition should be available for IN assignments",
1258
"type": "integer"
1259
},
1260
"availableAsOut": {
1261
"description": "Flag indicating whether this transition should be available for OUT assignments",
1262
"type": "integer"
1263
}
1264
}
1265
},
1266
"User": {
1267
"properties": {
1268
"userId": {
1269
"description": "The ID of this User",
1270
"type": "integer"
1271
},
1272
"userName": {
1273
"description": "The user name",
1274
"type": "string"
1275
},
1276
"userTypeId": {
1277
"description": "The user type ID",
1278
"type": "integer"
1279
},
1280
"loggedIn": {
1281
"description": "Flag indicating whether this user is logged in or not",
1282
"type": "integer"
1283
},
1284
"email": {
1285
"description": "Email address of the user used for email alerts",
1286
"type": "string"
1287
},
1288
"homePageId": {
1289
"description": "The pageId of the Homepage for this User",
1290
"type": "integer"
1291
},
1292
"lastAccessed": {
1293
"description": "A timestamp indicating the time the user last logged into the CMS",
1294
"type": "integer"
1295
},
1296
"newUserWizard": {
1297
"description": "A flag indicating whether this user has see the new user wizard",
1298
"type": "integer"
1299
},
1300
"retired": {
1301
"description": "A flag indicating whether the user is retired",
1302
"type": "integer"
1303
},
1304
"groupId": {
1305
"description": "The users user group ID",
1306
"type": "integer"
1307
},
1308
"group": {
1309
"description": "The users group name",
1310
"type": "integer"
1311
},
1312
"libraryQuota": {
1313
"description": "The users library quota in bytes"
1314
},
1315
"groups": {
1316
"description": "An array of user groups this user is assigned to",
1317
"type": "array",
1318
"items": {
1319
"$ref": "#/definitions/UserGroup"
1320
}
1321
},
1322
"campaigns": {
1323
"description": "An array of Campaigns for this User",
1324
"type": "array",
1325
"items": {
1326
"$ref": "#/definitions/Campaign"
1327
}
1328
},
1329
"layouts": {
1330
"description": "An array of Layouts for this User",
1331
"type": "array",
1332
"items": {
1333
"$ref": "#/definitions/Layout"
1334
}
1335
},
1336
"media": {
1337
"description": "An array of Media for this user",
1338
"type": "array",
1339
"items": {
1340
"$ref": "#/definitions/Media"
1341
}
1342
},
1343
"events": {
1344
"description": "An array of Scheduled Events for this User",
1345
"type": "array",
1346
"items": {
1347
"$ref": "#/definitions/Schedule"
1348
}
1349
},
1350
"homePage": {
1351
"description": "The name of home page",
1352
"type": "string"
1353
}
1354
}
1355
},
1356
"UserGroup": {
1357
"properties": {
1358
"groupId": {
1359
"description": "The Group ID",
1360
"type": "integer"
1361
},
1362
"group": {
1363
"description": "The group name",
1364
"type": "string"
1365
},
1366
"isUserSpecific": {
1367
"description": "A flag indicating whether this is a user specific group or not",
1368
"type": "integer"
1369
},
1370
"isEveryone": {
1371
"description": "A flag indicating the special everyone group",
1372
"type": "integer"
1373
},
1374
"libraryQuota": {
1375
"description": "This users library quota in bytes. 0 = unlimited",
1376
"type": "integer"
1377
}
1378
}
1379
},
1380
"Widget": {
1381
"properties": {
1382
"widgetId": {
1383
"description": "The Widget ID",
1384
"type": "integer"
1385
},
1386
"playlistId": {
1387
"description": "The ID of the Playlist this Widget belongs to",
1388
"type": "integer"
1389
},
1390
"ownerId": {
1391
"description": "The ID of the User that owns this Widget",
1392
"type": "integer"
1393
},
1394
"type": {
1395
"description": "The Module Type Code",
1396
"type": "string"
1397
},
1398
"duration": {
1399
"description": "The duration in seconds this widget should be shown",
1400
"type": "integer"
1401
},
1402
"displayOrder": {
1403
"description": "The display order of this widget",
1404
"type": "integer"
1405
},
1406
"widgetOptions": {
1407
"description": "An array of Widget Options",
1408
"type": "array",
1409
"items": {
1410
"$ref": "#/definitions/WidgetOption"
1411
}
1412
},
1413
"mediaIds": {
1414
"description": "An array of MediaIds this widget is linked to",
1415
"type": "array",
1416
"items": {
1417
"type": "integer"
1418
}
1419
},
1420
"permissions": {
1421
"description": "An array of permissions for this widget",
1422
"type": "array",
1423
"items": {
1424
"$ref": "#/definitions/Permission"
1425
}
1426
},
1427
"module": {
1428
"description": "The Module Object for this Widget"
1429
}
1430
}
1431
},
1432
"WidgetOption": {
1433
"properties": {
1434
"widgetId": {
1435
"description": "The Widget ID that this Option belongs to",
1436
"type": "integer"
1437
},
1438
"type": {
1439
"description": "The option type, either attrib or raw",
1440
"type": "string"
1441
},
1442
"option": {
1443
"description": "The option name",
1444
"type": "string"
1445
},
1446
"value": {
1447
"description": "The option value",
1448
"type": "string"
1449
}
1450
}
370
1451
}
371
1452
},
372
1453
"securityDefinitions": {
373
1454
"auth": {
374
1455
"type": "oauth2",
375
"in": "header",
376
1456
"flow": "accessCode",
377
1457
"authorizationUrl": "/application/authorize",
378
1458
"tokenUrl": "/api/authorize/access_token",
Loggerhead is a web-based interface for Breezy
Version: 2.0.1