This API has a deprecated equivalent from v7.0U1.
Get Metamodel Service Operation
Retrieves the metamodel information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
Request
URLURL
https://{api_host}/api/vapi/metadata/metamodel/service/{service_id}/operation/{operation_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.
string
operation_id
Required
Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.
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
MetadataMetamodelOperationInfo
of type application/json
The OperationInfo instance that corresponds to operationId defined in scope serviceId.
{
"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"
}
}
}
]
}
string
documentation
Required
English language documentation for the operation element. It can contain HTML markup and Javadoc tags.
array of
MetadataMetamodelErrorInfo
errors
Required
List of error elements that might be reported by the operation element. If the operation reports the same error for more than one reason, the list contains the error element associated with the error more than once with different documentation elements.
map of
MetadataMetamodelElementMap
metadata
Required
Generic metadata elements for the operation 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 key in the map.
string
name
Required
Name of the operation element in a canonical format. The format 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.
array of
MetadataMetamodelFieldInfo
params
Required
Metamodel information for the parameter elements. The order of the parameters elements in the list is same as the order of the parameters declared in the interface definition file.
Errors
404
com.vmware.vapi.std.errors.not_found : if the service element associated with serviceId does not exist in any of the package elements. if the operation element associated with operationId does not exist in the service element.
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-GetServiceIdOperationIdMetamodel -ServiceId "MyServiceId" -OperationId "MyOperationId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/metamodel/service/{service_id}/operation/{operation_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/service/operation/id:{service_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
