Get Metamodel Structure Deprecated
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}/rest/com/vmware/vapi/metadata/metamodel/structure/id:{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
MetadataMetamodelStructureGetResponseBody of type application/json
The StructureInfo instance that corresponds to structureId.
{
"value": {
"constants": [
{
"key": "key1",
"value": {
"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": "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": "LONG"
}
}
]
}
}
],
"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": "LONG"
}
}
]
}
}
],
"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": "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": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
]
}
}
],
"name": "string",
"type": "STRUCTURE"
}
}
value
Optional
The StructureInfo instance that corresponds to structureId.
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
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/vapi/metadata/metamodel/structure/id:{structure_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vapi/metadata/metamodel/structure/{structure_id}
x-vmw-doc-operation: get
