Get Metamodel Package
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Retrieves information about the package element corresponding to packageId.
Request
URLURL
https://{api_host}/rest/com/vmware/vapi/metadata/metamodel/package/id:{package_id}
Parameters
Parameters
string
package_id
Required
Identifier of the package element.
The parameter must be an identifier for the resource type: com.vmware.vapi.package.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
MetadataMetamodelPackageGetResponseBody
of type application/json
The PackageInfo instance that corresponds to packageId.
{
"value": {
"documentation": "string",
"enumerations": [
{
"key": "key1",
"value": {
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"values": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"value": "string"
}
]
}
}
],
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"services": [
{
"key": "key1",
"value": {
"constants": [
{
"key": "key1",
"value": {
"documentation": "string",
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
},
"value": {
"category": "enum",
"list_value": [
{
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "enum"
}
],
"primitive_value": {
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "enum"
}
}
}
}
],
"documentation": "string",
"enumerations": [
{
"key": "key1",
"value": {
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"values": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"value": "string"
}
]
}
}
],
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"operations": [
{
"key": "key1",
"value": {
"documentation": "string",
"errors": [
{
"documentation": "string",
"structure_id": "string"
}
],
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"output": {
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
}
},
"params": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
}
}
]
}
}
],
"structures": [
{
"key": "key1",
"value": {
"constants": [
{
"key": "key1",
"value": {
"documentation": "string",
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
},
"value": {
"category": "enum",
"list_value": [
{
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "enum"
}
],
"primitive_value": {
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "enum"
}
}
}
}
],
"documentation": "string",
"enumerations": [
{
"key": "key1",
"value": {
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"values": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"value": "string"
}
]
}
}
],
"fields": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
}
}
],
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"type": "enum"
}
}
]
}
}
],
"structures": [
{
"key": "key1",
"value": {
"constants": [
{
"key": "key1",
"value": {
"documentation": "string",
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
},
"value": {
"category": "enum",
"list_value": [
{
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "enum"
}
],
"primitive_value": {
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "enum"
}
}
}
}
],
"documentation": "string",
"enumerations": [
{
"key": "key1",
"value": {
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"values": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"value": "string"
}
]
}
}
],
"fields": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"type": {
"builtin_type": "enum",
"category": "enum",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "enum",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
}
}
],
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"type": "enum"
}
}
]
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/vapi/metadata/metamodel/package/id:{package_id}
Errors
404
com.vmware.vapi.std.errors.not_found : if the package element associated with packageId does not exist.
