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
|
.. _collection_lab:
lab
---
GET
***
.. http:get:: /lab/(string:lab_id)
Get all the available registered lab or a single one if ``lab_id`` is
provided.
:param lab_id: The ID of the lab to retrieve.
:type lab_id: string
:reqheader Authorization: The token necessary to authorize the request.
:reqheader Accept-Encoding: Accept the ``gzip`` coding.
:resheader Content-Type: Will be ``application/json; charset=UTF-8``.
:query int limit: Number of results to return. Default 0 (all results).
:query int skip: Number of results to skip. Default 0 (none).
:query string sort: Field to sort the results on. Can be repeated multiple times.
:query int sort_order: The sort order of the results: -1 (descending), 1
(ascending). This will be applied only to the first ``sort``
parameter passed. Default -1.
:query int date_range: Number of days to consider, starting from today
(:ref:`more info <intro_schema_time_date>`). By default consider all results.
:query string field: The field that should be returned in the response. Can be
repeated multiple times.
:query string nfield: The field that should *not* be returned in the response. Can be repeated multiple times.
:query string _id: The internal ID of the registered lab.
:query string created_on: The creation date: accepted formats are ``YYYY-MM-DD`` and ``YYYYMMDD``.
:query string name: The name of the lab.
:query boolean private: If the lab is private or not.
:query string token: The token ID associated with the lab.
:status 200: Resuslts found.
:status 403: Not authorized to perform the operation.
:status 404: The provided resource has not been found.
:status 500: Internal database error.
**Example Requests**
.. sourcecode:: http
GET /lab/ HTTP/1.1
Host: api.armcloud.us
Accept: */*
Authorization: token
.. sourcecode:: http
GET /boot/lab-01 HTTP/1.1
Host: api.armcloud.us
Accept: */*
Authorization: token
**Example Responses**
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Tue, 10 Nov 2014 12:28:50 GMT
Content-Type: application/json; charset=UTF-8
{
"code": 200,
"result": [
{
"name": "lab-01",
"private": false,
"address": {
"street_1": "Example street"
},
"contact": {
"name": "Name",
"surname": "Surname",
"email": "example@example.net"
}
},
],
}
.. note::
Results shown here do not include the full JSON response.
POST
****
.. http:post:: /lab/(string:lab_id)
Create or update a lab document as defined in the JSON data. If ``lab_id`` is
provided, it will perform an update.
For more info on all the required JSON request fields, see the :ref:`lab
schema <schema_lab>`.
:reqjson string name: The name that should be given to the lab.
:reqjson object contact: The contact data associated with the lab.
:reqheader Authorization: The token necessary to authorize the request.
:reqheader Content-Type: Content type of the transmitted data, must be ``application/json``.
:reqheader Accept-Encoding: Accept the ``gzip`` coding.
:resheader Content-Type: Will be ``application/json; charset=UTF-8``.
:status 200: The request has been accepted and the lab updated.
:status 201: The request has been accepted and the lab created.
:status 400: JSON data not valid, or provided name for the lab already exists.
:status 403: Not authorized to perform the operation.
:status 404: The provided ``lab_id`` was not found.
:status 415: Wrong content type.
:status 422: No real JSON data provided.
**Example Requests**
.. sourcecode:: http
POST /lab HTTP/1.1
Host: api.armcloud.us
Content-Type: application/json
Accept: */*
Authorization: token
{
"name": "lab-01",
"contact": {
"name": "Name",
"surname": "Surname",
"email": "example@example.net"
}
}
DELETE
******
.. http:delete:: /lab/(string:lab_id)
Delete the lab entry identified by ``lab_id``.
:param lab_id: The ID of the lab document to delete.
:type lab_id: string
:reqheader Authorization: The token necessary to authorize the request.
:reqheader Accept-Encoding: Accept the ``gzip`` coding.
:resheader Content-Type: Will be ``application/json; charset=UTF-8``.
:query string _id: The internal ID of the registered lab.
:query string private: If the lab is private or not.
:query string token: The token ID associated with the lab.
:status 200: Resource deleted.
:status 403: Not authorized to perform the operation.
:status 404: The provided resource has not been found.
:status 500: Internal database error.
**Example Requests**
.. sourcecode:: http
DELETE /lab/lab-01 HTTP/1.1
Host: api.armcloud.us
Accept: */*
Content-Type: application/json
Authorization: token
.. sourcecode:: http
DELETE /lab?private=true HTTP/1.1
Host: api.armcloud.us
Accept: */*
Content-Type: application/json
Authorization: token
More Info
*********
* :ref:`Lab schema <schema_lab>`
* :ref:`API results <intro_schema_results>`
|
