1. Types
  2. vapi
  3. metadata
  4. metamodel

vapi metadata metamodel: field info

The field_info structure contains metamodel information of a field element contained in a structure element.

Representations:

{
    "documentation": "string",
    "metadata": [
        {
            "key": "string",
            "value": {
                "elements": [
                    {
                        "key": "string",
                        "value": {
                            "list_value": [
                                "string",
                                "string"
                            ],
                            "long_value": 1,
                            "string_value": "string",
                            "structure_id": "obj-103",
                            "structure_ids": [
                                "obj-103",
                                "obj-103"
                            ],
                            "type": "LONG"
                        }
                    }
                ]
            }
        }
    ],
    "name": "string",
    "type": {
        "builtin_type": "VOID",
        "category": "BUILTIN",
        "generic_instantiation": {
            "element_type": {
                "builtin_type": "VOID",
                "category": "BUILTIN",
                "generic_instantiation": {
                    "generic_type": "LIST"
                },
                "user_defined_type": {
                    "resource_id": "obj-103",
                    "resource_type": "string"
                }
            },
            "generic_type": "LIST"
        },
        "user_defined_type": {
            "resource_id": "obj-103",
            "resource_type": "string"
        }
    }
}
<?xml version="1.0" ?>
<ns0:FieldInfo xmlns:ns0="http://vmware.com/vapi/metadata/metamodel" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <name>string</name>
  <documentation>string</documentation>
  <type>
    <user_defined_type>
      <resource_id>obj-103</resource_id>
      <resource_type>string</resource_type>
    </user_defined_type>
    <category>BUILTIN</category>
    <generic_instantiation>
      <generic_type>LIST</generic_type>
      <element_type>
        <user_defined_type>
          <resource_id>obj-103</resource_id>
          <resource_type>string</resource_type>
        </user_defined_type>
        <category>BUILTIN</category>
        <generic_instantiation>
          <generic_type>LIST</generic_type>
        </generic_instantiation>
        <builtin_type>VOID</builtin_type>
      </element_type>
    </generic_instantiation>
    <builtin_type>VOID</builtin_type>
  </type>
  <metadata-array>
    <array-item>
      <value>
        <elements-array>
          <array-item>
            <value>
              <long_value>1</long_value>
              <list_value-array>
                <array-item>string</array-item>
                <array-item>string</array-item>
              </list_value-array>
              <structure_id>obj-103</structure_id>
              <structure_ids-array>
                <array-item>obj-103</array-item>
                <array-item>obj-103</array-item>
              </structure_ids-array>
              <string_value>string</string_value>
              <type>LONG</type>
            </value>
            <key>string</key>
          </array-item>
        </elements-array>
      </value>
      <key>string</key>
    </array-item>
  </metadata-array>
</ns0:FieldInfo>

Attributes:

Name Type Description
Required
name string Name of the field element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.
type type Type information.
metadata list Generic metadata elements for the field element. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element.

The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs.

List of {"key": string, "value": element_map}
documentation string English language documentation for the service element. It can contain HTML markup and Javadoc tags.