Get Metamodel Service
Retrieves information about the service element corresponding to serviceId. The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.
Request
URLURL
https://{api_host}/api/vapi/metadata/metamodel/service/{service_id}
Path Parameters
Path Parameters
string
service_id
Required
Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.
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
MetadataMetamodelServiceInfo of type application/json
The ServiceInfo instance that corresponds to serviceId
{
"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"
}
]
}
},
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"name": "string",
"operations": {
"key": {
"documentation": "string",
"errors": [
{
"documentation": "string",
"structure_id": "string"
}
],
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"name": "string",
"output": {
"documentation": "string",
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"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"
}
}
},
"params": [
{
"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"
}
}
}
]
}
},
"structures": {
"key": {
"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 service 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 contant element.
string
documentation
Required
English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service.
enumerations
Required
Metamodel information of all the enumeration elements contained in the service element. The key in the map is the identifier of the enumeration element and the value in the map is the metamodel information for 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.
map of
MetadataMetamodelElementMap
metadata
Required
Generic metadata elements for the service 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 service 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.
operations
Required
Metamodel information of all the operation elements contained in the service element. The key in the map is the identifier of the operation element and the value in the map is the metamodel information for the operation 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.operation. 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.operation.
structures
Required
Metamodel information of all the structure elements contained in the service element. The key in the map is the identifier of the structure element and the value in the map is the metamodel information for the structure 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.structure. 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.structure.
Errors
404
com.vmware.vapi.std.errors.not_found : if the service element associated with serviceId is not registered with the infrastructure.
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-GetServiceIdMetamodel -ServiceId "MyServiceId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/metamodel/service/{service_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
