REST API - list

REST API - list

com.vmware.vapi.metadata.cli.command

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

list

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

Returns the identifiers of all commands, or commands in a specific namespace.
Request:
Representations:
{
    "path": "string"
}
<?xml version="1.0" ?>
<ns0:List-Input xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <path>string</path>
</ns0:List-Input>
GET /com/vmware/vapi/metadata/cli/command
?path=string

Parameters:
Name Type Required Description
path string No The dot-separated path of the namespace for which command identifiers should be returned.

Response:
Representations:
{
    "value": [
        {
            "name": "string",
            "path": "string"
        },
        {
            "name": "string",
            "path": "string"
        }
    ]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <name>string</name>
      <path>string</path>
    </array-item>
    <array-item>
      <name>string</name>
      <path>string</path>
    </array-item>
  </value-array>
</ns0:List-Result>

Parameters:
Name Type Required Description
result List<identity> Yes Identifiers of the requested commands.

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

Copyright © 2014. All Rights Reserved.