REST API - ovf

vcenter ovf: ovf error

The ovf_error structure describes an error related to accessing, validating, deploying, or exporting an OVF package.

Representations:

JSON
XML

{
    "category": "VALIDATION",
    "error": {
        "data": {
            "@class": "dynamic_structure"
        },
        "messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ]
    },
    "issues": [
        {
            "category": "VALUE_ILLEGAL",
            "column_number": 1,
            "file": "string",
            "line_number": 1,
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        },
        {
            "category": "VALUE_ILLEGAL",
            "column_number": 1,
            "file": "string",
            "line_number": 1,
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        }
    ],
    "message": {
        "args": [
            "string",
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "name": "string",
    "value": "string"
}

<?xml version="1.0" ?>
<ns0:OvfError xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <message>
    <default_message>string</default_message>
    <id>string</id>
    <args-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </args-array>
  </message>
  <category>VALIDATION</category>
  <error>
    <data class="dynamic_structure">
</data>
    <messages-array>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
    </messages-array>
  </error>
  <issues-array>
    <array-item>
      <message>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </message>
      <category>VALUE_ILLEGAL</category>
      <file>string</file>
      <line_number>1</line_number>
      <column_number>1</column_number>
    </array-item>
    <array-item>
      <message>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </message>
      <category>VALUE_ILLEGAL</category>
      <file>string</file>
      <line_number>1</line_number>
      <column_number>1</column_number>
    </array-item>
  </issues-array>
  <name>string</name>
  <value>string</value>
</ns0:OvfError>

Attributes:

Name	Type	Description
Required
category	string	The message category. Defines the categories of messages (see vcenter.ovf.ovf_message). Value is one of: VALIDATION: The OVF descriptor is invalid, for example, syntax errors or schema errors. INPUT: The user provided input parameters are invalid. SERVER: Server error.
Optional
issues	parse_issue[]	Array of parse issues (see vcenter.ovf.parse_issue). Optional. It is only relevant when category has value VALIDATION. This field is optional and it is only relevant when the value of `category` is VALIDATION.
name	string	The name of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value	string	The value of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
message	localizable_message	A localizable message. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
error	object	Represents a server vapi.std.errors.error. Optional. It is only relevant when category has value SERVER. This field is optional and it is only relevant when the value of `category` is SERVER.When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in vapi.std.errors.error. When operations return a value of this structure as a result, the field will contain all the attributes defined in vapi.std.errors.error.