Vapi Metadata Cli Command get

Vapi Metadata Cli Command get

Retrieves information about a command including information about how to execute that command.

Request
URI
POST
https://{host}/api/vapi/metadata/cli/command?action=get
COPY
Request Body

Request body for invoking operation: get

{
    "identity": {
        "path": "string",
        "name": "string"
    }
}
Vapi Metadata Cli Command Identity
identity
Required

The Vapi Metadata Cli Command Identity schema uniquely identifies a command in the CLI commands tree.

Authorization
This operation uses the following authorization methods.
Responses
200

Information about the command including information about how to execute that command.

Returns Vapi Metadata Cli Command Info of type(s) application/json 
{
    "identity": {
        "path": "string",
        "name": "string"
    },
    "description": "string",
    "service_id": "string",
    "operation_id": "string",
    "options": [
        {
            "long_option": "string",
            "short_option": "string",
            "field_name": "string",
            "description": "string",
            "type": "string",
            "generic": "string"
        }
    ],
    "formatter": "string",
    "output_field_list": [
        {
            "structure_id": "string",
            "output_fields": [
                {
                    "field_name": "string",
                    "display_name": "string"
                }
            ]
        }
    ]
}
identity
Required

Basic command identity.

string
description
Required

The text description displayed to the user in help output.

string
service_id
Required

The service identifier that contains the operations for this CLI command.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.service.

string
operation_id
Required

The operation identifier corresponding to this CLI command.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.operation.

array of object
options
Required

The input for this command.

string
formatter
Optional

The formatter to use when displaying the output of this command.

For more information see: Vapi Metadata Cli Command FormatterType.

If not present, client can choose a default output formatter.

array of object
output_field_list
Required

List of output structure name and output field info.


404

if a command corresponding to identity doesn't exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"identity:"object"}' https://{api_host}/api/vapi/metadata/cli/command?action=get
On This Page
Vapi Operations
GET
Vapi Metadata Cli Command list
POST
Vapi Metadata Cli Command get
GET
Vapi Metadata Cli Command fingerprint