-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
127 lines (114 loc) · 5.73 KB
/
index.html
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
<!DOCTYPE html>
<html>
<body>
<h1 id="energy_group012-cli-reference">REST API for Softeng NTUA class 2019. CLI Reference </h1>
<p><a href="https://oclif.io"><img src="https://img.shields.io/badge/cli-oclif-brightgreen.svg" alt="oclif"></a></p>
<!-- toc -->
<ul>
<li><a href="#usage">Usage</a></li>
<li><a href="#commands">Commands</a><!-- tocstop -->
<h1 id="usage">Usage</h1>
<!-- usage -->
<pre><code class="language-sh-session">
Before using the CLI clone into repository and run
$ chmod +x setupServer.sh
$ ./setupServer.sh
Open a new terminal, go to repository folder and type
$ chmod +x setupCLI.sh
$ ./setupCLI.sh
For help type
$ energy_group012 -h
$ energy_group012 --help [COMMAND]
USAGE
$ energy_group012 COMMAND --flag1 value1 --flag2 value2
</code></pre>
<!-- usagestop -->
<h1 id="commands">Commands</h1>
<!-- commands --></li>
<li><a href="#energy_group012-login"><code>energy_group012 Login</code></a></li>
<li><a href="#energy_group012-logout"><code>energy_group012 Logout</code></a></li>
<li><a href="#energy_group012-admin"><code>energy_group012 Admin</code></a></li>
<li><a href="#energy_group012-actualtotalload"><code>energy_group012 ActualTotalLoad</code></a></li>
<li><a href="#energy_group012-actualvsforecast"><code>energy_group012 ActualvsForecast</code></a></li>
<li><a href="#energy_group012-aggregatedgenerationpertype"><code>energy_group012 AggregatedGenerationPerType</code></a></li>
<li><a href="#energy_group012-dayaheadtotalloadforecast"><code>energy_group012 DayAheadTotalLoadForecast</code></a></li>
<li><a href="#energy_group012-healthcheck"><code>energy_group012 HealthCheck</code></a></li>
<li><a href="#energy_group012-reset"><code>energy_group012 Reset</code></a></li>
<li><a href="#energy_group012-help-command"><code>energy_group012 help</code></a></li>
</ul>
<h2 id="energy_group012-login"><code>energy_group012 Login</code></h2>
<p>Login to use Energy CLI</p>
<pre><code>USAGE
$ energy_group012 Login
OPTIONS
-h, --help show CLI help
--passw=passw (required) Required ,no spaces allowed
--username=username (required) Required</code></pre>
<h2 id="energy_group012-logout"><code>energy_group012 Logout</code></h2>
<p>Logout from CLI</p>
<pre><code>USAGE
$ energy_group012 Logout
OPTIONS
-f, --force
-h, --help show CLI help</code></pre><h2 id="energy_group012-admin"><code>energy_group012 Admin</code></h2>
<p>Admin priviliges only</p>
<pre><code>USAGE
$ energy_group012 Admin
OPTIONS
-h, --help show CLI help
--moduser=username Modify user
--newuser=username Create new user
--email=email Required
--passw=passw Required , no spaces allowed
--quota=quota Required
--newdata=newdata
--source=file.csv
--userstatus=username Check userstatus</code></pre><h2 id="energy_group012-actualtotalload"><code>energy_group012 ActualTotalLoad</code></h2>
<p>Search ActualTotalLoad Dataset</p>
<pre><code>USAGE
$ energy_group012 ActualTotalLoad
OPTIONS
--area=area (required) Give Area Name to Search
--date=date Date format : YYYY-MM-DD. Exclude to get Current Date
--format=json|csv [default: json] Output format : json | csv
--timeres=PT15M|PT30M|PT60M (required) Give Time Resolution</code></pre><h2 id="energy_group012-actualvsforecast"><code>energy_group012 ActualvsForecast</code></h2>
<p>Compare ActualvsForecast Dataset</p>
<pre><code>USAGE
$ energy_group012 ActualvsForecast
OPTIONS
--area=area (required) Give Area Name to Search
--date=date Date format : YYYY-MM-DD. Exclude to get Current Date
--format=json|csv [default: json] Output format : json | csv
--timeres=PT15M|PT30M|PT60M (required) Give Time Resolution</code></pre><h2 id="energy_group012-aggregatedgenerationpertype"><code>energy_group012 AggregatedGenerationPerType</code></h2>
<p>Search AggregatedGenerationPerType Dataset</p>
<pre><code>USAGE
$ energy_group012 AggregatedGenerationPerType
OPTIONS
--area=area (required) Give Area Name to Search
--date=date Date format : YYYY-MM-DD. Exclude to get Current Date
--format=json|csv [default: json] Output format : json | csv
--productiontype=productiontype [default: AllTypes] Give Generation Type
--timeres=PT15M|PT30M|PT60M (required) Give Time Resolution</code></pre><h2 id="energy_group012-dayaheadtotalloadforecast"><code>energy_group012 DayAheadTotalLoadForecast</code></h2>
<p>Search DayAheadTotalLoadForecast Dataset</p>
<pre><code>USAGE
$ energy_group012 DayAheadTotalLoadForecast
OPTIONS
--area=area (required) Give Area Name to Search
--date=date Date format : YYYY-MM-DD. Exclude to get Current Date
--format=json|csv [default: json] Output format : json | csv
--timeres=PT15M|PT30M|PT60M (required) Give Time Resolution</code></pre><h2 id="energy_group012-healthcheck"><code>energy_group012 HealthCheck</code></h2>
<p>Check e2e connectivity</p>
<pre><code>USAGE
$ energy_group012 HealthCheck</code></pre><h2 id="energy_group012-reset"><code>energy_group012 Reset</code></h2>
<p>Drop collections</p>
<pre><code>USAGE
$ energy_group012 Reset</code></pre><h2 id="energy_group012-help-command"><code>energy_group012 help [COMMAND]</code></h2>
<p>display help for energy_group012</p>
<pre><code>USAGE
$ energy_group012 help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI</code></pre><!-- commandsstop -->
</body>
</html>