Vapi Metadata Metamodel Service get

Vapi Metadata Metamodel Service get

Retrieves information about the service element corresponding to serviceId.

The Vapi Metadata Metamodel ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.

Request
URI
GET
https://{api_host}/api/vapi/metadata/metamodel/service/{serviceId}
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.


Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Metamodel ServiceInfo instance that corresponds to serviceId

Returns Vapi Metadata Metamodel ServiceInfo of type(s) application/json
{
    "name": "string",
    "operations": {
        "operations": {
            "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"
        }
    },
    "structures": {
        "structures": {
            "name": "string",
            "type": "string",
            "enumerations": {
                "enumerations": {
                    "name": "string",
                    "values": [
                        {
                            "value": "string",
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "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"
                }
            },
            "constants": {
                "constants": {
                    "type": {
                        "category": "string",
                        "builtin_type": "string",
                        "user_defined_type": {
                            "resource_type": "string",
                            "resource_id": "string"
                        },
                        "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                    },
                    "value": {
                        "category": "string",
                        "primitive_value": {
                            "type": "string",
                            "boolean_value": false,
                            "double_value": "number",
                            "long_value": 0,
                            "string_value": "string"
                        },
                        "list_value": [
                            {
                                "type": "string",
                                "boolean_value": false,
                                "double_value": "number",
                                "long_value": 0,
                                "string_value": "string"
                            }
                        ]
                    },
                    "documentation": "string"
                }
            },
            "fields": [
                {
                    "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"
                }
            ],
            "metadata": {
                "metadata": {
                    "elements": {
                        "elements": {
                            "type": "string",
                            "long_value": 0,
                            "string_value": "string",
                            "list_value": [
                                "string"
                            ],
                            "structure_id": "string",
                            "structure_ids": [
                                "string"
                            ]
                        }
                    }
                }
            },
            "documentation": "string"
        }
    },
    "enumerations": {
        "enumerations": {
            "name": "string",
            "values": [
                {
                    "value": "string",
                    "metadata": {
                        "metadata": {
                            "elements": {
                                "elements": {
                                    "type": "string",
                                    "long_value": 0,
                                    "string_value": "string",
                                    "list_value": [
                                        "string"
                                    ],
                                    "structure_id": "string",
                                    "structure_ids": [
                                        "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"
        }
    },
    "constants": {
        "constants": {
            "type": {
                "category": "string",
                "builtin_type": "string",
                "user_defined_type": {
                    "resource_type": "string",
                    "resource_id": "string"
                },
                "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
            },
            "value": {
                "category": "string",
                "primitive_value": {
                    "type": "string",
                    "boolean_value": false,
                    "double_value": "number",
                    "long_value": 0,
                    "string_value": "string"
                },
                "list_value": [
                    {
                        "type": "string",
                        "boolean_value": false,
                        "double_value": "number",
                        "long_value": 0,
                        "string_value": "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

Dot separated name of the service element. The segments in the name reflect the organization of the APIs. The format of each segment 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.

object
operations
Required

Metamodel information of all the operation elements contained in the service element. The key in the map is the identifier of the operation element and the value in the map is the metamodel information for the operation element.

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

object
structures
Required

Metamodel information of all the structure elements contained in the service element. The key in the map is the identifier of the structure element and the value in the map is the metamodel information for the structure element.

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

object
enumerations
Required

Metamodel information of all the enumeration elements contained in the service element. The key in the map is the identifier of the enumeration element and the value in the map is the metamodel information for the enumeration element.

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

object
constants
Required

Metamodel information of all the constant elements contained in the service element. The key in the map is the name of the constant element and the value in the map is the metamodel information for the contant element.

object
metadata
Required

Generic metadata elements for the service 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 keys in the map.

string
documentation
Required

English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service.


404

if the service element associated with serviceId is not registered with the infrastructure.

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}