This API has a deprecated equivalent from v7.0U1.
Get Metamodel Structure
Retrieves information about the structure element corresponding to structureId. The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.
Request
URLURL
https://{api_host}/api/vapi/metadata/metamodel/structure/{structure_id}
Path Parameters
Path Parameters
string
structure_id
Required
Identifier of the structure element. The parameter must be an identifier for the resource type: com.vmware.vapi.structure.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
MetadataMetamodelStructureInfo
of type application/json
The StructureInfo instance that corresponds to structureId.
{
"constants": {
"key": {
"documentation": "string",
"type": {
"builtin_type": "VOID",
"category": "BUILTIN",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "LIST",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
},
"value": {
"category": "PRIMITIVE",
"list_value": [
{
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "BOOLEAN"
}
],
"primitive_value": {
"boolean_value": false,
"double_value": 0,
"long_value": 0,
"string_value": "string",
"type": "BOOLEAN"
}
}
}
},
"documentation": "string",
"enumerations": {
"key": {
"documentation": "string",
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"name": "string",
"values": [
{
"documentation": "string",
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"value": "string"
}
]
}
},
"fields": [
{
"documentation": "string",
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"name": "string",
"type": {
"builtin_type": "VOID",
"category": "BUILTIN",
"generic_instantiation": {
"element_type": "MetadataMetamodelType Object",
"generic_type": "LIST",
"map_key_type": "MetadataMetamodelType Object",
"map_value_type": "MetadataMetamodelType Object"
},
"user_defined_type": {
"resource_id": "string",
"resource_type": "string"
}
}
}
],
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"name": "string",
"type": "STRUCTURE"
}
constants
Required
Metamodel information of all the constant elements contained in the structure 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 constant element.
string
documentation
Required
English language documentation for a structure element. It can contain HTML markup and Javadoc tags. The first sentence of the structure documentation is a complete sentence that identifies the structure by name and summarizes the purpose of the structure.
enumerations
Required
Metamodel information of all the enumeration elements contained in the structure element. The key in the map 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 map 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 map will be an identifier for the resource type: com.vmware.vapi.enumeration.
array of
MetadataMetamodelFieldInfo
fields
Required
Metamodel information of all the field elements. The order of the field elements in the list matches the order in which the fields are defined in the service.
map of
MetadataMetamodelElementMap
metadata
Required
Generic metadata elements for the structure 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 MetadataIdentifier contains possible string values for keys in the map.
string
name
Required
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.
type
Required
The StructureInfo.Type enumerated type 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.
STRUCTURE : If the type is a structure element.
ERROR : If the type is an error element.
Possible values are: STRUCTURE , ERROR
Errors
404
com.vmware.vapi.std.errors.not_found : if the structure element associated with structureId is not contained in any of the package elements or service elements.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetStructureIdMetamodel -StructureId "MyStructureId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/metamodel/structure/{structure_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/vapi/metadata/metamodel/structure/id:{structure_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
