Vapi Metadata Metamodel Package get

Vapi Metadata Metamodel Package get

Retrieves information about the package element corresponding to packageId.

Request
URI
GET
https://{api_host}/api/vapi/metadata/metamodel/package/{packageId}
COPY
Path Parameters
string
packageId
Required

Identifier of the package element.

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


Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Metamodel PackageInfo instance that corresponds to packageId.

Returns Vapi Metadata Metamodel PackageInfo of type(s) application/json
{
    "name": "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"
        }
    },
    "services": {
        "services": {
            "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"
        }
    },
    "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 package 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
structures
Required

Metamodel information of all the structure elements contained in the package 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.

This does not include the structure elements contained in the service elements that are contained in this package 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 package 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.

This does not include the enumeration elements that are contained in the service elements of this package element or structure elements of this package 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
services
Required

Metamodel information of all the service elements contained in the package element. The key in the map is the identifier of the service element and the value in the map is the metamodel information for the service 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.service. 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.service.

object
metadata
Required

Generic metadata elements for the package 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 a package. It can contain HTML markup and Javadoc tags. The first sentence of the package documentation is a complete sentence that identifies the package by name and summarizes the purpose of the package.

The primary purpose of a package documentation is to provide high-level context that will provide a framework in which the users can put the detail about the package contents.


404

if the package element associated with packageId does not exist.

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/package/{packageId}