1. Operations
2. vapi
3. metadata
4. cli
5. namespace

## vapi metadata cli namespace: get

Retreives information about a namespace including information about children of that namespace.

### Request:

#### HTTP request

POST https://{server}/rest/com/vmware/vapi/metadata/cli/namespace?~action=get

#### Request Body Structure:

- JSON
- XML

{
"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>

#### Request Body Parameters:

Name | Type | Description
--- | --- | ---
bold = required
identity | identity | Identifier of the namespace for which to retreive information.
identity.path | string | The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.
identity.name | string | The name displayed to the user for this namespace.

### Response:

#### HTTP Status Code: 200

#### Representations:

- JSON
- XML

{
"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>

#### Response Type:

Name | Type | Description
--- | --- | ---
bold = required
value | info | Information about the namespace including information about child of that namespace.
value.identity | identity | Basic namespace identity.
value.identity.path | string | The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.
value.identity.name | string | The name displayed to the user for this namespace.
value.description | string | The text description displayed to the user in help output.
value.children | identity[] | The children of this namespace in the tree of CLI namespaces.
value.children[].path | string | The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.
value.children[].name | string | The name displayed to the user for this namespace.

#### Errors:

HTTP Status Code | Type | Description
--- | --- | ---
404 | not_found | if a namespace corresponding to `identity` doesn't exist.