forked from FutureGateway/FutureGateway-APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
1429 lines (1095 loc) · 43 KB
/
apiary.apib
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
FORMAT: 1A
# FutureGateway APIs
FutureGateway APIs are a set of APIs designed to allow Science Gateways (SGs) to
interact with remote infrastructures. The APIs allow the administrator to manage
the infrastructures linked by the API server, and the user to interact with them.
APIs use a token to authenticate and authorise the users. The format is **JWT**
and it is released by a trust entity, generally a Science Gateway
or an application connected with it, which has the control on the user privileges.
The token will contain the user name and the associated roles. The APIs server
is able to validate the token autonomously and verify if the roles included are
enough for the requested operation.
# FutureGateway API Root [/]
This resource return the versions available in the server with the link to access them.
It is recommend to follow the “url” link values,
[Link](https://tools.ietf.org/html/rfc5988) or Location headers where
applicable to retrieve resources. Instead of constructing your own URLs,
to keep your client decoupled from implementation details.
## Retrieve the Entry Point [GET]
+ Response 200 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Link: </>; rel="self", </v1.0>; rel="v1.0"
+ Body
{
"versions": [
{
"id": "v1.0",
"_links": [
{
"rel": "self",
"href": "/v1.0"
}
],
"media-types": [
{
"type": "application/vnd.indigo-datacloud.apiserver+json",
}
],
"status": "prototype",
"updated": "2015-08-30T00:00:00Z"
}
],
"_links": [
{
"rel": "self",
"href": "/"
}
]
}
## Group v1.0
The version 1.0 provides the minimum set of APIs to submit jobs in different infrastructures.
Several aspects will not be address in this version and will be integrated in future releases.
## Task Collection [/v1.0/tasks{?page}{?per_page}{?status}{?user}{?application}]
A *task* is any activity a user send to an infrastructure, such as a run a job in a grid computing
site or deploy a VM in a cloud.
+ Parameters
+ page: 1 (optional, number) - The page of tasks to return.
+ per_page: 20 (optional, number) - The number of tasks per page to return.
+ status: any (optional, string) - A filter to get only the tasks with the specified status.
+ user: any (optional, string) - A filter to get only the tasks submitted by
a specific user. Only the admin can retrieve tasks submitted by different users.
+ application: any (optional, string) - A filter to get only the tasks associated to
a specific application.
### List all tasks [GET]
Retrieve the list of tasks submitted by the user defined in the token. The list includes all the
submitted tasks to the system. If the search has to be limited to a subset the attribute filter
has to be used.
+ Request Auth
+ Headers
Authorization: Bearer {access_token}
+ Response 200 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Link: </v1.0/tasks?page=1>; rel="self",</v1.0/tasks?page=2>; rel="next"
+ Body
{
"tasks": [
{
"id": "123",
"description": "This is my nice task 123",
"status": "WAITING",
"date": "2014-11-11T12:37:23.423Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/123"
}
]
}.
{
"id": "456",
"description": "This is my nice task 456",
"status": "RUNNING",
"date": "2014-11-11T09:12:34.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/456"
}
]
}.
{
"id": "789",
"description": "This is my nice task 789",
"status": "DONE",
"date": "2014-11-11T08:40:51.620Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/789"
}
]
}
],
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks?page=1",
},
{
"rel": "next",
"href": "/v1.0/tasks?page=2",
}
]
}
### Create a task [POST]
Create a new task with the following attributes:
+ **application** *(string)* - Id of the application for the task. The application has to be
already registered in the server in order to generate the task;
+ **arguments** *(array[string])* - Arguments to provide to the application;
+ **input_files** *(array[object])* - Name of input file for the application. These should be provided
in order to make the task scheduled. If omitted the task is immediately ready to start.
+ **output_files** *(array[string])* - List of output files produced by the application in addition to
the stdout and stderr.
The input files have to be submitted after the creation of the task. The status will be waiting until
a **POST** is performed of the input files. The URL to submit the files is returned in the **HTTP Header**
of the **POST** as **Link** with `rel="input"`.
+ Request (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Authorization: Bearer {access_token}
+ Body
{
"application": "543",
"description": "This is my nice task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m"
}
]
}
+ Response 201 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Location: /v1.0/tasks/1234
Link: </v1.0/tasks/1234/input>; rel="input", </v1.0/tasks/1234>; rel="self"
+ Body
{
"id": "1234",
"application": "543",
"description": "This is my nice task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m",
"status": "NEEDED"
}
],
"status": "WAITING",
"user": "user_name"
"date": "2014-11-11T12:12:00.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/1234"
},
{
"rel": "input",
"href": "/v1.0/tasks/1234/input"
}
]
}
+ Response 403
User is not allow to create a task
### Replace the task list [PUT]
Replacing the full list of task is not acceptable. A bulk operation can be performed using the
**PATCH** method.
+ Response 405
+ Headers
Allow: GET, POST, PATCH, DELETE
### Add multiple tasks to the list [PATCH]
Create a new task with the following attributes:
+ **application** *(string)* - Id of the application for the task. The application has to be
already registered in the server in order to generate the task;
+ **arguments** *(array[string])* - Arguments to provide to the application;
+ **input_files** *(array[string])* - Name of input files for the application. Files have to be provided
in order to make the task scheduled. If omitted the task is immediately ready to start.
+ **output_files** *(array[string])* - List of output files produced by the application in addition to
the stdout and stderr.
The input files has to be submitted after the creation of the tasks. The status will be waiting until
a *POST* is performed of the input files.
+ Request (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Authorization: Bearer {access_token}
+ Body
{
"tasks": [
{
"application": "543",
"description": "This is my nice task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m"
}
]
},
{
"application": "765",
"description": "This is my second task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_gromacs_file.gromacs"
}
]
}
]
}
+ Response 201 (application/vnd.indigo-datacloud.apiserver+json)
+ Body
{
"tasks": [
{
"id": "1234",
"application": "543",
"description": "This is my nice task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m",
"status": "NEEDED"
}
],
"status": "WAITING",
"user": "user_name"
"date": "2014-11-11T12:12:00.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/1234"
},
{
"rel": "input",
"href": "/v1.0/tasks/1234/input"
}
]
},
{
"id": "1235",
"application": "765",
"description": "This is my second task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_gromacs_file.gromacs",
"status": "NEEDED"
}
],
"status": "WAITING",
"user": "user_name"
"date": "2014-11-11T12:12:00.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/1234"
},
{
"rel": "input",
"href": "/v1.0/tasks/1234/input"
}
]
}
]
}
### Delete the task list [DELETE]
Remove all tasks
+ Request Auth
+ Headers
Authorization: Bearer {access_token}
+ Response 204
+ Response 403
User is not allow to remove the task list
+ Response 404
No tasks found
## Task [/v1.0/tasks/{task_id}]
A Task object has the following attributes:
+ **id** *(string)*- The id of the task.
+ **date** *(date)* - An ISO8601 date when the task was created.
+ **last_change** *(date)* - An ISO8601 date when the task status was updated.
+ **application** *(string)* - The id of the application associated with the task.
+ **infrastructure_task** *(string)* - The id of a task creating the infrastructure where this task will run.
If the infrastructure is virtual, generated by an application, this task should be associated
with the application generating the infrastructure so the execution of the task will be in the
corresponding infrastructure. If omitted a task will be executed to generate
the infrastructure when the infrastructure is virtual. If the infrastructure is not virtual
this attribute will be ignored.
+ **description** *(string)* - A user provided description of the task.
+ **status** *(string)* - The current status of the task. Possible values are:
- **WAITING**: Task created but input still required
- **READY**: Task ready to be scheduled to the infrastructure
- **SCHEDULED**: Task ready to execute in the selected infrastructure
- **RUNNING**: In execution
- **DONE**: Task completed
- **ABORTED**: Some error prevent the task from the execution
- **CANCELLED**: Task deleted by the user
+ **user** *(string)* - The user name submitting the task. This is retrieved from the token and if
provided has to coincide.
+ **arguments** *(array[string])* - Arguments to provide to the application.
+ **input_files** *(array[string] | array[object])* - Input file for the application.
When the task is create a list of filename is provided as input_files. These files
have to be uploaded in order to make the task `SCHEDULED`. The task detail provide
an object for the each input file with the attributes: **name** and **status**.
The **status** can be `NEEDED` if the input file has not been provided or `READY`
otherwise.
+ **output_files** *(array[string] | array[object])* - Output files of the application.
During the task creation the user can specify a list of files to retrieve after
the execution. The task details provides an object for each output file containing
the name and the URL for download.
+ **runtime_data** *(array[object])* - Information of the running task provided back to
the user. This is needed to allow users to interact with the application. As an
example, for a task running a VM the runtime_data can contains the ip address
and the credentials. The format is similar to parameters with the addition of
two optional time fields: *creation* and *last_change*.
+ Parameters
+ task_id: 1234 (required, string) - ID of the Task
### View a Tasks Details [GET]
Retrieves the details of the specified task.
+ Request Auth
+ Headers
Authorization: Bearer {access_token}
+ Response 200 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Link: </v1.0/tasks/1234>; rel="self"
+ Body
{
"id": "1234",
"application": "543",
"description": "This is my nice task",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m",
"status": "READY"
}
],
"status": "RUNNING",
"user": "user_name",
"runtime_data": [
{
"name": "data_1",
"value": "value_1",
"description": "This define something",
"creation" : "2014-11-11T12:12:00.421Z",
"last_change": "2014-11-11T12:12:01.352Z"
},
{
"name": "data_2",
"value": "value_2"
}
]
"date": "2014-11-11T12:12:00.421Z",
"last_change": "2014-11-11T12:12:00.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/1234"
}
]
}
+ Response 403
User is not allow to retrieve details for the task
### Create a new task [PUT]
This method will create a new task with a specific `ID` assigned by the user. If the
`id` already exist the task is not modified but an error is returned to the user because
the tasks are not modifiable but only some parameters which have specific APIs for
their update.
+ Request (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Authorization: Bearer {access_token}
+ Body
{
"id": "1234",
"application": "543",
"description": "This is my nice task",
"infrastructure_task": "1233",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m"
}
],
"output_files": [
{
"name": "mydata.csv"
}
]
}
+ Response 201 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Location: /v1.0/tasks/1234
Link: </v1.0/tasks/1234/input>; rel="input", </v1.0/tasks/1234>; rel="self"
+ Body
{
"id": "1234",
"application": "543",
"description": "This is my nice task",
"infrastructure_task": "1233",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m",
"status": "NEEDED"
}
],
"output_files": [
{
"name": "mydata.csv",
"url": null
}
]
"status": "WAITING",
"user": "user_name"
"date": "2014-11-11T12:12:00.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/1234"
},
{
"rel": "input",
"href": "/v1.0/tasks/1234/input"
}
]
}
+ Response 403
Users should not be able to update entirely the task after the submission. APIs for some values, like
the description, are provided.
### Modify a task [PATCH]
This method will modify the task with a specific `ID` assigned by the user.
Currently only the status can be modified and the only value accepted is `CANCELLED`.
This has the effect to stop the task, free the associated resources and clean the temporary
storage.
+ Request (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Authorization: Bearer {access_token}
+ Body
{
"status": "CANCELLED",
}
+ Response 201 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Location: /v1.0/tasks/1234
Link: </v1.0/tasks/1234/input>; rel="input", </v1.0/tasks/1234>; rel="self"
+ Body
{
"id": "1234",
"application": "543",
"description": "This is my nice task",
"infrastructure_task": "1233",
"arguments": [
"arg_1",
"arg_2",
"arg_3",
"arg_4"
],
"input_files": [
{
"name": "my_matlab_file.m",
"status": "READY"
}
],
"output_files": [
{
"name": "mydata.csv",
"url": null
}
]
"status": "CANCELLED",
"user": "user_name"
"date": "2014-11-11T12:12:00.421Z",
"_links": [
{
"rel": "self",
"href": "/v1.0/tasks/1234"
},
{
"rel": "input",
"href": "/v1.0/tasks/1234/input"
}
]
}
+ Response 403
User is not authorised to modify the task.
### Delete a task [DELETE]
+ Request
+ Headers
Authorization: Bearer {access_token}
+ Response 204
+ Response 403
User is not allow to remove the task list
+ Response 404
No tasks found
## Application Collection [/v1.0/applications{?page}{?per_page}]
The *application* represents the entity a user can submit to a remote infrastructure. This can
be a Job in a computing grid, a VM in a cloud or other. The definition includes also the
infrastructures where they can be submitted.
+ Parameters
+ page: 1 (optional, number) - The page of tasks to return;
+ per_page: 20 (optional, number) - The number of tasks per page to return.
### List all applications [GET]
Retrieve the list of applications the user is enabled to access.
+ Request Auth
+ Headers
Authorization: Bearer {access_token}
+ Response 200 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Link: </v1.0/applications?page=1>; rel="self",</v1.0/applications?page=2>; rel="next"
+ Body
{
"applications": [
{
"id": "123",
"name": "app1",
"infrastructures": ["id_infra_1"],
"date": "2015-05-11T12:12:00.421Z",
"outcome": "JOB",
"enabled": true,
"_links": [
{
"rel": "self",
"href": "/v1.0/applications/123"
}
]
}.
{
"id": "456",
"name": "app2",
"infrastructures": ["id_infra_2"],
"date": "2015-07-15T16:12:20.537Z",
"outcome": "JOB",
"enabled": true,
"_links": [
{
"rel": "self",
"href": "/v1.0/applications/456"
}
]
}.
{
"id": "789",
"name": "app3",
"infrastructures": ["id_infra_3"],
"date": "2015-11-11T18:42:32.289Z",
"outcome": "RESOURCE",
"enabled": false,
"_links": [
{
"rel": "self",
"href": "/v1.0/applications/789"
}
]
}
],
"_links": [
{
"rel": "self",
"href": "/v1.0/applications?page=1",
},
{
"rel": "next",
"href": "/v1.0/applications?page=2",
}
]
}
### Add a new application [POST]
Add a new application using the following attributes:
+ **description** *(string)* - A verbose description of the application.
+ **name** *(string)* - User friendly name of the application.
+ **infrastructures** *(array[string])* - A list of infrastructure ids associated with the application.
+ **outcome** *(string)* - If the value is `JOB` the application can allow to execute job. If
the value is `RESOURCE` the application allows to create resources, like virtual
machines, containers, etc.... When not specified the default value is `JOB`.
+ **enabled** *(boolean)* - `true` if the users, having the right, can execute the application,
`false` otherwise.
+ **parameters** *(array[object])* - Parameters to set-up for the execution environment. Each parameter
contains different attributes defined by the context and may vary from application to application.
+ Request (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Authorization: Bearer {access_token}
+ Body
{
"name": "my_app",
"description": "This is the app: my_app",
"infrastructures": ["id_infra_2"],
"outcome": "JOB",
"parameters": [
{
"name": "param_1",
"value": "value_1",
"description": "This define something"
},
{
"name": "param_2",
"value": "value_2"
}
],
"enabled": true
}
+ Response 201 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Location: /v1.0/applications/456
Link: </v1.0/applications/456>; rel="self"
+ Body
{
"id": "456",
"name": "my_app",
"description": "This is the app: my_app",
"infrastructures": ["id_infra_2"],
"outcome": "JOB",
"parameters": [
{
"name": "param_1",
"value": "value_1",
"description": "This define something"
},
{
"name": "param_2",
"value": "value_2"
}
],
"date": "2014-11-11T12:12:00.421Z",
"enabled": true,
"_links": [
{
"rel": "self",
"href": "/v1.0/applications/456"
}
]
}
+ Response 403
This operation is allowed only to the administrators
### Remove all applications [DELETE]
+ Request Auth
+ Headers
Authorization: Bearer {access_token}
+ Response 204
+ Response 403
User is not allow to remove the applications list
+ Response 404
No applications found
## Application [/v1.0/applications/{application_id}]
An application object has the following attributes:
+ **id** *(string)* - The id of the application.
+ **description** *(string)* - A verbose description of the application.
+ **name** *(string)* - User friendly name of the application.
+ **date** *(date)* - An ISO8601 date when the application was created.
+ **infrastructures** *(array[string])* - A list of infrastructure ids associated with the application.
+ **outcome** *(string)* - If the value is `JOB` the application can allow to execute job. If
the value is `RESOURCE` the application allows to create resources, like virtual
machines, containers, etc.... When not specified the default value is `JOB`.
+ **enabled** *(boolean)* - `true` if the users, having the right, can execute the application,
`false` otherwise.
+ **parameters** *(array[object])* - Parameters to set-up for the execution environment. Each parameter
contains different attributes defined by the context and may vary from application to application.
+ Parameters
+ application_id: 1234 (required, string) - ID of the Application
### View an Application Details [GET]
Retrieves the details of the specified application.
+ Request Auth
+ Headers
Authorization: Bearer {access_token}
+ Response 200 (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Link: </v1.0/applications/1234>; rel="self"
+ Body
{
"id": "1234",
"name": "app3",
"description": "This is the app: app3",
"infrastructures": ["id_infra_3"],
"outcome": "JOB",
"parameters": [
{
"name": "param_1",
"value": "value_1",
"description": "This define something"
},
{
"name": "param_2",
"value": "value_2"
}
],
"date": "2014-11-11T12:12:00.421Z",
"enabled": true,
"_links": [
{
"rel": "self",
"href": "/v1.0/applications/1234"
}
]
}
### Update an Application [PUT]
Add a new application or modifying an existing one, using the following attributes:
+ **description** *(string)* - A verbose description of the application.
+ **name** *(string)* - User friendly name of the application.
+ **infrastructures** *(array[string])* - The id of the infrastructure associated with the application.
+ **enabled** *(boolean)* - `true` if the users, having the right, can execute the application,
`false` otherwise.
+ **parameters** *(array[object])* - Parameters to set-up for the execution environment. Each parameter
contains different attributes defined by the context and may vary from application to application.
The creation date cannot be modified by the user.
+ Request (application/vnd.indigo-datacloud.apiserver+json)
+ Headers
Authorization: Bearer {access_token}
+ Body
{
"id": "1234",
"name": "my_app",
"description": "This is the app: my_app",
"infrastructures": ["id_infra_2"],
"parameters": [
{
"name": "param_1",
"value": "value_1",
"description": "This define something"
},
{
"name": "param_2",
"value": "value_2"
}
],
"enabled": true
}
+ Response 200
Application updated correctly.
+ Response 201 (application/vnd.indigo-datacloud.apiserver+json)