REST API - get

REST API - get

com.vmware.vapi.metadata.cli.namespace

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

get

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

Retreives information about a namespace including information about children of that namespace.
Request:
Representations:
{
    "identity": {
        "name": "string",
        "path": "string"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/cli/namespace" 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/namespace?~action=get
&identity.name=string
&identity.path=string

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

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

Parameters:
Name Type Required Description
result info Yes Information about the namespace including information about child of that namespace.

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

Copyright © 2014. All Rights Reserved.