REST API - enumeration_value

vapi metadata metamodel: enumeration value info

The enumeration_value_info structure describes the enumeration value in the enumerated type.

Representation:

JSON
LEGACY JSON

{
    "metadata" : {
        "<string>" : {
            "elements" : {
                "<string>" : {
                    "list_value" : [
                        "string",
                        "string"
                    ],
                    "string_value" : "string",
                    "structure_id" : "obj-103",
                    "type" : "LONG",
                    "structure_ids" : [
                        "obj-103",
                        "obj-103"
                    ],
                    "long_value" : 1
                }
            }
        }
    },
    "documentation" : "string",
    "value" : "string"
}

{
    "metadata" : [
        {
            "value" : {
                "elements" : [
                    {
                        "value" : {
                            "list_value" : [
                                "string",
                                "string"
                            ],
                            "string_value" : "string",
                            "structure_id" : "obj-103",
                            "type" : "LONG",
                            "structure_ids" : [
                                "obj-103",
                                "obj-103"
                            ],
                            "long_value" : 1
                        },
                        "key" : "string"
                    }
                ]
            },
            "key" : "string"
        }
    ],
    "documentation" : "string",
    "value" : "string"
}

Attributes:

Name	Type	Description
Required
-.value	string	Value in the enumerated type. All the characters in the string are capitalized.
-.metadata	object	Additional metadata for enumeration value in the enumerated type. 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. Object with element values of type element_map.
-.metadata.*	element_map
-.metadata.*.elements	object	Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. Object with element values of type element_value.
-.metadata..elements.	element_value
-.metadata..elements..type	string	Type of the value. Defines the valid types for values in metadata elements. Value is one of: LONG: Indicates the type of the value is a long (64 bit signed integer). STRING: Indicates the type of the value is a string (a variable length sequence of characters). The encoding is UTF-8. STRING_LIST: Indicates the type of the value is a list of strings. STRUCTURE_REFERENCE: Indicates the type of the value is an identifier for a structure element. STRUCTURE_REFERENCE_LIST: Indicates the type of the value is a list of identifiers for a structure element.
-.documentation	string	English language documentation for an enumeration value. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first statement will be a noun or verb phrase that describes the purpose of the enumeration value.
Optional
-.metadata..elements..long_value	long	Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of `type` is LONG.
-.metadata..elements..string_value	string	String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of `type` is STRING.
-.metadata..elements..list_value	string[]	List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of `type` is STRING_LIST.

Attributes:

Name	Type	Description
Required
value	string	Value in the enumerated type. All the characters in the string are capitalized.
metadata	list	Additional metadata for enumeration value in the enumerated type. 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}
metadata[].key	string
metadata[].value	element_map
metadata[].value.elements	list	Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. List of {"key": string, "value": element_value}
metadata[].value.elements[].key	string
metadata[].value.elements[].value	element_value
metadata[].value.elements[].value.type	string	Type of the value. Defines the valid types for values in metadata elements. Value is one of: LONG: Indicates the type of the value is a long (64 bit signed integer). STRING: Indicates the type of the value is a string (a variable length sequence of characters). The encoding is UTF-8. STRING_LIST: Indicates the type of the value is a list of strings. STRUCTURE_REFERENCE: Indicates the type of the value is an identifier for a structure element. STRUCTURE_REFERENCE_LIST: Indicates the type of the value is a list of identifiers for a structure element.
documentation	string	English language documentation for an enumeration value. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first statement will be a noun or verb phrase that describes the purpose of the enumeration value.
Optional
metadata[].value.elements[].value.long_value	long	Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of `type` is LONG.
metadata[].value.elements[].value.string_value	string	String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of `type` is STRING.
metadata[].value.elements[].value.list_value	string[]	List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of `type` is STRING_LIST.