How to use POST /network-device/location

[Nathan Sowatskey]

Hi

The attached image shows the documentation for POST /network-device/location.

The documentation says that it "Associates the given location to the given device".

The actual argument is a NetworkDeviceNIO, not a given location or device.

I can't actually see a "location" field in the NetworkDeviceNIO. The closest is a "snmpLocation".

So, how is this API supposed to be used please?

Many thanks

Nathan

[Joe Clarke]

I agree this is confusing.  However, there is a "location" element in the NetworkDeviceNIO model.  So, let's say your location UUID is "d2b063ad-ea9b-43cd-8536-e68aa9d31c66".  Create a JSON body for the /network-device/location resource:

{
"id":"1153fb76-06dd-4c61-9aa6-739e3d4ab80f",
"location":"d2b063ad-ea9b-43cd-8536-e68aa9d31c66"
}

Here, id is the device's UUID and location is the location UUID obtained from GET /location.

[Nathan Sowatskey]

Thank you Joe. I was just being blind, there is a “location” attribute, I just didn’t see it. It is between “type” and “id”.

In my, limited. defence, some of the field names are in bold, and some in grey, so they don’t stand out. As I squint harder, I think that the convention is that the required fields are in bold, and those that are optional are in grey.

Regards

Nathan

[Joe Clarke]

Yeah, the bold/grey is why I say it's a bit confusing.  For the location API, one would expect all I should be able to enter in the model is device ID and location ID.