REST API - output

vapi metadata cli command: output info

The output_info structure describes the names used by the CLI to display the fields of a structure element in the interface definition language as well as the order in which the fields will be displayed.

Representations:

JSON
XML

{
    "output_fields": [
        {
            "display_name": "string",
            "field_name": "string"
        },
        {
            "display_name": "string",
            "field_name": "string"
        }
    ],
    "structure_id": "obj-103"
}

<?xml version="1.0" ?>
<ns0:OutputInfo xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <output_fields-array>
    <array-item>
      <field_name>string</field_name>
      <display_name>string</display_name>
    </array-item>
    <array-item>
      <field_name>string</field_name>
      <display_name>string</display_name>
    </array-item>
  </output_fields-array>
  <structure_id>obj-103</structure_id>
</ns0:OutputInfo>

Attributes:

Name	Type	Description
Required
structure_id	string	Name of the structure. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vapi.structure`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vapi.structure`.
output_fields	output_field_info[]	The order in which the fields of the structure will be displayed by the CLI as well as the names used to display the fields.