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.
205 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:
206 **X-HTTP-Method-Override=Patch**
208 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
213 Content: Same as POST
215 Code: 400 (BAD REQUEST)
216 Content: Error message describing the bad request failure.
217 Situation: Invalid Payload or schema error.
219 Code: 403 (FORBIDDEN)
220 Content: Error message describing the Authorization failure.
221 Situation: Authorization failure.
223 Code: 415 (UNSUPPORTED MEDIA TYPE)
224 Situation: Unsupported content type .
226 Code: 500 (Internal Server Error)
227 Content: Error message describing the failure.
228 Situation: Any scenario not covered by the above error codes.
232 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
233 Method: PATCH (Content-Type header set to application/merge-patch+json)
237 "ptnii-equip-name":"e-name",
238 "resource-version":"1477013499",
239 "ipv4-oam-address":"1.2.3.99"
244 Content: Same as POST
246 Code: 400 (BAD REQUEST)
247 Content: Error message describing the bad request failure.
248 Situation: Invalid Payload or schema error.
250 Code: 403 (FORBIDDEN)
251 Content: Error message describing the Authorization failure.
252 Situation: Authorization failure.
254 Code: 415 (UNSUPPORTED MEDIA TYPE)
255 Situation: Unsupported content type .
257 Code: 500 (Internal Server Error)
258 Content: Error message describing the failure.
259 Situation: Any scenario not covered by the above error codes.
263 URL: https://<host>:9520/services/inventory/v11/pserver/<id>
268 Code: 404 (NOT FOUND)
269 Situation: Resource not found
271 Code: 403 (FORBIDDEN)
272 Content: Error message describing the Authorization failure.
273 Situation: Authorization failure.
275 Code: 415 (UNSUPPORTED MEDIA TYPE)
276 Situation: Unsupported content type .
278 Code: 500 (Internal Server Error)
279 Content: Error message describing the failure.
280 Situation: Any scenario not covered by the above error codes.