REST API - get

REST API - get

com.vmware.vapi.metadata.cli.command

The command service provides operations to get information about command line interface (CLI) commands.

get

POST /com/vmware/vapi/metadata/cli/command?~action=get

Retrieves information about a command including information about how to execute that command.
Request:
Representations:
{
    "identity": {
        "name": "string",
        "path": "string"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <identity>
    <name>string</name>
    <path>string</path>
  </identity>
</ns0:Get-Input>
POST /com/vmware/vapi/metadata/cli/command?~action=get
&identity.name=string
&identity.path=string

Parameters:
Name Type Required Description
identity
 *
 identity Yes Identifier of the command for which to retreive information.

Response:
Representations:
{
    "value": {
        "description": "string",
        "formatter": "SIMPLE",
        "identity": {
            "name": "string",
            "path": "string"
        },
        "operation_id": "obj-103",
        "options": [
            {
                "description": "string",
                "field_name": "string",
                "generic": "NONE",
                "long_option": "string",
                "short_option": "string",
                "type": "string"
            },
            {
                "description": "string",
                "field_name": "string",
                "generic": "NONE",
                "long_option": "string",
                "short_option": "string",
                "type": "string"
            }
        ],
        "output_field_list": [
            {
                "output_fields": [
                    {
                        "display_name": "string",
                        "field_name": "string"
                    },
                    {
                        "display_name": "string",
                        "field_name": "string"
                    }
                ],
                "structure_id": "obj-103"
            },
            {
                "output_fields": [
                    {
                        "display_name": "string",
                        "field_name": "string"
                    },
                    {
                        "display_name": "string",
                        "field_name": "string"
                    }
                ],
                "structure_id": "obj-103"
            }
        ],
        "service_id": "obj-103"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <formatter>SIMPLE</formatter>
    <service_id>obj-103</service_id>
    <operation_id>obj-103</operation_id>
    <identity>
      <name>string</name>
      <path>string</path>
    </identity>
    <output_field_list-array>
      <array-item>
        <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>
      </array-item>
      <array-item>
        <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>
      </array-item>
    </output_field_list-array>
    <description>string</description>
    <options-array>
      <array-item>
        <generic>NONE</generic>
        <field_name>string</field_name>
        <description>string</description>
        <type>string</type>
        <long_option>string</long_option>
        <short_option>string</short_option>
      </array-item>
      <array-item>
        <generic>NONE</generic>
        <field_name>string</field_name>
        <description>string</description>
        <type>string</type>
        <long_option>string</long_option>
        <short_option>string</short_option>
      </array-item>
    </options-array>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result info Yes Information about the command including information about how to execute that command.

Errors:
Type Description HTTP Status Code
not_found if a command corresponding to identity doesn't exist. 404

Copyright © 2014. All Rights Reserved.