Metadata_Metamodel_ComponentData

Metadata_Metamodel_ComponentData
Metadata_Metamodel_ComponentData

The ComponentData structure contains the metamodel metadata information of a component element along with its fingerprint.

JSON Example
{
    "info": {
        "name": "string",
        "packages": {
            "packages": {
                "name": "string",
                "structures": {
                    "structures": {
                        "name": "string",
                        "type": "string",
                        "enumerations": {
                            "enumerations": {
                                "name": "string",
                                "values": [
                                    {
                                        "value": "string",
                                        "metadata": {
                                            "metadata": {
                                                "elements": {
                                                    "elements": {
                                                        "type": "string",
                                                        "long_value": 0,
                                                        "string_value": "string",
                                                        "list_value": [
                                                            "string"
                                                        ],
                                                        "structure_id": "string",
                                                        "structure_ids": [
                                                            "string"
                                                        ]
                                                    }
                                                }
                                            }
                                        },
                                        "documentation": "string"
                                    }
                                ],
                                "metadata": {
                                    "metadata": {
                                        "elements": {
                                            "elements": {
                                                "type": "string",
                                                "long_value": 0,
                                                "string_value": "string",
                                                "list_value": [
                                                    "string"
                                                ],
                                                "structure_id": "string",
                                                "structure_ids": [
                                                    "string"
                                                ]
                                            }
                                        }
                                    }
                                },
                                "documentation": "string"
                            }
                        },
                        "constants": {
                            "constants": {
                                "type": {
                                    "category": "string",
                                    "builtin_type": "string",
                                    "user_defined_type": {
                                        "resource_type": "string",
                                        "resource_id": "string"
                                    },
                                    "generic_instantiation": {
                                        "generic_type": "string",
                                        "element_type": "Metadata_Metamodel_Type Object",
                                        "map_key_type": "Metadata_Metamodel_Type Object",
                                        "map_value_type": "Metadata_Metamodel_Type Object"
                                    }
                                },
                                "value": {
                                    "category": "string",
                                    "primitive_value": {
                                        "type": "string",
                                        "boolean_value": false,
                                        "double_value": "number",
                                        "long_value": 0,
                                        "string_value": "string"
                                    },
                                    "list_value": [
                                        {
                                            "type": "string",
                                            "boolean_value": false,
                                            "double_value": "number",
                                            "long_value": 0,
                                            "string_value": "string"
                                        }
                                    ]
                                },
                                "documentation": "string"
                            }
                        },
                        "fields": [
                            {
                                "name": "string",
                                "type": "Metadata_Metamodel_Type Object",
                                "metadata": {
                                    "metadata": "Metadata_Metamodel_ElementMap Object"
                                },
                                "documentation": "string"
                            }
                        ],
                        "metadata": {
                            "metadata": {
                                "elements": {
                                    "elements": {
                                        "type": "string",
                                        "long_value": 0,
                                        "string_value": "string",
                                        "list_value": [
                                            "string"
                                        ],
                                        "structure_id": "string",
                                        "structure_ids": [
                                            "string"
                                        ]
                                    }
                                }
                            }
                        },
                        "documentation": "string"
                    }
                },
                "enumerations": {
                    "enumerations": {
                        "name": "string",
                        "values": [
                            {
                                "value": "string",
                                "metadata": {
                                    "metadata": {
                                        "elements": {
                                            "elements": {
                                                "type": "string",
                                                "long_value": 0,
                                                "string_value": "string",
                                                "list_value": [
                                                    "string"
                                                ],
                                                "structure_id": "string",
                                                "structure_ids": [
                                                    "string"
                                                ]
                                            }
                                        }
                                    }
                                },
                                "documentation": "string"
                            }
                        ],
                        "metadata": {
                            "metadata": {
                                "elements": {
                                    "elements": {
                                        "type": "string",
                                        "long_value": 0,
                                        "string_value": "string",
                                        "list_value": [
                                            "string"
                                        ],
                                        "structure_id": "string",
                                        "structure_ids": [
                                            "string"
                                        ]
                                    }
                                }
                            }
                        },
                        "documentation": "string"
                    }
                },
                "services": {
                    "services": {
                        "name": "string",
                        "operations": {
                            "operations": {
                                "name": "string",
                                "params": [
                                    "Metadata_Metamodel_FieldInfo Object"
                                ],
                                "output": {
                                    "type": "Metadata_Metamodel_Type Object",
                                    "metadata": {
                                        "metadata": "Metadata_Metamodel_ElementMap Object"
                                    },
                                    "documentation": "string"
                                },
                                "errors": [
                                    {
                                        "structure_id": "string",
                                        "documentation": "string"
                                    }
                                ],
                                "metadata": {
                                    "metadata": "Metadata_Metamodel_ElementMap Object"
                                },
                                "documentation": "string"
                            }
                        },
                        "structures": {
                            "structures": "Metadata_Metamodel_StructureInfo Object"
                        },
                        "enumerations": {
                            "enumerations": "Metadata_Metamodel_EnumerationInfo Object"
                        },
                        "constants": {
                            "constants": "Metadata_Metamodel_ConstantInfo Object"
                        },
                        "metadata": {
                            "metadata": "Metadata_Metamodel_ElementMap Object"
                        },
                        "documentation": "string"
                    }
                },
                "metadata": {
                    "metadata": {
                        "elements": {
                            "elements": {
                                "type": "string",
                                "long_value": 0,
                                "string_value": "string",
                                "list_value": [
                                    "string"
                                ],
                                "structure_id": "string",
                                "structure_ids": [
                                    "string"
                                ]
                            }
                        }
                    }
                },
                "documentation": "string"
            }
        },
        "metadata": {
            "metadata": {
                "elements": {
                    "elements": {
                        "type": "string",
                        "long_value": 0,
                        "string_value": "string",
                        "list_value": [
                            "string"
                        ],
                        "structure_id": "string",
                        "structure_ids": [
                            "string"
                        ]
                    }
                }
            }
        },
        "documentation": "string"
    },
    "fingerprint": "string"
}
info
Required

The ComponentInfo structure contains metamodel metadata information about a component element.

string
fingerprint
Required

Fingerprint of the metamodel metadata of the component component. Metamodel information could change when there is an infrastructure update and new functionality is added to an existing component.

Since the data present in ComponentData.info could be quite large, ComponentData.fingerprint provides a convenient way to check if the data for a particular component is updated.

You should store the fingerprint associated with a component. After an update, by invoking the Component.fingerprint operation, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can use the Component.get to retrieve the new metamodel information for the component.