Vapi Metadata Metamodel Structure get
Retrieves information about the structure element corresponding to structureId.
The Vapi Metadata Metamodel 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.
Identifier of the structure element.
The parameter must be an identifier for the resource type: com.vmware.vapi.structure.
The Vapi Metadata Metamodel StructureInfo instance that corresponds to structureId.
{
"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"
}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 of the structure.
For more information see: Vapi Metadata Metamodel StructureInfo Type.
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 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.
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.
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.
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 Vapi Metadata Metamodel MetadataIdentifier contains possible string values for keys in the map.
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.
if the structure element associated with structureId is not contained in any of the package elements or service elements.
"Vapi Std Errors NotFound Object" curl -H 'Authorization: <value>' https://{api_host}/api/vapi/metadata/metamodel/structure/{structureId}