vapi metadata metamodel package: get
Retrieves information about the package element corresponding to
package_id.
Request:
HTTP request
GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/package/id:{package_id}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| package_id | string | Identifier of the package element. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"structures" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"constants" : [
{
"value" : {
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
},
"value" : {
"list_value" : [
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
}
],
"primitive_value" : {
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
"category" : "PRIMITIVE"
}
},
"key" : "string"
}
],
"type" : "STRUCTURE",
"fields" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
}
]
},
"key" : "obj-103"
}
],
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"services" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"operations" : [
{
"value" : {
"output" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"params" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
}
],
"errors" : [
{
"documentation" : "string",
"structure_id" : "obj-103"
},
{
"documentation" : "string",
"structure_id" : "obj-103"
}
]
},
"key" : "obj-103"
}
],
"documentation" : "string",
"name" : "string",
"structures" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"constants" : [
{
"value" : {
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
},
"value" : {
"list_value" : [
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
}
],
"primitive_value" : {
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
"category" : "PRIMITIVE"
}
},
"key" : "string"
}
],
"type" : "STRUCTURE",
"fields" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
}
]
},
"key" : "obj-103"
}
],
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"constants" : [
{
"value" : {
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
},
"value" : {
"list_value" : [
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
}
],
"primitive_value" : {
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
"category" : "PRIMITIVE"
}
},
"key" : "string"
}
]
},
"key" : "obj-103"
}
]
}
}
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"structures" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"constants" : [
{
"value" : {
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
},
"value" : {
"list_value" : [
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
}
],
"primitive_value" : {
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
"category" : "PRIMITIVE"
}
},
"key" : "string"
}
],
"type" : "STRUCTURE",
"fields" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
}
]
},
"key" : "obj-103"
}
],
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"services" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"operations" : [
{
"value" : {
"output" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"params" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
}
],
"errors" : [
{
"documentation" : "string",
"structure_id" : "obj-103"
},
{
"documentation" : "string",
"structure_id" : "obj-103"
}
]
},
"key" : "obj-103"
}
],
"documentation" : "string",
"name" : "string",
"structures" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"constants" : [
{
"value" : {
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
},
"value" : {
"list_value" : [
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
}
],
"primitive_value" : {
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
"category" : "PRIMITIVE"
}
},
"key" : "string"
}
],
"type" : "STRUCTURE",
"fields" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"name" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
}
}
]
},
"key" : "obj-103"
}
],
"enumerations" : [
{
"value" : {
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"values" : [
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
},
{
"metadata" : [
{
"value" : {
"elements" : [
{
"value" : {
"list_value" : [
"string",
"string"
],
"string_value" : "string",
"structure_id" : "obj-103",
"type" : "LONG",
"structure_ids" : [
"obj-103",
"obj-103"
],
"long_value" : 1
},
"key" : "string"
}
]
},
"key" : "string"
}
],
"documentation" : "string",
"value" : "string"
}
],
"documentation" : "string",
"name" : "string"
},
"key" : "obj-103"
}
],
"constants" : [
{
"value" : {
"documentation" : "string",
"type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST",
"element_type" : {
"builtin_type" : "VOID",
"user_defined_type" : {
"resource_type" : "string",
"resource_id" : "obj-103"
},
"category" : "BUILTIN",
"generic_instantiation" : {
"generic_type" : "LIST"
}
}
}
},
"value" : {
"list_value" : [
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
{
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
}
],
"primitive_value" : {
"string_value" : "string",
"boolean_value" : true,
"type" : "BOOLEAN",
"double_value" : 1.5,
"long_value" : 1
},
"category" : "PRIMITIVE"
}
},
"key" : "string"
}
]
},
"key" : "obj-103"
}
]
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | package_info | The vapi.metadata.metamodel.package_info instance that corresponds to package_id. |
| value.name | string | 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. |
| value.structures | list | Metamodel information of all the structure elements contained in the package element. The key in the key/value pairs is the identifier of the structure element and the value in the key/value pairs 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 structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type:com.vmware.vapi.structure. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vapi.structure.List of {"key": string, "value": structure_info} |
| value.structures[].key | string | |
| value.structures[].value | structure_info | |
| value.structures[].value.name | string | Dot separated name of the structure 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. |
| value.structures[].value.type | string | Type of the structure. Defines the kind of this structure element. In the interface definition language, structure element and error element have similar characteristics. The difference is that only error elements can be used to describe the errors of an operation element. Value is one of: STRUCTURE: If the type is a structure element. ERROR: If the type is an error element. |
| value.structures[].value.enumerations | list | Metamodel information of all the enumeration elements contained in the structure element. The key in the key/value pairs is the identifier of the enumeration element and the value is the metamodel information of the enumeration element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vapi.enumeration. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vapi.enumeration.List of {"key": string, "value": enumeration_info} |
| value.structures[].value.enumerations[].key | string | |
| value.structures[].value.enumerations[].value | enumeration_info | |
| value.structures[].value.enumerations[].value.name | string | Dot separated name of the enumeration 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. |
| value.structures[].value.enumerations[].value.values | enumeration_value_info[] | Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file. |
| value.structures[].value.enumerations[].value.values[].value | string | Value in the enumerated type. All the characters in the string are capitalized. |
| value.structures[].value.enumerations[].value.values[].metadata | list | Additional metadata for enumeration value in the enumerated type. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. List of {"key": string, "value": element_map} |
| value.structures[].value.enumerations[].value.values[].metadata[].key | string | |
| value.structures[].value.enumerations[].value.values[].metadata[].value | element_map | |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements | list | Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. List of {"key": string, "value": element_value} |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].key | string | |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value | element_value | |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.type | string | Type of the value. Defines the valid types for values in metadata elements. Value is one of: LONG: Indicates the type of the value is a long (64 bit signed integer). STRING: Indicates the type of the value is a string (a variable length sequence of characters). The encoding is UTF-8. STRING_LIST: Indicates the type of the value is a list of strings. STRUCTURE_REFERENCE: Indicates the type of the value is an identifier for a structure element. STRUCTURE_REFERENCE_LIST: Indicates the type of the value is a list of identifiers for a structure element. |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.long_value | long | Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of type is LONG. |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.string_value | string | String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of type is STRING. |
| value.structures[].value.enumerations[].value.values[].metadata[].value.elements[].value.list_value | string[] | List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of type is STRING_LIST. |
| value.enumerations | list | Metamodel information of all the enumeration elements contained in the package element. The key in the key/value pairs is the identifier of the enumeration element and the value in the key/value pairs 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 structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type:com.vmware.vapi.enumeration. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vapi.enumeration.List of {"key": string, "value": enumeration_info} |
| value.services | list | Metamodel information of all the service elements contained in the package element. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs is the metamodel information for the service element. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vapi.service.List of {"key": string, "value": service_info} |
| value.metadata | list | Generic metadata elements for the package element. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. List of {"key": string, "value": element_map} |
| value.documentation | string | 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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the package element associated with package_id does not exist. |