vapi metadata metamodel: operation result info
The
operation_result_info structure contains the metamodel information of an operation result element. An operation accepts a list of parameters and returns a result or an error. The operation_result_info describes the result element of an operation.
Representation:
{
"documentation": "string",
"metadata": [
{
"key": "string",
"value": {
"elements": [
{
"key": "string",
"value": {
"list_value": [
"string",
"string"
],
"long_value": 1,
"string_value": "string",
"structure_id": "obj-103",
"structure_ids": [
"obj-103",
"obj-103"
],
"type": "LONG"
}
}
]
}
}
],
"type": {
"builtin_type": "VOID",
"category": "BUILTIN",
"generic_instantiation": {
"element_type": {
"builtin_type": "VOID",
"category": "BUILTIN",
"generic_instantiation": {
"generic_type": "LIST"
},
"user_defined_type": {
"resource_id": "obj-103",
"resource_type": "string"
}
},
"generic_type": "LIST"
},
"user_defined_type": {
"resource_id": "obj-103",
"resource_type": "string"
}
}
}
"documentation": "string",
"metadata": [
{
"key": "string",
"value": {
"elements": [
{
"key": "string",
"value": {
"list_value": [
"string",
"string"
],
"long_value": 1,
"string_value": "string",
"structure_id": "obj-103",
"structure_ids": [
"obj-103",
"obj-103"
],
"type": "LONG"
}
}
]
}
}
],
"type": {
"builtin_type": "VOID",
"category": "BUILTIN",
"generic_instantiation": {
"element_type": {
"builtin_type": "VOID",
"category": "BUILTIN",
"generic_instantiation": {
"generic_type": "LIST"
},
"user_defined_type": {
"resource_id": "obj-103",
"resource_type": "string"
}
},
"generic_type": "LIST"
},
"user_defined_type": {
"resource_id": "obj-103",
"resource_type": "string"
}
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| type | type | Type information of the operation result element. |
| metadata | list | Generic metadata elements for the service element. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. List of {"key": string, "value": element_map} |
| documentation | string | English language documentation for the operation result element. It can contain HTML markup and Javadoc tags. |