5 Vertex payload data is validated against oxm.
6 * Mandatory attributes are required in payload
7 * Data type validation is enforced
8 * Defaults from oxm schema used when not specified in payload
10 URL: https://<host>:9520/services/inventory/v11/pserver/
15 "ptnii-equip-name":"e-name",
16 "equip-type":"server",
19 "equip-model":"DL380p-nd",
20 "fqdn":myhost.onap.net",
21 "purpose":"my-purpose",
22 "resource-version":"1477013499",
23 "ipv4-oam-address":"1.2.3.4"
32 "url":"services/inventory/v11/pserver/1130672",
34 "ptnii-equip-name":"e-name",
35 "equip-type":"server",
38 "equip-model":"DL380p-nd",
39 "fqdn":myhost.onap.net",
40 "purpose":"my-purpose",
41 "resource-version":"1477013499",
42 "ipv4-oam-address":"1.2.3.4"
46 Code: 400 (BAD REQUEST)
47 Content: Error message describing the bad request failure.
48 Situation: Invalid Payload or schema error.
51 Content: Error message describing the Authorization failure.
52 Situation: Authorization failure.
54 Code: 415 (UNSUPPORTED MEDIA TYPE)
55 Situation: Unsupported content type .
57 Code: 500 (Internal Server Error)
58 Content: Error message describing the failure.
59 Situation: Any scenario not covered by the above error codes.
61 Optionally, a vertex can be created by posting to an endpoint which doesn't include the vertex type.
63 URL: https://<host>:9520/services/inventory/v11/
69 "ptnii-equip-name":"e-name",
70 "equip-type":"server",
73 "equip-model":"DL380p-nd",
74 "fqdn":myhost.onap.net",
75 "purpose":"my-purpose",
76 "resource-version":"1477013499",
77 "ipv4-oam-address":"1.2.3.4"
86 "url":"services/inventory/v11/pserver/1130672",
88 "ptnii-equip-name":"e-name",
89 "equip-type":"server",
92 "equip-model":"DL380p-nd",
93 "fqdn":myhost.onap.net",
94 "purpose":"my-purpose",
95 "resource-version":"1477013499",
96 "ipv4-oam-address":"1.2.3.4"
100 Code: 400 (BAD REQUEST)
101 Content: Error message describing the bad request failure.
102 Situation: Invalid Payload or schema error.
104 Code: 403 (FORBIDDEN)
105 Content: Error message describing the Authorization failure.
106 Situation: Authorization failure.
108 Code: 415 (UNSUPPORTED MEDIA TYPE)
109 Situation: Unsupported content type .
111 Code: 500 (Internal Server Error)
112 Content: Error message describing the failure.
113 Situation: Any scenario not covered by the above error codes.
117 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
125 "url":"services/inventory/v11/pserver/<id>",
127 "ptnii-equip-name":"e-name",
128 "equip-type":"server",
131 "equip-model":"DL380p-nd",
132 "fqdn":myhost.onap.net",
133 "purpose":"my-purpose",
134 "resource-version":"1477013499",
135 "ipv4-oam-address":"1.2.3.4"
141 "id":"1crwnu-6hc-d6vp-oe08g",
143 "target":"services/inventory/v11/vserver/40964272",
144 "url":"services/inventory/relationships/v11/has/1crwnu-6hc-d6vp-oe08g"
149 Code: 404 (NOT FOUND)
150 Situation: Resource Not found
152 Code: 403 (FORBIDDEN)
153 Content: Error message describing the Authorization failure.
154 Situation: Authorization failure.
156 Code: 415 (UNSUPPORTED MEDIA TYPE)
157 Situation: Unsupported content type .
159 Code: 500 (Internal Server Error)
160 Content: Error message describing the failure.
161 Situation: Any scenario not covered by the above error codes.
165 URL: https://<host>:9520/services/inventory/v11/pserver/
166 Optional Query Param: ?equip-vendor=HP
175 "url":"services/inventory/v11/pserver/950296"
180 "url":"services/inventory/v11/pserver/1126576"
185 "url":"services/inventory/v11/pserver/1032384"
189 Code: 404 (NOT FOUND)
190 Situation: Resource Not found
192 Code: 403 (FORBIDDEN)
193 Content: Error message describing the Authorization failure.
194 Situation: Authorization failure.
196 Code: 415 (UNSUPPORTED MEDIA TYPE)
197 Situation: Unsupported content type .
199 Code: 500 (Internal Server Error)
200 Content: Error message describing the failure.
201 Situation: Any scenario not covered by the above error codes.
203 ### Get Vertices with Properties
204 Note: Adding query param of properties=all will return all properties
206 URL: https://<host>:9520/services/inventory/v11/pserver/
207 Optional Query Param: ?equip-vendor=HP
208 Optional Query Param: ?properties=hostname&properties=equip-vendor
215 "idfdsa": "1263346e-372b-4681-8ce4-d40411620487",
217 "url": "services/inventory/v11/pserver/1263346e-372b-4681-8ce4-d40411620487",
219 "equip-vendor": "HP",
220 "hostname": "mtanjasdf119snd"
224 "idfdsa": "b57a9e54-bbb5-4e11-b537-aaa7bc8fd726",
226 "url": "services/inventory/v11/pserver/b57a9e54-bbb5-4e11-b537-aaa7bc8fd726",
228 "equip-vendor": "HP",
229 "hostname": "mtanjasdf119snd"
234 Code: 404 (NOT FOUND)
235 Situation: Resource Not found
237 Code: 403 (FORBIDDEN)
238 Content: Error message describing the Authorization failure.
239 Situation: Authorization failure.
241 Code: 415 (UNSUPPORTED MEDIA TYPE)
242 Situation: Unsupported content type .
244 Code: 500 (Internal Server Error)
245 Content: Error message describing the failure.
246 Situation: Any scenario not covered by the above error codes.
250 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:
251 **X-HTTP-Method-Override=Patch**
253 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
258 Content: Same as POST
260 Code: 400 (BAD REQUEST)
261 Content: Error message describing the bad request failure.
262 Situation: Invalid Payload or schema error.
264 Code: 403 (FORBIDDEN)
265 Content: Error message describing the Authorization failure.
266 Situation: Authorization failure.
268 Code: 415 (UNSUPPORTED MEDIA TYPE)
269 Situation: Unsupported content type .
271 Code: 500 (Internal Server Error)
272 Content: Error message describing the failure.
273 Situation: Any scenario not covered by the above error codes.
277 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
278 Method: PATCH (Content-Type header set to application/merge-patch+json)
282 "ptnii-equip-name":"e-name",
283 "resource-version":"1477013499",
284 "ipv4-oam-address":"1.2.3.99"
289 Content: Same as POST
291 Code: 400 (BAD REQUEST)
292 Content: Error message describing the bad request failure.
293 Situation: Invalid Payload or schema error.
295 Code: 403 (FORBIDDEN)
296 Content: Error message describing the Authorization failure.
297 Situation: Authorization failure.
299 Code: 415 (UNSUPPORTED MEDIA TYPE)
300 Situation: Unsupported content type .
302 Code: 500 (Internal Server Error)
303 Content: Error message describing the failure.
304 Situation: Any scenario not covered by the above error codes.
308 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
313 Code: 404 (NOT FOUND)
314 Situation: Resource not found
316 Code: 403 (FORBIDDEN)
317 Content: Error message describing the Authorization failure.
318 Situation: Authorization failure.
320 Code: 415 (UNSUPPORTED MEDIA TYPE)
321 Situation: Unsupported content type .
323 Code: 500 (Internal Server Error)
324 Content: Error message describing the failure.
325 Situation: Any scenario not covered by the above error codes.