|
2 | 2 |
|
3 | 3 | |Method|Endpoint |Authentication|
|
4 | 4 | |------|----------------------------------------|--------------|
|
5 |
| -|POST |/subscriptions |yes | |
6 | 5 | |GET |/subscriptions |no |
|
7 | 6 | |GET |/subscriptions/\<name\> |no |
|
| 7 | +|GET |/subscriptions?subscriptionNames=\<name\> |no | |
| 8 | +|POST |/subscriptions |yes | |
8 | 9 | |PUT |/subscriptions |yes |
|
9 | 10 | |DELETE|/subscriptions |yes |
|
10 | 11 | |DELETE|/subscriptions/\<name\> |yes |
|
11 | 12 |
|
12 |
| -## Create Subscriptions |
13 |
| - |
14 |
| -Takes one or several subscriptions in a JSON array as input. If LDAP is |
15 |
| -activated, the username of the person registering this subscription is |
16 |
| -included when saving the subscription in the database. The subscription |
17 |
| -name needs to be unique. |
18 |
| - |
19 |
| - POST /subscriptions |
20 |
| - |
21 |
| -### Curl Command Example |
22 |
| - |
23 |
| - curl -X POST -H "Content-type: application/json" --data @<path to file> http://<host>:8090/subscriptions |
24 |
| - |
25 |
| -Eiffel Intelligence takes a JSON list of one or several subscription objects. |
26 |
| -Example of a subscription array input: |
27 |
| - |
28 |
| - [ |
29 |
| - { |
30 |
| - ..Subscription 1.. |
31 |
| - }, |
32 |
| - { |
33 |
| - ..Subscription 2.. |
34 |
| - } |
35 |
| - ] |
36 |
| - |
37 |
| - Guidelines for writing requirements and conditions for creating subscriptions can be found [here](subscriptions.md#writing-requirements-and-conditions) |
38 |
| - |
39 | 13 | ## Get All subscriptions
|
40 | 14 |
|
41 | 15 | Retrieves all the subscriptions
|
@@ -66,6 +40,33 @@ Curl command example
|
66 | 40 |
|
67 | 41 | curl -X GET -H "Content-type: application/json" http://<host>:8090/subscriptions/<name>
|
68 | 42 |
|
| 43 | +## Create Subscriptions |
| 44 | + |
| 45 | +Takes one or several subscriptions in a JSON array as input. If LDAP is |
| 46 | +activated, the username of the person registering this subscription is |
| 47 | +included when saving the subscription in the database. The subscription |
| 48 | +name needs to be unique. |
| 49 | + |
| 50 | + POST /subscriptions |
| 51 | + |
| 52 | +### Curl Command Example |
| 53 | + |
| 54 | + curl -X POST -H "Content-type: application/json" --data @<path to file> http://<host>:8090/subscriptions |
| 55 | + |
| 56 | +Eiffel Intelligence takes a JSON list of one or several subscription objects. |
| 57 | +Example of a subscription array input: |
| 58 | + |
| 59 | + [ |
| 60 | + { |
| 61 | + ..Subscription 1.. |
| 62 | + }, |
| 63 | + { |
| 64 | + ..Subscription 2.. |
| 65 | + } |
| 66 | + ] |
| 67 | + |
| 68 | + Guidelines for writing requirements and conditions for creating subscriptions can be found [here](subscriptions.md#writing-requirements-and-conditions) |
| 69 | + |
69 | 70 | ## Update Subscriptions
|
70 | 71 |
|
71 | 72 | Modify existing Subscriptions based on subscriptionName. Multiple subscriptions
|
|
0 commit comments