diff options
author | Daniel Silverthorn <daniel.silverthorn@amdocs.com> | 2018-01-22 11:28:42 -0500 |
---|---|---|
committer | Daniel Silverthorn <daniel.silverthorn@amdocs.com> | 2018-01-22 11:45:36 -0500 |
commit | a0e716dc093cd8a4a4ec8aaca7bc1635e518527a (patch) | |
tree | 03aa30d5191e087ebd0c8c803b87a3f163cdb369 /VERTEX.md | |
parent | f4c0fb22527af010761fee9955504bac72ca55db (diff) |
Add query parameters to get properties
Issue-ID: AAI-685
Change-Id: Id06a08ef668591560d276ef8a79c095f31d8c85b
Signed-off-by: Daniel Silverthorn <daniel.silverthorn@amdocs.com>
Diffstat (limited to 'VERTEX.md')
-rw-r--r-- | VERTEX.md | 47 |
1 files changed, 46 insertions, 1 deletions
@@ -198,7 +198,52 @@ Optionally, a vertex can be created by posting to an endpoint which doesn't incl Code: 500 (Internal Server Error) Content: Error message describing the failure. - Situation: Any scenario not covered by the above error codes. + 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 |