Skip to content

Commit 12a0ea0

Browse files
committed
Update Web API doc with new API options
1 parent 56d092b commit 12a0ea0

File tree

1 file changed

+74
-6
lines changed

1 file changed

+74
-6
lines changed

doc/web-api.md

Lines changed: 74 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,104 @@ currentMenu: web-api
55

66
# Web API
77

8-
## IntegrationJob Endpoint
8+
<h2>CronTrigger Endpoint <small>&ge;2.0.0</small></h2>
9+
10+
The CronTrigger endpoint allows for an integration job to be scheduled by creating and manipulating a Quartz.NET CronTrigger.
11+
12+
### Get a List of CronTriggers
13+
GET api/CronTrigger
14+
```sh
15+
curl http://localhost:9001/api/CronTrigger
16+
```
17+
18+
### Get a Specific CronTrigger by ID
19+
GET api/CronTrigger/ID
20+
```sh
21+
curl http://localhost:9001/api/CronTrigger/ID
22+
```
23+
24+
### Create a New CronTrigger
25+
POST api/CronTrigger
26+
```sh
27+
curl --data "JobType=MyProject.MyIntegrationJob" http://localhost:9001/api/CronTrigger
28+
```
29+
30+
### Update a Specific CronTrigger by ID
31+
PUT api/CronTrigger/ID
32+
```sh
33+
curl -XPUT "JobType=MyProject.ADifferentIntegrationJob" http://localhost:9001/api/CronTrigger/ID
34+
```
35+
36+
### Delete a CronTrigger by ID
37+
DELETE api/CronTrigger/ID
38+
```sh
39+
curl -XDELETE http://localhost:9001/api/CronTrigger/ID
40+
```
41+
42+
<h2>SimpleTrigger Endpoint <small>&ge;2.0.0</small></h2>
43+
44+
The SimpleTrigger endpoint allows for an integration job to be scheduled by creating and manipulating a Quartz.NET SimpleTrigger.
45+
46+
### Get a List of SimpleTriggers
47+
GET api/SimpleTrigger
48+
```sh
49+
curl http://localhost:9001/api/SimpleTrigger
50+
```
51+
52+
### Get a Specific SimpleTrigger by ID
53+
GET api/SimpleTrigger/ID
54+
```sh
55+
curl http://localhost:9001/api/SimpleTrigger/ID
56+
```
57+
58+
### Create a New SimpleTrigger
59+
POST api/SimpleTrigger
60+
```sh
61+
curl --data "JobType=MyProject.MyIntegrationJob" http://localhost:9001/api/SimpleTrigger
62+
```
63+
64+
### Update a Specific SimpleTrigger by ID
65+
PUT api/SimpleTrigger/ID
66+
```sh
67+
curl -XPUT "JobType=MyProject.ADifferentIntegrationJob" http://localhost:9001/api/SimpleTrigger/ID
68+
```
69+
70+
### Delete a SimpleTrigger by ID
71+
DELETE api/SimpleTrigger/ID
72+
```sh
73+
curl -XDELETE http://localhost:9001/api/SimpleTrigger/ID
74+
```
75+
76+
<h2>IntegrationJob Endpoint <small>&le;1.4.1</small></h2>
977

1078
The IntegrationJob endpoint allows for an integration job to be scheduled, updated, and viewed.
1179

1280
### Get a List of Jobs
1381
GET api/IntegrationJob
14-
```
82+
```sh
1583
curl http://localhost:9001/api/IntegrationJob
1684
```
1785

1886
### Get a Specific Job by ID
1987
GET api/IntegrationJob/ID
20-
```
88+
```sh
2189
curl http://localhost:9001/api/IntegrationJob/ID
2290
```
2391

2492
### Create a New Job
2593
POST api/IntegrationJob
26-
```
94+
```sh
2795
curl --data "JobType=MyProject.MyIntegrationJob" http://localhost:9001/api/IntegrationJob
2896
```
2997

3098
### Update a Specific Job by ID
3199
PUT api/IntegrationJob/ID
32-
```
100+
```sh
33101
curl -XPUT "JobType=MyProject.ADifferentIntegrationJob" http://localhost:9001/api/IntegrationJob/ID
34102
```
35103

36104
### Delete a Job by ID
37105
DELETE api/IntegrationJob/ID
38-
```
106+
```sh
39107
curl -XDELETE http://localhost:9001/api/IntegrationJob/ID
40108
```

0 commit comments

Comments
 (0)