-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStudio Server Environment.postman_environment.json
More file actions
2754 lines (2754 loc) · 180 KB
/
Copy pathStudio Server Environment.postman_environment.json
File metadata and controls
2754 lines (2754 loc) · 180 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
{
"info": {
"_postman_id": "20f7170b-fef0-4f2c-9f2e-bb40cf805403",
"name": "WoodWing Studio",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "2558053"
},
"item": [
{
"name": "Workflow",
"item": [
{
"name": "CreateObjects",
"item": [
{
"name": "CreateObjects Digital Article",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"CreateObjects\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"Lock\": false,\n \"Objects\": [\n { \n \"MetaData\": { \n \"BasicMetaData\": {\n \"Name\": \"test digital article file\",\n \"Category\": {\n \"Name\": \"News\",\n \"Id\": \"40\",\n \"__classname__\": \"Category\"\n },\n \"Type\": \"Article\",\n \"Publication\": {\n \"Id\": \"25\",\n \"Name\": \"WoodWing\",\n \"__classname__\": \"Publication\"\n },\n \"__classname__\": \"BasicMetaData\"\n },\n \"WorkflowMetaData\": {\n \"__classname__\": \"WorkflowMetaData\",\n \"Comment\": \"Gapp\",\n \"State\": {\n \"Id\": \"328\",\n \"Name\": \"Draft\",\n \"Type\": \"Article\",\n \"__classname__\": \"State\"\n }\n },\n \"RightsMetaData\": {\n \"__classname__\": \"RightsMetaData\"\n },\n \"SourceMetaData\": {\n \"__classname__\": \"SourceMetaData\"\n },\n \"ContentMetaData\": {\n \"__classname__\": \"ContentMetaData\",\n \"Format\": \"application/ww-digital+json\"\n },\n \"ExtraMetaData\": [\n \t{\n\t\t\t\t\t\t\t\t\"Property\": \"C_CS_FILEFORMATVERSION\",\n\t\t\t\t\t\t\t\t\"Values\": [\n\t\t\t\t\t\t\t\t\t\"2.4\"\n\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\t\"__classname__\": \"ExtraMetaData\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"Property\": \"C_CS_COMPONENTSET\",\n\t\t\t\t\t\t\t\t\"Values\": [\n\t\t\t\t\t\t\t\t\t\"df0afd50-9e44-4882-8324-d6e31432ce90\"\n\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\t\"__classname__\": \"ExtraMetaData\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n \t\"__classname__\": \"MetaData\"\n },\n \"Files\": [\n {\n \"Rendition\": \"native\",\n \"Type\": \"application/ww-digital+json\",\n \"FileUrl\": \"{{Studio_Server_URL}}/transferindex.php?fileguid={{Uuid_For_PUT}}\",\n \"__classname__\": \"Attachment\"\n }\n ],\n \"Targets\": [\n {\n \"PubChannel\":{\n \"Id\":\"\",\n \"Name\":\"\"\n },\n \"Issue\":{\n \"Id\":\"\",\n \"Name\":\"\",\n \"OverrulePublication\":false\n },\n \"Editions\":{\n },\n \"__classname__\": \"Targets\"\n }\n\n ],\n \"__classname__\": \"Object\"\n }\n \n ]\n }\n ],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to create objects by sending a payload to the specified endpoint. The request is made to the {{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON URL with a JSON payload in the raw request body.\n\n### Request Body\n\n- method (string): Specifies the method as \"CreateObjects\".\n \n- id (string): Represents the ID as \"33\".\n \n- params (array): Contains an array of parameters including \"Ticket\", \"Lock\", and \"Objects\".\n \n - Ticket (string): Represents the ticket value, which is a placeholder.\n \n - Lock (boolean): Indicates whether the object is locked or not.\n \n - Objects (array): Contains an array of objects with metadata and files.\n \n - MetaData (object): Contains various metadata properties such as BasicMetaData, WorkflowMetaData, RightsMetaData, SourceMetaData, ContentMetaData, and ExtraMetaData.\n \n - Files (array): Contains an array of files with properties like Rendition, Type, and FileUrl.\n \n - jsonrpc (string): Specifies the JSON-RPC version as \"2.0\".\n \n\n### Response\n\nThe response to this request will contain the result of the \"CreateObjects\" method call, along with any relevant data or error messages."
},
"response": []
},
{
"name": "CreateObjects Task with Targets",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Response status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"",
"pm.test(\"Content-Type header is 'application/json'\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include('application/json');",
"});",
"",
"",
"pm.test(\"Validate the structure of the 'result' object\", function () {",
" const responseData = pm.response.json();",
" ",
" pm.expect(responseData).to.be.an('object');",
" pm.expect(responseData.result).to.exist.and.to.be.an('object');",
"",
" // Additional checks for specific properties within the 'result' object can be added here",
"});",
"",
"",
"pm.test(\"Objects array is present and contains expected number of elements\", function () {",
" const responseData = pm.response.json();",
" ",
" pm.expect(responseData).to.be.an('object');",
" pm.expect(responseData.result.Objects).to.be.an('array');",
" pm.expect(responseData.result.Objects).to.have.lengthOf(1);",
"});",
"",
"",
"pm.test(\"Response time is less than 200ms\", function () {",
" pm.expect(pm.response.responseTime).to.be.below(200);",
"});",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"CreateObjects\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"Lock\": false,\n \"Objects\": [\n { \n \"MetaData\": { \n \"BasicMetaData\": {\n \"Name\": \"test task\",\n \"Category\": {\n \"Name\": \"News\",\n \"Id\": \"40\",\n \"__classname__\": \"Category\"\n },\n \"Type\": \"Task\",\n \"Publication\": {\n \"Id\": \"25\",\n \"Name\": \"WoodWing\",\n \"__classname__\": \"Publication\"\n },\n \"__classname__\": \"BasicMetaData\"\n },\n \"WorkflowMetaData\": {\n \"__classname__\": \"WorkflowMetaData\",\n \"Comment\": \"Gapp\",\n \"State\": {\n \"Id\": \"351\",\n \"Name\": \"Assigned\",\n \"Type\": \"Task\",\n \"__classname__\": \"State\"\n }\n },\n \"RightsMetaData\": {\n \"__classname__\": \"RightsMetaData\"\n },\n \"SourceMetaData\": {\n \"__classname__\": \"SourceMetaData\"\n },\n \"ContentMetaData\": {\n \"__classname__\": \"ContentMetaData\"\n },\n \"ExtraMetaData\": [\n\t\t\t\t\t\t],\n \t\"__classname__\": \"MetaData\"\n },\n \"Targets\": [\n {\n \"PubChannel\": {\n \"Id\": \"17\",\n \"Name\":\"Print\",\n \"__classname__\":\"PubChannel\"\n },\n \"Issue\": {\n \"Id\": \"41\",\n \"Name\":\"Week 1\",\n \"OverrulePublication\":null,\n \"__classname__\":\"Issue\"\n },\n \"Editions\": null,\n \"PublishedDate\":null,\n \"PublishedVersion\":null,\n \"__classname__\":\"Target\"\n }\n ],\n \"__classname__\": \"Object\"\n }\n \n ]\n }\n ],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "The HTTP POST request to the specified URL is used to send a payload in JSON format. The request includes parameters such as method, id, Ticket, Lock, Objects, and more. The payload is sent to the server with the aim of performing a specific action, which is determined by the provided parameters.\n\nThe response to this request is a JSON object with a status code of 200 and a content type of application/json. The response contains an \"id\" and a \"result\" object, which includes various nested properties such as MetaData, RightsMetaData, SourceMetaData, ContentMetaData, WorkflowMetaData, and more. Each of these properties contains further nested attributes with specific data types.\n\nThe JSON schema for the response can be documented based on the structure of the \"result\" object and its nested properties, including the data types and possible values for each attribute.\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"result\": {\n \"type\": \"object\",\n \"properties\": {\n \"Objects\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"MetaData\": {\n \"type\": \"object\",\n \"properties\": {\n // Nested properties and data types\n }\n },\n // Other nested properties within \"Objects\"\n }\n }\n },\n // Other properties within \"result\"\n }\n }\n }\n}\n\n ```"
},
"response": []
}
]
},
{
"name": "CreateObjectOperations",
"item": [
{
"name": "PlaceDossier - PrintArticle",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"CreateObjectOperations\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"HaveVersion\": {\n \"ID\": \"13129\", //objectId of layout\n \"Version\": \"0.69\", //object version\n \"__classname__\": \"ObjectVersion\"\n },\n \"Operations\": [\n {\n \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03a\", //generated GUID\n \"Name\": \"PlaceDossier\", //Name of operation: PlaceDossier, PlaceImage, PlaceArticleElement, ClearFrameContent, PlaceDigitalArticle\n \"Type\": \"AutomatedPrintWorkflow\", //Type: AutomatedPrintWorkflow, ContentStationDigitalEditor\n \"Params\": [\n {\n \"Name\": \"EditionId\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"DossierId\",\n \"Value\": 13130,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"InDesignArticleId\",\n \"Value\": 733,\n \"__classname__\": \"Param\"\n }\n ],\n \"__classname__\": \"ObjectOperation\"\n }\n ]\n }\n \n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### CreateObjectOperations Request\n\nThis endpoint allows you to create object operations using the specified parameters.\n\n#### Description\n\nThis call takes the ID and version of the layout that you want to place the article onto plus the ID of the Dossier AND the InDesign article ID and put an article in the Dossier onto the layout. Note that\n\n#### Request Body\n\n- `jsonrpc` (string): The JSON-RPC version being used.\n \n- `method` (string): The method to be executed, in this case, \"CreateObjectOperations\".\n \n- `id` (string): The identifier for the request.\n \n- `params` (array): An array containing the parameters for creating object operations, including the ticket, version, and operations.\n \n\n#### Operations\n\n- `Ticket` (string): The current ticket for authentication.\n \n- `HaveVersion` (object): Contains the ID, version, and class name of the layout.\n \n- `Operations` (array): An array of operations to be performed, including the ID, name, type, and parameters.\n \n\n#### Response\n\nThe response will be in JSON format and will include the following schema:\n\n``` json\n{\n \"id\": \"\",\n \"result\": {\n \"Operations\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Type\": \"\",\n \"Params\": [\n {\n \"Name\": \"\",\n \"Value\": 0,\n \"__classname__\": \"\"\n }\n ],\n \"__classname__\": \"\"\n }\n ],\n \"Reports\": [],\n \"__classname__\": \"\"\n },\n \"jsonrpc\": \"\"\n}\n\n ```\n\nThe response will contain the ID, name, type, and parameters of the operations performed."
},
"response": []
},
{
"name": "PlaceDigitalArticle",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"CreateObjectOperations\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"HaveVersion\": {\n \"ID\": \"13686\", //objectId of layout\n \"Version\": \"0.2\", //object version\n \"__classname__\": \"ObjectVersion\"\n },\n \"Operations\": [\n {\n \"__classname__\": \"ObjectOperation\",\n \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03d\", //generated GUID\n \"Name\": \"PlaceDigitalArticle\", //Name of operation: PlaceDossier, PlaceImage, PlaceArticleElement, ClearFrameContent, PlaceDigitalArticle\n \"Type\": \"ContentStationDigitalEditor\", //Type: AutomatedPrintWorkflow, ContentStationDigitalEditor\n \"Params\": [\n {\n \"Name\": \"EditionId\",\n \"Value\": \"0\",\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ArticleId\",\n \"Value\": \"13685\", //ID of the Digital Article object\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"InDesignArticleId\", //ID of the ID article, use GetObjects call to get the ID\n \"Value\": \"6979\",\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ConversionRuleSetId\", //Currently there is no public way to get this data via API. Have to use loggin\n \"Value\": \"162\",\n \"__classname__\": \"Param\" \n }\n ]\n }\n ]\n }\n \n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### CreateObjectOperations Request\n\nThis endpoint allows you to create object operations using the specified parameters.\n\n#### Description\n\nThis call takes the ID and version of the layout that you want to place the article onto plus the ID of the Dossier AND the InDesign article ID and put an article in the Dossier onto the layout. Note that\n\n#### Request Body\n\n- `jsonrpc` (string): The JSON-RPC version being used.\n \n- `method` (string): The method to be executed, in this case, \"CreateObjectOperations\".\n \n- `id` (string): The identifier for the request.\n \n- `params` (array): An array containing the parameters for creating object operations, including the ticket, version, and operations.\n \n\n#### Operations\n\n- `Ticket` (string): The current ticket for authentication.\n \n- `HaveVersion` (object): Contains the ID, version, and class name of the layout.\n \n- `Operations` (array): An array of operations to be performed, including the ID, name, type, and parameters.\n \n\n#### Response\n\nThe response will be in JSON format and will include the following schema:\n\n``` json\n{\n \"id\": \"\",\n \"result\": {\n \"Operations\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Type\": \"\",\n \"Params\": [\n {\n \"Name\": \"\",\n \"Value\": 0,\n \"__classname__\": \"\"\n }\n ],\n \"__classname__\": \"\"\n }\n ],\n \"Reports\": [],\n \"__classname__\": \"\"\n },\n \"jsonrpc\": \"\"\n}\n\n ```\n\nThe response will contain the ID, name, type, and parameters of the operations performed."
},
"response": []
},
{
"name": "PlaceArticleElement",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"CreateObjectOperations\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"HaveVersion\": {\n \"ID\": \"13129\", //objectId of layout\n \"Version\": \"0.50\", //object version\n \"__classname__\": \"ObjectVersion\"\n },\n \"Operations\": [\n {\n \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03a\", //generated GUID\n \"Name\": \"PlaceArticleElement\", \n \"Type\": \"AutomatedPrintWorkflow\", //Type: AutomatedPrintWorkflow, ContentStationDigitalEditor\n \"Params\": [\n {\n \"Name\": \"EditionId\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ArticleId\",\n \"Value\": 13130,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ElementId\",\n \"Value\": 733,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"SplineId\",\n \"Value\": 733,\n \"__classname__\": \"Param\"\n }\n ],\n \"__classname__\": \"ObjectOperation\"\n }\n ]\n }\n \n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to create object operations by sending a JSON payload to the specified endpoint. The request body includes parameters such as \"jsonrpc\", \"method\", \"id\", and \"params\" to specify the ticket, object version, operations, and their respective parameters.\n\n### Request Body\n\n- `jsonrpc` (string): The JSON-RPC version.\n \n- `method` (string): The method for creating object operations.\n \n- `id` (string): The identifier for the request.\n \n- `params` (array): An array containing the ticket, object version, and operations details.\n \n - `Ticket` (string): The current ticket.\n \n - `HaveVersion` (object): Contains the ID, version, and class name of the object version.\n \n - `ID` (string): The object ID of the layout.\n \n - `Version` (string): The object version.\n \n - `__classname__` (string): The class name of the object version.\n \n - `Operations` (array): An array of operations details.\n \n - `Id` (string): The generated GUID for the operation.\n \n - `Name` (string): The name of the operation.\n \n - `Type` (string): The type of the operation, which can be \"AutomatedPrintWorkflow\" or \"ContentStationDigitalEditor\".\n \n - `Params` (array): An array of parameters for the operation.\n \n - `Name` (string): The name of the parameter.\n \n - `Value` (string/number): The value of the parameter.\n \n - `__classname__` (string): The class name of the parameter.\n \n\n### Response Body\n\nThe response body for this request will contain the result of the object operations creation, including any relevant data or error messages."
},
"response": []
},
{
"name": "PlaceImage",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"CreateObjectOperations\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"HaveVersion\": {\n \"ID\": \"13129\", //objectId of layout\n \"Version\": \"0.56\", //object version\n \"__classname__\": \"ObjectVersion\"\n },\n \"Operations\": [\n {\n \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03b\", //generated GUID\n \"Name\": \"PlaceImage\", //Name of operation: PlaceDossier, PlaceImage, PlaceArticleElement, ClearFrameContent, PlaceDigitalArticle\n \"Type\": \"AutomatedPrintWorkflow\", //Type: AutomatedPrintWorkflow, ContentStationDigitalEditor\n \"Params\": [\n {\n \"Name\": \"EditionId\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ImageId\",\n \"Value\": 13136,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"SplineId\",\n \"Value\": 961,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ContentDx\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ContentDy\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ScaleX\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"ScaleY\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n }\n ],\n \"__classname__\": \"ObjectOperation\"\n }\n ]\n }\n \n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### CreateObjectOperations\n\nThis endpoint is used to create object operations with the provided parameters.\n\n#### Request\n\n- Method: POST\n \n- URL: `{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON`\n \n- Headers:\n \n - Content-Type: application/json\n \n- Body:\n \n - { \"jsonrpc\": \"2.0\", \"method\": \"CreateObjectOperations\", \"id\": \"33\", \"params\": \\[ { \"Ticket\": \"{{Current_Ticket}}\", \"HaveVersion\": { \"ID\": \"13129\", \"Version\": \"0.56\", \"__classname__\": \"ObjectVersion\" }, \"Operations\": \\[ { \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03b\", \"Name\": \"PlaceImage\", \"Type\": \"AutomatedPrintWorkflow\", \"Params\": \\[ { \"Name\": \"EditionId\", \"Value\": 0, \"__classname__\": \"Param\" }, { \"Name\": \"ImageId\", \"Value\": 13136, \"__classname__\": \"Param\" }, { \"Name\": \"SplineId\", \"Value\": 961, \"__classname__\": \"Param\" }, { \"Name\": \"ContentDx\", \"Value\": 0, \"__classname__\": \"Param\" }, { \"Name\": \"ContentDy\", \"Value\": 0, \"__classname__\": \"Param\" }, { \"Name\": \"ScaleX\", \"Value\": 0, \"__classname__\": \"Param\" }, { \"Name\": \"ScaleY\", \"Value\": 0, \"__classname__\": \"Param\" } \\], \"__classname__\": \"ObjectOperation\" } \\] } \\]}\n \n\n#### Response\n\n- Status: 200\n \n- Content-Type: application/json\n \n- { \"type\": \"object\", \"properties\": { \"id\": {\"type\": \"string\"}, \"result\": { \"type\": \"object\", \"properties\": { \"Operations\": { \"type\": \"array\", \"items\": { \"type\": \"object\", \"properties\": { \"Id\": {\"type\": \"string\"}, \"Name\": {\"type\": \"string\"}, \"Type\": {\"type\": \"string\"}, \"Params\": { \"type\": \"array\", \"items\": { \"type\": \"object\", \"properties\": { \"Name\": {\"type\": \"string\"}, \"Value\": {\"type\": \"number\"}, \"__classname__\": {\"type\": \"string\"} } } }, \"__classname__\": {\"type\": \"string\"} } } }, \"Reports\": {\"type\": \"array\"}, \"__classname__\": {\"type\": \"string\"} } }, \"jsonrpc\": {\"type\": \"string\"} } }"
},
"response": []
},
{
"name": "Clear Frame Content",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"CreateObjectOperations\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"HaveVersion\": {\n \"ID\": \"13129\", //objectId of layout\n \"Version\": \"0.18\", //object version\n \"__classname__\": \"ObjectVersion\"\n },\n \"Operations\": [\n {\n \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03a\", //generated GUID\n \"Name\": \"ClearFrameContent\", //Name of operation: PlaceDossier, PlaceImage, PlaceArticleElement, ClearFrameContent, PlaceDigitalArticle\n \"Type\": \"AutomatedPrintWorkflow\", //Type: AutomatedPrintWorkflow, ContentStationDigitalEditor\n \"Params\": [\n {\n \"Name\": \"EditionId\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"SplineId\",\n \"Value\": 703,\n \"__classname__\": \"Param\"\n }\n ],\n \"__classname__\": \"ObjectOperation\"\n }\n ]\n }\n \n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### CreateObjectOperations\n\nThis endpoint is used to create object operations with the provided parameters.\n\n#### Request Body\n\n- `jsonrpc` (string): The JSON-RPC version.\n \n- `method` (string): The method name, in this case, \"CreateObjectOperations\".\n \n- `id` (string): The ID of the request.\n \n- `params` (array): An array of parameters containing the ticket, version, and operations details.\n \n\nExample:\n\n``` json\n{\n \"jsonrpc\": \"2.0\",\n \"method\": \"CreateObjectOperations\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"HaveVersion\": {\n \"ID\": \"13129\",\n \"Version\": \"0.18\",\n \"__classname__\": \"ObjectVersion\"\n },\n \"Operations\": [\n {\n \"Id\": \"10be2025-9e15-4a4d-8af0-899808b9b03a\",\n \"Name\": \"ClearFrameContent\",\n \"Type\": \"AutomatedPrintWorkflow\",\n \"Params\": [\n {\n \"Name\": \"EditionId\",\n \"Value\": 0,\n \"__classname__\": \"Param\"\n },\n {\n \"Name\": \"SplineId\",\n \"Value\": 703,\n \"__classname__\": \"Param\"\n }\n ],\n \"__classname__\": \"ObjectOperation\"\n }\n ]\n }\n ]\n}\n\n ```\n\n#### Response\n\n- `id` (string): The ID of the response.\n \n- `result` (object): The result object containing operations and reports.\n \n - `Operations` (array): An array of operations with their details.\n \n - `Reports` (array): An array of reports.\n \n - `__classname__` (string): The class name of the result object.\n \n- `jsonrpc` (string): The JSON-RPC version.\n \n\nExample:\n\n``` json\n{\n \"id\": \"\",\n \"result\": {\n \"Operations\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Type\": \"\",\n \"Params\": [\n {\n \"Name\": \"\",\n \"Value\": 0,\n \"__classname__\": \"\"\n }\n ],\n \"__classname__\": \"\"\n }\n ],\n \"Reports\": [],\n \"__classname__\": \"\"\n },\n \"jsonrpc\": \"\"\n}\n\n ```"
},
"response": []
}
]
},
{
"name": "Objects and Targets",
"item": [
{
"name": "CreateObjectTargets",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"CreateObjectTargets\",\n \"id\": \"33\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"IDs\":[\"13460\"], // this can be an array of IDs\n \"Targets\": [\n {\n \"PubChannel\": {\n \"Id\": \"17\",\n \"Name\":\"Print\",\n \"__classname__\":\"PubChannel\"\n },\n \"Issue\": {\n \"Id\": \"41\",\n \"Name\":\"Week 1\",\n \"OverrulePublication\":null,\n \"__classname__\":\"Issue\"\n },\n \"Editions\": null,\n \"PublishedDate\":null,\n \"PublishedVersion\":null,\n \"__classname__\":\"Target\"\n }\n ]\n }\n ],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### CreateObjectTargets\n\nThis endpoint allows the client to create object targets using the specified parameters.\n\n#### Request Body\n\n- method (string): The method being called, in this case, \"CreateObjectTargets\".\n \n- id (string): The identifier for the request, in this case, \"33\".\n \n- params (array): An array of parameters containing the ticket, IDs, and targets.\n \n - Ticket (string): The current ticket for authentication.\n \n - IDs (array): An array of IDs for the targets.\n \n - Targets (array): An array of target objects containing details about the publication channel, issue, editions, published date, and published version.\n \n\n#### Response\n\nThe response is in the form of a JSON schema.\n\n``` json\n{\n \"id\": \"\",\n \"result\": {\n \"IDs\": [\"\"],\n \"Targets\": [\n {\n \"PubChannel\": {\n \"Id\": \"\",\n \"Name\": \"\",\n \"__classname__\": \"\"\n },\n \"Issue\": {\n \"Id\": \"\",\n \"Name\": \"\",\n \"OverrulePublication\": null,\n \"__classname__\": \"\"\n },\n \"Editions\": [],\n \"PublishedDate\": null,\n \"PublishedVersion\": null,\n \"__classname__\": \"\"\n }\n ],\n \"__classname__\": \"\"\n },\n \"jsonrpc\": \"\"\n}\n\n ```\n\nThe response schema includes empty values for the IDs, PubChannel, Issue, Editions, PublishedDate, and PublishedVersion."
},
"response": []
}
]
},
{
"name": "LogOn",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"LogOn\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"User\":\"{{User_Name}}\",\n\t\t\t\"Password\":\"{{Password}}\",\n\t\t\t\"ClientName\":\"postman\",\n\t\t\t\"ClientAppName\":\"postman_sample_requests\",\n \"ClientAppVersion\":\"1.0\",\n \"ClientAppSerial\":\"\",\n \"RequestInfo\":[\"ServerInfo\"],\n\t\t\t\"__classname__\":\"WflLogOnRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}"
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This endpoint makes an HTTP POST request to the specified URL with the provided payload. The request body contains a JSON object with the \"method\", \"id\", and \"Params\" fields. The \"Params\" field further contains a \"req\" object with various parameters such as \"User\", \"Password\", \"ClientName\", \"ClientAppName\", \"ClientAppVersion\", \"ClientAppSerial\", and \"RequestInfo\". The \"**classname**\" field is also present in the \"req\" object.\n\nThe user has requested to document the response of this request as a JSON schema."
},
"response": [],
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"LogOn succeeded and ticket was returned\", function () {",
" pm.response.to.have.status(200);",
"",
" const response = pm.response.json();",
"",
" if (response.error) {",
" throw new Error(\"LogOn failed: \" + JSON.stringify(response.error));",
" }",
"",
" pm.expect(response.result, \"Response is missing 'result'\").to.exist;",
" pm.expect(response.result.Ticket, \"Response is missing 'result.Ticket'\").to.exist;",
"",
" pm.environment.set(\"Current_Ticket\", response.result.Ticket);",
"});",
"",
"console.log(\"Current_Ticket set to:\", pm.environment.get(\"Current_Ticket\"));"
],
"type": "text/javascript",
"packages": {}
}
}
]
},
{
"name": "QueryObjects",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"QueryObjects\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n\t\t\t\"Params\": [\t\n\t\t\t\t\t\t{ \"__classname__\": \"QueryParam\", \"Property\": \"Type\", \"Operation\": \"=\", \"Value\": \"Layout\" },\n { \"__classname__\": \"QueryParam\", \"Property\": \"Publication\", \"Operation\": \"=\", \"Value\": \"WW News\" }\n\t\t\t\t\t],\n\t\t\t\t\t\"FirstEntry\": 1,\n\t\t\t\t\t\"MaxEntries\": 50,\n\t\t\t\t\t\"Hierarchical\": false,\n\t\t\t\t\t\"MinimalProps\": [ \"ID\", \n\t\t\t\t\t\t\t\t\t \"Type\",\n\t\t\t\t\t\t\t\t\t\t\"Name\"\n\t\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\"RequestProps\": [ \"ID\", \n\t\t\t\t\t\t\t\t\t \"Type\",\n\t\t\t\t\t\t\t\t\t\t\"Name\",\n \"Publication\",\n \"Issue\",\n \"C_PM_BOARD\"\n\t\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\"Areas\": null,\n\t\t\t\t\t\"GetObjectMode\": false,\n \"__classname__\": \"WflQueryObjectsRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### Endpoint Description\n\nThis endpoint is a POST request to the specified URL and directory with the protocol parameter set to JSON. It is used to send a request with a specific payload and expects a response.\n\n### Request Body\n\n- The request body should be in raw format and should include the following parameters:\n \n - method (string): The method to be executed.\n \n - id (string): The identifier for the request.\n \n - params (object): An object containing the request parameters.\n \n - req (object): The main request object.\n \n - Ticket (string): A ticket for authorization.\n \n - Params (array): An array of parameters with classname, property, operation, and value.\n \n - FirstEntry (null): Indicates the first entry.\n \n - MaxEntries (null): Indicates the maximum number of entries.\n \n - Hierarchical (boolean): Specifies if the request is hierarchical.\n \n - MinimalProps (array): An array of minimal properties.\n \n - RequestProps (array): An array of request properties.\n \n - Areas (null): Indicates the areas.\n \n - GetObjectMode (boolean): Specifies the object mode.\n \n - **classname** (string): The class name for the request.\n \n\n### Response\n\nThe response to this request will vary based on the specific method and parameters provided in the request body. It is expected to be in JSON format and will contain the result of the requested method execution."
},
"response": []
},
{
"name": "GetObjects",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"GetObjects\",\n \"id\": \"2\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"IDs\": [\n \"{{Object_ID}}\"\n ],\n \"Lock\": false,\n \"Rendition\": \"native\",\n \"RequestInfo\": [\n \"Pages\", \"Targets\", \"Files\", \"Relations\"\n ],\n \"HaveVersions\": [],\n \"Areas\": null,\n \"EditionId\": \"\",\n \"SupportedContentSources\": [],\n \"__classname__\": \"WflGetObjectsRequest\"\n }\n ],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to send a payload to the specified endpoint. The request body is in raw format and contains a JSON object with the keys \"method\", \"id\", \"params\", and \"jsonrpc\". The \"method\" key specifies the method to be executed, and the \"params\" key holds an array of parameters including \"Ticket\", \"IDs\", \"Lock\", \"Rendition\", \"RequestInfo\", \"HaveVersions\", \"Areas\", \"EditionId\", \"SupportedContentSources\", and \"**classname**\". The \"id\" key is used to identify the request, and the \"jsonrpc\" key specifies the JSON-RPC version.\n\nUpon successful execution, the response will contain the result of the requested method along with any relevant data."
},
"response": []
},
{
"name": "SaveObjects",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"SaveObjects\",\n \"id\": \"2\",\n \"params\": [\n {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"CreateVersion\": false,\n \"ForceCheckIn\": false\n \"Unlock\": false,\n \"Rendition\": \"native\",\n \"RequestInfo\": [\n \"Relations\",\n \"PagesInfo\",\n \"InDesignArticles\"\n ],\n \"HaveVersions\": [],\n \"Areas\": null,\n \"EditionId\": \"\",\n \"SupportedContentSources\": [],\n \"__classname__\": \"WflSaveObjectsRequest\"\n }\n ],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to save objects by sending a payload to the specified endpoint. The request body is in raw format and contains a JSON object with parameters such as method, id, and params. The \"method\" parameter specifies the action to be performed, while the \"params\" array includes various attributes for the save operation. The \"jsonrpc\" parameter indicates the JSON-RPC version used for the request.\n\nThe response to this request will include the result of the save operation, providing information about the success or failure of the action along with any relevant data."
},
"response": []
},
{
"name": "CopyObject",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"CopyObject\",\n \"id\": \"2\",\n \"params\": [\n {\n \n \"Ticket\": \"{{Current_Ticket}}\",\n \"SourceID\": \"{{Object_ID}}\",\n \"MetaData\":{\n \"BasicMetaData\": {\n \"Name\": \"copied layout\",\n \"Category\": {\n \"Name\": \"News\",\n \"Id\": \"40\",\n \"__classname__\": \"Category\"\n },\n \"Type\": \"Layout\",\n \"Publication\": {\n \"Id\": \"25\",\n \"Name\": \"WoodWing\",\n \"__classname__\": \"Publication\"\n },\n \"__classname__\": \"BasicMetaData\"\n },\n \"WorkflowMetaData\": {\n \"Comment\": \"\",\n \"State\": {\n \"Id\": \"341\",\n \"Name\": \"Draft\",\n \"Type\": \"Layout\",\n \"__classname__\": \"State\"\n },\n \"__classname__\": \"WorkflowMetaData\"\n },\n \"RightsMetaData\": {\n \"__classname__\": \"RightsMetaData\"\n },\n \"SourceMetaData\": {\n \"__classname__\": \"SourceMetaData\"\n },\n \"ContentMetaData\": {\n \"Format\": \"application/indesign\",\n \"__classname__\": \"ContentMetaData\"\n },\n \"ExtraMetaData\": null,\n \"__classname__\":\"MetaData\"\n },\n \"Targets\":[{\n \"PubChannel\": {\n \"Id\": \"17\",\n \"Name\": \"Print\",\n \"__classname__\": \"PubChannel\"\n },\n \"Issue\": {\n \"Id\": \"41\",\n \"Name\": \"Week 1\",\n \"OverrulePublication\": null,\n \"__classname__\": \"Issue\"\n },\n \"Editions\": null,\n \"PublishedDate\": null,\n \"PublishedVersion\": null,\n \"__classname__\": \"Target\"\n }],\n \"Relations\":[{\n \"Parent\": \"14765\",\n \"Type\": \"Contained\",\n \"__classname__\": \"Relation\"\n }],\n \"__classname__\": \"Object\"\n }\n ],\n \"jsonrpc\": \"2.0\"\n \n}\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to save objects by sending a payload to the specified endpoint. The request body is in raw format and contains a JSON object with parameters such as method, id, and params. The \"method\" parameter specifies the action to be performed, while the \"params\" array includes various attributes for the save operation. The \"jsonrpc\" parameter indicates the JSON-RPC version used for the request.\n\nThe response to this request will include the result of the save operation, providing information about the success or failure of the action along with any relevant data."
},
"response": []
},
{
"name": "SetObjectProperties",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"SetObjectProperties\",\n \"id\": \"1\",\n \"params\": [{\n \"Ticket\": \"{{Current_Ticket}}\",\n \"ID\": \"6\",\n \"MetaData\": {\n \"BasicMetaData\": null,\n \"RightsMetaData\": null,\n \"SourceMetaData\": null,\n \"ContentMetaData\": null,\n \"WorkflowMetaData\": {\n \"__classname__\": \"WorkflowMetaData\",\n \"State\": {\n \"__classname__\": \"State\",\n \"Id\": \"6\",\n \"Name\": \"Images\"\n }\n },\n \"ExtraMetaData\": null,\n \"__classname__\": \"MetaData\"\n },\n \"Targets\": [{\n \"PubChannel\": {\n \"Id\": \"3\",\n \"Name\": \"Other\",\n \"__classname__\": \"PubChannel\"\n },\n \"Issue\": {\n \"Id\": \"4\",\n \"Name\": \"Other Issue\",\n \"OverrulePublication\": null,\n \"Sections\": null,\n \"States\": null,\n \"Editions\": null,\n \"Description\": null,\n \"Subject\": null,\n \"PublicationDate\": null,\n \"ReversedRead\": null,\n \"__classname__\": \"Issue\"\n },\n \"Editions\": [ ],\n \"Published date\": null,\n \"Published version\": null,\n \"Classname\": \"Target\"\n }],\n \"__classname__\": \"WflSetObjectPropertiesRequest\"\n }],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "The HTTP POST request to `{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON` is used to send a payload in order to set object properties. The payload includes a method to set object properties, an ID, and various parameters such as Ticket, ID, MetaData, and Targets. The request body is in raw JSON format and contains specific details related to the object properties being set.\n\n### Response\n\nThe response of this request is a JSON schema. The structure of the response will follow a predefined schema format and will include the properties and their data types as per the response from the server."
},
"response": []
},
{
"name": "SetObjectProperties Custom Field",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"SetObjectProperties\",\n \"id\": \"1\",\n \"params\": [{\n \"Ticket\": \"{{Current_Ticket}}\",\n \"ID\": \"{{Object_ID}}\",\n \"MetaData\": {\n \"BasicMetaData\": null,\n \"RightsMetaData\": null,\n \"SourceMetaData\": null,\n \"ContentMetaData\": null,\n \"WorkflowMetaData\": {\n \"Comment\": \"This is my comment\",\n \"__classname__\": \"WorkflowMetaData\"\n },\n \"ExtraMetaData\": [{\n \t\"Property\": \"C_TW_COLLECTION_ID\",\n \"Values\": [\"sent to twitter\"],\n \t\"__classname__\": \"ExtraMetaData\"\n }],\n \"__classname__\": \"MetaData\"\n },\n \"Targets\": null,\n \"__classname__\": \"WflSetObjectPropertiesRequest\"\n }],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to send a request to set object properties to the specified server directory in JSON format. The request payload includes a method to set object properties, along with various parameters such as Ticket, ID, MetaData, and Targets. The MetaData parameter consists of BasicMetaData, RightsMetaData, SourceMetaData, ContentMetaData, WorkflowMetaData, and ExtraMetaData, each with their respective values. The user also wants to document the response of this request as a JSON schema."
},
"response": []
},
{
"name": "GetPublications",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"GetPublications\",\n \"id\": \"1\",\n \"params\": [{\n \"Ticket\": \"{{Current_Ticket}}\",\n \"IDs\": null,\n \"RequestInfo\": [\"PubChannels\"],\n \"__classname__\": \"WflGetPublicationsRequest\"\n }],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to send a payload to the specified endpoint. The request body is in raw format and contains a JSON payload with the method \"GetPublications\", an ID, and additional parameters. The \"Ticket\" parameter is expected to be replaced with a specific value, and the \"RequestInfo\" parameter includes \"PubChannels\". The \"**classname**\" parameter is also included in the request.\n\nThe response body for this request will contain the result of the \"GetPublications\" method call, along with any relevant data based on the provided parameters."
},
"response": []
},
{
"name": "GetStates",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"GetStates\",\n \"id\": \"4\",\n \"jsonrpc\": \"2.0\",\n \"params\": {\n \"req\": {\n \"Ticket\": \"{{Current_Ticket}}\",\n \"ID\": \"\",\n \"Publication\": {\n \"Id\": 30,\n \"Name\": \"WW News\",\n \"__classname__\": \"Publication\"\n },\n \"Type\": \"Layout\",\n \"__classname__\": \"WflGetStatesRequest\"\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### POST\n\nThis endpoint is used to make a POST request to retrieve states using a specific method.\n\n#### Request Body\n\n- **method** (string, required): Specifies the method as \"GetStates\".\n \n- **id** (string, required): An identifier for the request.\n \n- **params** (array, required): An array of parameters including \"Ticket\", \"ID\", \"Publication\", \"Issue\", \"Section\", \"Type\", and \"**classname**\".\n \n - **Ticket** (string, required): Represents the current ticket.\n \n - **ID** (string, optional): Represents the ID.\n \n - **Publication** (string, required): Specifies the publication.\n \n - **Issue** (null, optional): Represents the issue.\n \n - **Section** (null, optional): Represents the section.\n \n - **Type** (string, required): Specifies the type as \"Layout\".\n \n - **classname** (string, required): Represents the class name as \"WflGetStatesRequest\".\n \n- **jsonrpc** (string, required): Specifies the JSON-RPC version as \"2.0\".\n \n\n#### Response (JSON Schema)\n\n``` json\n{\n \"type\": \"object\",\n \"properties\": {\n \"result\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"state\": { \"type\": \"string\" },\n \"code\": { \"type\": \"integer\" }\n },\n \"required\": [\"state\", \"code\"]\n }\n },\n \"id\": { \"type\": \"string\" },\n \"jsonrpc\": { \"type\": \"string\" }\n },\n \"required\": [\"result\", \"id\", \"jsonrpc\"]\n}\n\n ```"
},
"response": []
},
{
"name": "DeleteObjects",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"DeleteObjects\",\n \"id\": \"2\",\n \"params\": [{\n \"Ticket\": \"{{Current_Ticket}}\",\n \"IDs\": [\"{{Object_ID}}\"],\n \"Permanent\": false,\n \"Areas\": [\"Workflow\"],\n \"Context\": \"\",\n \"__classname__\": \"WflDeleteObjectsRequest\"\n }],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "## POST\n\nThis endpoint allows you to send a POST request to delete objects using the specified parameters.\n\n### Request Body\n\n- **method** (string) - Specifies the method as \"DeleteObjects\".\n \n- **id** (string) - Specifies the ID as \"2\".\n \n- **params** (array) - Contains the parameters for the deletion operation.\n \n - **Ticket** (string) - Represents the ticket for authorization.\n \n - **IDs** (array) - Contains the IDs of the objects to be deleted.\n \n - **Permanent** (boolean) - Indicates whether the deletion is permanent or not.\n \n - **Areas** (array) - Specifies the areas from which the objects will be deleted.\n \n - **Context** (string) - Represents the context for the deletion operation.\n \n - **classname** (string) - Represents the class name for the deletion request.\n \n- **jsonrpc** (string) - Specifies the JSON-RPC version as \"2.0\".\n \n\n### Response\n\nThe response to this request will contain the outcome of the delete operation."
},
"response": []
},
{
"name": "GetUsers",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"GetUsers\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n\t\t\t\"Params\": [\t\n\t\t\t\t\t\t{ \"__classname__\": \"QueryParam\", \"Property\": \"UserID\", \"Operation\": \"=\", \"Value\": \"woodwing\" }\n ]\n\t\t},\n\t\t\t\"__classname__\": \"WflGetUsersRequest\"\n\t\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to retrieve user data by sending a request to the specified URL with the specified payload. The request body is in raw format and contains information about the method, id, parameters, and JSON-RPC version.\n\n### Response\n\nThe response of this request is a JSON schema representing the structure of the response data. It includes the properties and their data types that can be expected in the response when making this request."
},
"response": []
},
{
"name": "GetServerInfo",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"GetServerInfo\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n\t\t\t\"__classname__\": \"WflGetServerInfoRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is made in order to retrieve server information. The request payload is in raw JSON format and includes the method, id, params, and jsonrpc fields.\n\n### Request Body\n\n- `method` (string): Specifies the method as \"GetServerInfo\".\n \n- `id` (string): Represents the identifier as \"1\".\n \n- `params` (object): Contains the request object with keys like \"req\" and \"**classname**\".\n \n - `req` (object): Includes the \"Ticket\" and \"**classname**\" fields for the WflGetServerInfoRequest.\n \n- `jsonrpc` (string): Indicates the JSON-RPC version as \"2.0\".\n \n\n### Response\n\nThe response of this request is documented as a JSON schema."
},
"response": []
},
{
"name": "GetUserGroups",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"GetUserGroups\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n\t\t\t\"__classname__\": \"WflGetUserGroupsRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to send a payload to the specified endpoint. The request body is in raw format and contains a JSON object with parameters such as method, id, and params. The method parameter is set to \"GetUserGroups\" and the id parameter is set to \"1\". The params object includes a req property with Ticket and **classname** attributes. The Ticket attribute is set to a value and **classname** is set to \"WflGetUserGroupsRequest\". The jsonrpc property is set to \"2.0\".\n\nThe response to this request will contain the result of the GetUserGroups method call, along with any relevant data or error information."
},
"response": []
},
{
"name": "GetUserProfile",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"GetUserProfile\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n \"RequestInfo\":[\"Memberships\"],\n\t\t\t\"__classname__\": \"WflGetUserProfileRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This endpoint makes an HTTP POST request to the specified URL with the provided payload in the raw request body. The request includes a method \"GetUserProfile\" along with an ID and parameters. The \"Ticket\" and \"RequestInfo\" are part of the parameters. The response of this request will be documented as a JSON schema."
},
"response": []
},
{
"name": "GetUserSettings",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"GetUserSettings\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n \"Settings\":[],\n\t\t\t\"__classname__\": \"WflGetUserSettingsRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to retrieve user settings by sending a JSON payload to the specified server directory. The request body includes a method, an ID, and parameters containing a ticket, an array of settings, and a classname. The server expects the payload in JSON format and responds with the relevant user settings."
},
"response": []
},
{
"name": "GetNamedQueries",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"GetNamedQueries\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n\t\t\t\"__classname__\": \"WflGetNamedQueriesRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "### POST\n\nThis endpoint is used to make a POST request to retrieve named queries. The request body should be in JSON format.\n\n#### Request Body\n\n- `method` (string): Specifies the method as \"GetNamedQueries\".\n \n- `id` (string): Specifies the id as \"1\".\n \n- `params` (object): Contains the parameters for the request.\n \n - `req` (object): Contains the request details.\n \n - `Ticket` (string): Represents the ticket information.\n \n - `__classname__` (string): Specifies the class name as \"WflGetNamedQueriesRequest\".\n \n- `jsonrpc` (string): Specifies the JSON-RPC version as \"2.0\".\n \n\n#### Response\n\nThe response will contain the result of the named queries retrieval."
},
"response": []
},
{
"name": "CheckTicket",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"method\": \"CheckTicket\",\n\t\"id\": \"1\",\n\t\"params\": {\n\t\t\"req\": {\n\t\t\t\"Ticket\": \"{{Current_Ticket}}\",\n\t\t\t\"__classname__\": \"WflCheckTicketRequest\"\n\t\t}\n\t},\n\t\"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "This HTTP POST request is used to send a payload to the specified endpoint. The request is made to {{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php with the protocol parameter set to JSON.\n\n### Request Body\n\n- **method** (string) - The method being called, in this case, \"CheckTicket\".\n \n- **id** (string) - The unique identifier for the request, in this case, \"1\".\n \n- **params** (object) - An object containing the request parameters.\n \n - **req** (object) - An object containing the ticket information.\n \n - **Ticket** (string) - The ticket value.\n \n - **classname** (string) - The class name for the request, in this case, \"WflCheckTicketRequest\".\n \n- **jsonrpc** (string) - The version of the JSON-RPC protocol being used, in this case, \"2.0\".\n \n\n### Response\n\nThe response of this request is documented as a JSON schema."
},
"response": []
},
{
"name": "UnlockObjects",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"UnlockObjects\",\n \"id\": \"1\",\n \"params\": [{ \n \"Ticket\": \"{{Current_Ticket}}\",\n \"IDs\": [ \"{{Object_ID}}\" ],\n \"ReadMessageIDs\": \"\",\n \"MessageList\": null,\n \"__classname__\": \"WflUnlockRequest\"\n }],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"
],
"path": [
"{{Studio_Server_Directory}}",
"index.php"
],
"query": [
{
"key": "protocol",
"value": "JSON"
}
]
},
"description": "\n### UnlockObjects Request\n\nThis endpoint makes an HTTP POST request to `{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON` to unlock specific objects.\n\n#### Request Body\n- method (string) - The method to be executed, in this case, \"UnlockObjects\".\n- id (string) - The identifier for the request, in this case, \"1\".\n- params (array) - An array containing the parameters for the request.\n - Ticket (string) - The ticket for authentication.\n - IDs (array) - An array of object IDs to be unlocked.\n - ReadMessageIDs (string) - The IDs of read messages.\n - MessageList (null) - A placeholder for message list.\n - __classname__ (string) - The class name for the request, in this case, \"WflUnlockRequest\".\n- jsonrpc (string) - The JSON-RPC version, in this case, \"2.0\".\n\n#### Response (JSON Schema)\nThe response of this request follows the JSON schema defined by the API.\n\n"
},
"response": []
},
{
"name": "LogOff",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"LogOff\",\n \"id\": \"1\",\n \"params\": [{ \n \"Ticket\": \"{{Current_Ticket}}\",\n \"__classname__\": \"WflLogOffRequest\"\n }],\n \"jsonrpc\": \"2.0\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON",
"host": [
"{{Studio_Server_URL}}"