REST API - argument

argument_locations

The argument_locations structure describes which part(s) of the input to the operation caused the error.

Some types of errors are caused by the value of one of the inputs to the operation, possibly due to an interaction with other inputs to the operation. This structure is intended to be used as the payload to identify those inputs when the operation reports errors like com.vmware.vapi.std.errors.invalid_argument or com.vmware.vapi.std.errors.not_found. See com.vmware.vapi.std.errors.error.data.

Representations:

JSON
XML

{
    "primary": "string",
    "secondary": [
        "string",
        "string"
    ]
}

<?xml version="1.0" ?>
<ns0:ArgumentLocations xmlns:ns0="http://vmware.com/vapi/std/errors" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <primary>string</primary>
  <secondary-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </secondary-array>
</ns0:ArgumentLocations>

Attributes:

Name	Type	Required	Description
primary *	string	Yes	String describing the location of the input that triggered the error.
secondary *	List<string>	Yes	Array (possibly empty) of strings describing the locations of other inputs that caused the the primary input to trigger the error.