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
|
## Vertex APIs
### Create Vertex
Vertex payload data is validated against oxm.
* Mandatory attributes are required in payload
* Data type validation is enforced
* Defaults from oxm schema used when not specified in payload
URL: https://<host>:9520/services/inventory/v11/pserver/
Method: POST
Body:
{
"properties":{
"ptnii-equip-name":"e-name",
"equip-type":"server",
"hostname":"myhost",
"equip-vendor":"HP",
"equip-model":"DL380p-nd",
"fqdn":myhost.onap.net",
"purpose":"my-purpose",
"resource-version":"1477013499",
"ipv4-oam-address":"1.2.3.4"
}
}
Success Response:
Code: 201
Content:
{
"id":"1130672",
"type":"pserver",
"url":"services/inventory/v11/pserver/1130672",
"properties":{
"ptnii-equip-name":"e-name",
"equip-type":"server",
"hostname":"myhost",
"equip-vendor":"HP",
"equip-model":"DL380p-nd",
"fqdn":myhost.onap.net",
"purpose":"my-purpose",
"resource-version":"1477013499",
"ipv4-oam-address":"1.2.3.4"
}
}
Error Response:
Code: 400 (BAD REQUEST)
Content: Error message describing the bad request failure.
Situation: Invalid Payload or schema error.
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
Optionally, a vertex can be created by posting to an endpoint which doesn't include the vertex type.
URL: https://<host>:9520/services/inventory/v11/
Method: POST
Body:
{
"type":"pserver",
"properties":{
"ptnii-equip-name":"e-name",
"equip-type":"server",
"hostname":"myhost",
"equip-vendor":"HP",
"equip-model":"DL380p-nd",
"fqdn":myhost.onap.net",
"purpose":"my-purpose",
"resource-version":"1477013499",
"ipv4-oam-address":"1.2.3.4"
}
}
Success Response:
Code: 201
Content:
{
"id":"1130672",
"type":"pserver",
"url":"services/inventory/v11/pserver/1130672",
"properties":{
"ptnii-equip-name":"e-name",
"equip-type":"server",
"hostname":"myhost",
"equip-vendor":"HP",
"equip-model":"DL380p-nd",
"fqdn":myhost.onap.net",
"purpose":"my-purpose",
"resource-version":"1477013499",
"ipv4-oam-address":"1.2.3.4"
}
}
Error Response:
Code: 400 (BAD REQUEST)
Content: Error message describing the bad request failure.
Situation: Invalid Payload or schema error.
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
### Get Vertex
URL: https://<host>:9520/services/inventory/v11/pserver/<id>
Method: GET
Success Response:
Code: 200
Content:
{
"id":"1130672",
"type":"pserver",
"url":"services/inventory/v11/pserver/<id>",
"properties":{
"ptnii-equip-name":"e-name",
"equip-type":"server",
"hostname":"myhost",
"equip-vendor":"HP",
"equip-model":"DL380p-nd",
"fqdn":myhost.onap.net",
"purpose":"my-purpose",
"resource-version":"1477013499",
"ipv4-oam-address":"1.2.3.4"
},
"in":[
],
"out":[
{
"id":"1crwnu-6hc-d6vp-oe08g",
"type":"has",
"target":"services/inventory/v11/vserver/40964272",
"url":"services/inventory/relationships/v11/has/1crwnu-6hc-d6vp-oe08g"
}
]
}
Error Response:
Code: 404 (NOT FOUND)
Situation: Resource Not found
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
### Get Vertices
URL: https://<host>:9520/services/inventory/v11/pserver/
Optional Query Param: ?equip-vendor=HP
Method: GET
Success Response:
Code: 200
Content:
[
{
"id":"950296",
"type":"pserver",
"url":"services/inventory/v11/pserver/950296"
},
{
"id":"1126576",
"type":"pserver",
"url":"services/inventory/v11/pserver/1126576"
},
{
"id":"1032384",
"type":"pserver",
"url":"services/inventory/v11/pserver/1032384"
}
]
Error Response:
Code: 404 (NOT FOUND)
Situation: Resource Not found
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
### Get Vertices with Properties
Note: Adding query param of properties=all will return all properties
URL: https://<host>:9520/services/inventory/v11/pserver/
Optional Query Param: ?equip-vendor=HP
Optional Query Param: ?properties=hostname&properties=equip-vendor
Method: GET
Success Response:
Code: 200
Content:
[
{
"idfdsa": "1263346e-372b-4681-8ce4-d40411620487",
"type": "pserver",
"url": "services/inventory/v11/pserver/1263346e-372b-4681-8ce4-d40411620487",
"properties": {
"equip-vendor": "HP",
"hostname": "mtanjasdf119snd"
}
},
{
"idfdsa": "b57a9e54-bbb5-4e11-b537-aaa7bc8fd726",
"type": "pserver",
"url": "services/inventory/v11/pserver/b57a9e54-bbb5-4e11-b537-aaa7bc8fd726",
"properties": {
"equip-vendor": "HP",
"hostname": "mtanjasdf119snd"
}
}
]
Error Response:
Code: 404 (NOT FOUND)
Situation: Resource Not found
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
### Update Vertex
The PUT command is used to modify an existing vertex. By default, the vertex data is replaced by the content of the payload. However, teh following parameter can be added to the header to perform a PATCH instead of a replace:
**X-HTTP-Method-Override=Patch**
URL: https://<host>:9520/services/inventory/v11/pserver/<id>
Method: PUT
Body: Same as POST
Success Response:
Code: 201
Content: Same as POST
Error Response:
Code: 400 (BAD REQUEST)
Content: Error message describing the bad request failure.
Situation: Invalid Payload or schema error.
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
### Patch Vertex
URL: https://<host>:9520/services/inventory/v11/pserver/<id>
Method: PATCH (Content-Type header set to application/merge-patch+json)
Body:
{
"properties":{
"ptnii-equip-name":"e-name",
"resource-version":"1477013499",
"ipv4-oam-address":"1.2.3.99"
}
}
Success Response:
Code: 200
Content: Same as POST
Error Response:
Code: 400 (BAD REQUEST)
Content: Error message describing the bad request failure.
Situation: Invalid Payload or schema error.
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
### Delete Vertex
URL: https://<host>:9520/services/inventory/v11/pserver/<id>
Method: DELETE
Success Response:
Code: 200
Error Response:
Code: 404 (NOT FOUND)
Situation: Resource not found
Code: 403 (FORBIDDEN)
Content: Error message describing the Authorization failure.
Situation: Authorization failure.
Code: 415 (UNSUPPORTED MEDIA TYPE)
Situation: Unsupported content type .
Code: 500 (Internal Server Error)
Content: Error message describing the failure.
Situation: Any scenario not covered by the above error codes.
|
