Vapi Metadata Metamodel Service Operation get

Vapi Metadata Metamodel Service Operation get

Retrieves the metamodel information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

Request
URI
GET
https://{api_host}/api/vapi/metadata/metamodel/service/{serviceId}/operation/{operationId}
COPY
Path Parameters
string
serviceId
Required

Identifier of the service element.

The parameter must be an identifier for the resource type: com.vmware.vapi.service.

string
operationId
Required

Identifier of the operation element.

The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Metamodel OperationInfo instance that corresponds to operationId defined in scope serviceId.

Returns Vapi Metadata Metamodel OperationInfo of type(s) application/json 
{
    "name": "string",
    "params": [
        {
            "name": "string",
            "type": {
                "category": "string",
                "builtin_type": "string",
                "user_defined_type": {
                    "resource_type": "string",
                    "resource_id": "string"
                },
                "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
            },
            "metadata": {
                "metadata": {
                    "elements": {
                        "elements": {
                            "type": "string",
                            "long_value": 0,
                            "string_value": "string",
                            "list_value": [
                                "string"
                            ],
                            "structure_id": "string",
                            "structure_ids": [
                                "string"
                            ]
                        }
                    }
                }
            },
            "documentation": "string"
        }
    ],
    "output": {
        "type": {
            "category": "string",
            "builtin_type": "string",
            "user_defined_type": {
                "resource_type": "string",
                "resource_id": "string"
            },
            "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
        },
        "metadata": {
            "metadata": {
                "elements": {
                    "elements": {
                        "type": "string",
                        "long_value": 0,
                        "string_value": "string",
                        "list_value": [
                            "string"
                        ],
                        "structure_id": "string",
                        "structure_ids": [
                            "string"
                        ]
                    }
                }
            }
        },
        "documentation": "string"
    },
    "errors": [
        {
            "structure_id": "string",
            "documentation": "string"
        }
    ],
    "metadata": {
        "metadata": {
            "elements": {
                "elements": {
                    "type": "string",
                    "long_value": 0,
                    "string_value": "string",
                    "list_value": [
                        "string"
                    ],
                    "structure_id": "string",
                    "structure_ids": [
                        "string"
                    ]
                }
            }
        }
    },
    "documentation": "string"
}
string
name
Required

Name of the operation element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

array of object
params
Required

Metamodel information for the parameter elements. The order of the parameters elements in the list is same as the order of the parameters declared in the interface definition file.

output
Required

Metamodel type for the output element.

array of object
errors
Required

List of error elements that might be reported by the operation element. If the operation reports the same error for more than one reason, the list contains the error element associated with the error more than once with different documentation elements.

object
metadata
Required

Generic metadata elements for the operation element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.

The Vapi Metadata Metamodel MetadataIdentifier contains possible string values for key in the map.

string
documentation
Required

English language documentation for the operation element. It can contain HTML markup and Javadoc tags.


404

if the service element associated with serviceId does not exist in any of the package elements.

if the operation element associated with operationId does not exist in the service element.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vapi/metadata/metamodel/service/{serviceId}/operation/{operationId}
On This Page
Vapi Operations
GET
Vapi Metadata Metamodel Service Operation list
GET
Vapi Metadata Metamodel Service Operation get